aboutsummaryrefslogtreecommitdiff
path: root/embassy-futures
diff options
context:
space:
mode:
Diffstat (limited to 'embassy-futures')
-rw-r--r--embassy-futures/src/join.rs10
-rw-r--r--embassy-futures/src/lib.rs7
-rw-r--r--embassy-futures/src/select.rs2
3 files changed, 11 insertions, 8 deletions
diff --git a/embassy-futures/src/join.rs b/embassy-futures/src/join.rs
index 39a78ccd3..7600d4b8a 100644
--- a/embassy-futures/src/join.rs
+++ b/embassy-futures/src/join.rs
@@ -1,3 +1,5 @@
1//! Wait for multiple futures to complete.
2
1use core::future::Future; 3use core::future::Future;
2use core::pin::Pin; 4use core::pin::Pin;
3use core::task::{Context, Poll}; 5use core::task::{Context, Poll};
@@ -131,7 +133,7 @@ generate! {
131/// 133///
132/// let a = async { 1 }; 134/// let a = async { 1 };
133/// let b = async { 2 }; 135/// let b = async { 2 };
134/// let pair = embassy_futures::join(a, b).await; 136/// let pair = embassy_futures::join::join(a, b).await;
135/// 137///
136/// assert_eq!(pair, (1, 2)); 138/// assert_eq!(pair, (1, 2));
137/// # }); 139/// # });
@@ -160,7 +162,7 @@ where
160/// let a = async { 1 }; 162/// let a = async { 1 };
161/// let b = async { 2 }; 163/// let b = async { 2 };
162/// let c = async { 3 }; 164/// let c = async { 3 };
163/// let res = embassy_futures::join3(a, b, c).await; 165/// let res = embassy_futures::join::join3(a, b, c).await;
164/// 166///
165/// assert_eq!(res, (1, 2, 3)); 167/// assert_eq!(res, (1, 2, 3));
166/// # }); 168/// # });
@@ -191,7 +193,7 @@ where
191/// let b = async { 2 }; 193/// let b = async { 2 };
192/// let c = async { 3 }; 194/// let c = async { 3 };
193/// let d = async { 4 }; 195/// let d = async { 4 };
194/// let res = embassy_futures::join4(a, b, c, d).await; 196/// let res = embassy_futures::join::join4(a, b, c, d).await;
195/// 197///
196/// assert_eq!(res, (1, 2, 3, 4)); 198/// assert_eq!(res, (1, 2, 3, 4));
197/// # }); 199/// # });
@@ -229,7 +231,7 @@ where
229/// let c = async { 3 }; 231/// let c = async { 3 };
230/// let d = async { 4 }; 232/// let d = async { 4 };
231/// let e = async { 5 }; 233/// let e = async { 5 };
232/// let res = embassy_futures::join5(a, b, c, d, e).await; 234/// let res = embassy_futures::join::join5(a, b, c, d, e).await;
233/// 235///
234/// assert_eq!(res, (1, 2, 3, 4, 5)); 236/// assert_eq!(res, (1, 2, 3, 4, 5));
235/// # }); 237/// # });
diff --git a/embassy-futures/src/lib.rs b/embassy-futures/src/lib.rs
index ea135b3ab..8c769bdfc 100644
--- a/embassy-futures/src/lib.rs
+++ b/embassy-futures/src/lib.rs
@@ -6,11 +6,10 @@
6pub(crate) mod fmt; 6pub(crate) mod fmt;
7 7
8mod block_on; 8mod block_on;
9mod join;
10mod select;
11mod yield_now; 9mod yield_now;
12 10
11pub mod join;
12pub mod select;
13
13pub use block_on::*; 14pub use block_on::*;
14pub use join::*;
15pub use select::*;
16pub use yield_now::*; 15pub use yield_now::*;
diff --git a/embassy-futures/src/select.rs b/embassy-futures/src/select.rs
index c0dd7ecd3..97a81a86d 100644
--- a/embassy-futures/src/select.rs
+++ b/embassy-futures/src/select.rs
@@ -1,3 +1,5 @@
1//! Wait for the first of several futures to complete.
2
1use core::future::Future; 3use core::future::Future;
2use core::pin::Pin; 4use core::pin::Pin;
3use core::task::{Context, Poll}; 5use core::task::{Context, Poll};