Skip to content

Commit

Permalink
macros: add assignment form to pin! (#2274)
Browse files Browse the repository at this point in the history
Allows combining assignment to a binding and pinning it.
  • Loading branch information
carllerche authored Feb 26, 2020
1 parent 10f1507 commit 1dadc70
Show file tree
Hide file tree
Showing 2 changed files with 48 additions and 1 deletion.
34 changes: 33 additions & 1 deletion tokio/src/macros/pin.rs
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,30 @@
/// }
/// }
/// ```
///
/// Because assigning to a variable followed by pinning is common, there is also
/// a variant of the macro that supports doing both in one go.
///
/// ```
/// use tokio::{pin, select};
///
/// async fn my_async_fn() {
/// // async logic here
/// }
///
/// #[tokio::main]
/// async fn main() {
/// pin! {
/// let future1 = my_async_fn();
/// let future2 = my_async_fn();
/// }
///
/// select! {
/// _ = &mut future1 => {}
/// _ = &mut future2 => {}
/// }
/// }
/// ```
#[macro_export]
macro_rules! pin {
($($x:ident),*) => { $(
Expand All @@ -108,5 +132,13 @@ macro_rules! pin {
let mut $x = unsafe {
$crate::macros::support::Pin::new_unchecked(&mut $x)
};
)* }
)* };
($(
let $x:ident = $init:expr;
)*) => {
$(
let $x = $init;
crate::pin!($x);
)*
};
}
15 changes: 15 additions & 0 deletions tokio/tests/macros_pin.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
use tokio::pin;

async fn one() {}
async fn two() {}

#[tokio::test]
async fn multi_pin() {
pin! {
let f1 = one();
let f2 = two();
}

(&mut f1).await;
(&mut f2).await;
}

0 comments on commit 1dadc70

Please sign in to comment.