Skip to content

Added Future::flatten #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Nov 7, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 52 additions & 0 deletions src/future/future/flatten.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
use futures_core::ready;
use std::pin::Pin;

use crate::future::Future;
use crate::future::IntoFuture;
use crate::task::{Context, Poll};

#[derive(Debug)]
pub struct FlattenFuture<Fut1, Fut2> {
state: State<Fut1, Fut2>,
}

#[derive(Debug)]
enum State<Fut1, Fut2> {
First(Fut1),
Second(Fut2),
Empty,
}

impl<Fut1, Fut2> FlattenFuture<Fut1, Fut2> {
pub fn new(future: Fut1) -> FlattenFuture<Fut1, Fut2> {
FlattenFuture {
state: State::First(future),
}
}
}

impl<Fut1> Future for FlattenFuture<Fut1, <Fut1::Output as IntoFuture>::Future>
where
Fut1: Future,
Fut1::Output: IntoFuture,
{
type Output = <Fut1::Output as IntoFuture>::Output;

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
let Self { state } = unsafe { self.get_unchecked_mut() };
loop {
match state {
State::First(fut1) => {
let fut2 = ready!(unsafe { Pin::new_unchecked(fut1) }.poll(cx)).into_future();
*state = State::Second(fut2);
}
State::Second(fut2) => {
let v = ready!(unsafe { Pin::new_unchecked(fut2) }.poll(cx));
*state = State::Empty;
return Poll::Ready(v);
}
State::Empty => panic!("polled a completed future"),
}
}
}
}
27 changes: 27 additions & 0 deletions src/future/future/mod.rs
Original file line number Diff line number Diff line change
@@ -1,11 +1,14 @@
cfg_unstable! {
mod delay;
mod flatten;
mod race;
mod try_race;

use std::time::Duration;

use delay::DelayFuture;
use flatten::FlattenFuture;
use crate::future::IntoFuture;
use race::Race;
use try_race::TryRace;
}
Expand Down Expand Up @@ -134,6 +137,30 @@ extension_trait! {
DelayFuture::new(self, dur)
}

/// Flatten out the execution of this future when the result itself
/// can be converted into another future.
///
/// # Examples
///
/// ```
/// # async_std::task::block_on(async {
/// use async_std::prelude::*;
///
/// let nested_future = async { async { 1 } };
/// let future = nested_future.flatten();
/// assert_eq!(future.await, 1);
/// # })
/// ```
#[cfg_attr(feature = "docs", doc(cfg(unstable)))]
#[cfg(any(feature = "unstable", feature = "docs"))]
fn flatten(self) -> impl Future<Output = <<Self as Future>::Output as IntoFuture>::Output> [FlattenFuture<Self, <<Self as Future>::Output as IntoFuture>::Future>]
where
Self: Future + Sized,
<Self as Future>::Output: IntoFuture
{
FlattenFuture::new(self)
}

#[doc = r#"
Waits for one of two similarly-typed futures to complete.

Expand Down