Skip to content

Commit

Permalink
macros: accept IntoFuture args for macros (#6710)
Browse files Browse the repository at this point in the history
  • Loading branch information
Darksonn authored Jul 23, 2024
1 parent 6a1a7b1 commit dd1d371
Show file tree
Hide file tree
Showing 5 changed files with 39 additions and 5 deletions.
8 changes: 5 additions & 3 deletions tokio/src/future/maybe_done.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Definition of the [`MaybeDone`] combinator.

use pin_project_lite::pin_project;
use std::future::Future;
use std::future::{Future, IntoFuture};
use std::pin::Pin;
use std::task::{Context, Poll};

Expand All @@ -22,8 +22,10 @@ pin_project! {
}

/// Wraps a future into a `MaybeDone`.
pub fn maybe_done<Fut: Future>(future: Fut) -> MaybeDone<Fut> {
MaybeDone::Future { future }
pub fn maybe_done<F: IntoFuture>(future: F) -> MaybeDone<F::IntoFuture> {
MaybeDone::Future {
future: future.into_future(),
}
}

impl<Fut: Future> MaybeDone<Fut> {
Expand Down
2 changes: 1 addition & 1 deletion tokio/src/macros/select.rs
Original file line number Diff line number Diff line change
Expand Up @@ -495,7 +495,7 @@ doc! {macro_rules! select {
// We can't use the `pin!` macro for this because `futures` is a
// tuple and the standard library provides no way to pin-project to
// the fields of a tuple.
let mut futures = ( $( $fut , )+ );
let mut futures = ( $( $crate::macros::support::IntoFuture::into_future($fut) , )+ );

// This assignment makes sure that the `poll_fn` closure only has a
// reference to the futures, instead of taking ownership of them.
Expand Down
2 changes: 1 addition & 1 deletion tokio/src/macros/support.rs
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ cfg_macros! {
}
}

pub use std::future::Future;
pub use std::future::{Future, IntoFuture};
pub use std::pin::Pin;
pub use std::task::Poll;
15 changes: 15 additions & 0 deletions tokio/tests/macros_join.rs
Original file line number Diff line number Diff line change
Expand Up @@ -159,3 +159,18 @@ async fn a_different_future_is_polled_first_every_time_poll_fn_is_polled() {
async fn empty_join() {
assert_eq!(tokio::join!(), ());
}

#[tokio::test]
async fn join_into_future() {
struct NotAFuture;
impl std::future::IntoFuture for NotAFuture {
type Output = ();
type IntoFuture = std::future::Ready<()>;

fn into_future(self) -> Self::IntoFuture {
std::future::ready(())
}
}

tokio::join!(NotAFuture);
}
17 changes: 17 additions & 0 deletions tokio/tests/macros_select.rs
Original file line number Diff line number Diff line change
Expand Up @@ -692,3 +692,20 @@ mod unstable {
)
}
}

#[tokio::test]
async fn select_into_future() {
struct NotAFuture;
impl std::future::IntoFuture for NotAFuture {
type Output = ();
type IntoFuture = std::future::Ready<()>;

fn into_future(self) -> Self::IntoFuture {
std::future::ready(())
}
}

tokio::select! {
() = NotAFuture => {},
}
}

0 comments on commit dd1d371

Please sign in to comment.