Skip to content

Commit 50f3f71

Browse files
committed
Document feature gate for async-await features
1 parent 3872328 commit 50f3f71

File tree

4 files changed

+10
-0
lines changed

4 files changed

+10
-0
lines changed

futures-util/src/async_await/join.rs

+4
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,8 @@
77
/// `join!` polls both futures concurrently and therefore is more efficent.
88
///
99
/// This macro is only usable inside of async functions, closures, and blocks.
10+
/// It is also gated behind the `async-await` feature of this library, which is
11+
/// _not_ activated by default.
1012
///
1113
/// # Examples
1214
///
@@ -53,6 +55,8 @@ macro_rules! join {
5355
/// the futures return an error.
5456
///
5557
/// This macro is only usable inside of async functions, closures, and blocks.
58+
/// It is also gated behind the `async-await` feature of this library, which is
59+
/// _not_ activated by default.
5660
///
5761
/// # Examples
5862
///

futures-util/src/async_await/pending.rs

+2
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ use futures_core::task::{Context, Poll};
1010
/// is called somewhere when further progress can be made.
1111
///
1212
/// This macro is only usable inside of async functions, closures, and blocks.
13+
/// It is also gated behind the `async-await` feature of this library, which is
14+
/// _not_ activated by default.
1315
#[macro_export]
1416
macro_rules! pending {
1517
() => {

futures-util/src/async_await/poll.rs

+2
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ use futures_core::task::{Context, Poll};
66
/// current `async` context.
77
///
88
/// This macro is only usable inside of `async` functions, closures, and blocks.
9+
/// It is also gated behind the `async-await` feature of this library, which is
10+
/// _not_ activated by default.
911
#[macro_export]
1012
macro_rules! poll {
1113
($x:expr) => {

futures-util/src/async_await/select_mod.rs

+2
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ macro_rules! document_select_macro {
2020
/// branch has to have the same return type.
2121
///
2222
/// This macro is only usable inside of async functions, closures, and blocks.
23+
/// It is also gated behind the `async-await` feature of this library, which is
24+
/// _not_ activated by default.
2325
///
2426
/// # Examples
2527
///

0 commit comments

Comments
 (0)