Trait async_std::prelude::FutureExt

pub trait FutureExt: Future {
    // Provided methods
    fn delay(self, dur: Duration) -> DelayFuture<Self>
       where Self: Sized { ... }
    fn flatten(
        self
    ) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future>
       where Self: Sized,
             <Self as Future>::Output: IntoFuture { ... }
    fn race<F>(self, other: F) -> Race<Self, F>
       where Self: Future + Sized,
             F: Future<Output = <Self as Future>::Output> { ... }
    fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F>
       where Self: Future<Output = Result<T, E>> + Sized,
             F: Future<Output = <Self as Future>::Output> { ... }
    fn join<F>(self, other: F) -> Join<Self, F>
       where Self: Future + Sized,
             F: Future { ... }
    fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F>
       where Self: Future<Output = Result<A, E>> + Sized,
             F: Future<Output = Result<B, E>> { ... }
    fn timeout(self, dur: Duration) -> TimeoutFuture<Self>
       where Self: Sized { ... }
}

Extension methods for Future.

Provided Methods

fn delay(self, dur: Duration) -> DelayFuture<Self>

where Self: Sized,

Returns a Future that delays execution for a specified time.

Examples

use async_std::prelude::*;
use async_std::future;
use std::time::Duration;

let a = future::ready(1).delay(Duration::from_millis(2000));
dbg!(a.await);

fn flatten(self) -> FlattenFuture<Self, <Self::Output as IntoFuture>::Future>

where Self: Sized, <Self as Future>::Output: IntoFuture,

Flatten out the execution of this future when the result itself can be converted into another future.

Examples

use async_std::prelude::*;

let nested_future = async { async { 1 } };
let future = nested_future.flatten();
assert_eq!(future.await, 1);

fn race<F>(self, other: F) -> Race<Self, F>

where Self: Future + Sized, F: Future<Output = <Self as Future>::Output>,

Waits for one of two similarly-typed futures to complete.

Awaits multiple futures simultaneously, returning the output of the first future that completes.

This function will return a new future which awaits for either one of both futures to complete. If multiple futures are completed at the same time, resolution will occur in the order that they have been passed.

Note that this function consumes all futures passed, and once a future is completed, all other futures are dropped.

Examples

use async_std::prelude::*;
use async_std::future;

let a = future::pending();
let b = future::ready(1u8);
let c = future::ready(2u8);

let f = a.race(b).race(c);
assert_eq!(f.await, 1u8);

fn try_race<F, T, E>(self, other: F) -> TryRace<Self, F>

where Self: Future<Output = Result<T, E>> + Sized, F: Future<Output = <Self as Future>::Output>,

Waits for one of two similarly-typed fallible futures to complete.

Awaits multiple futures simultaneously, returning all results once complete.

try_race is similar to race, but keeps going if a future resolved to an error until all futures have been resolved. In which case an error is returned.

The ordering of which value is yielded when two futures resolve simultaneously is intentionally left unspecified.

Examples

use async_std::prelude::*;
use async_std::future;
use std::io::{Error, ErrorKind};

let a = future::pending::<Result<_, Error>>();
let b = future::ready(Err(Error::from(ErrorKind::Other)));
let c = future::ready(Ok(1u8));

let f = a.try_race(b).try_race(c);
assert_eq!(f.await?, 1u8);

fn join<F>(self, other: F) -> Join<Self, F>

where Self: Future + Sized, F: Future,

Waits for two similarly-typed futures to complete.

Awaits multiple futures simultaneously, returning the output of the futures once both complete.

This function returns a new future which polls both futures concurrently.

Examples

use async_std::prelude::*;
use async_std::future;

let a = future::ready(1u8);
let b = future::ready(2u16);

let f = a.join(b);
assert_eq!(f.await, (1u8, 2u16));

fn try_join<F, A, B, E>(self, other: F) -> TryJoin<Self, F>

where Self: Future<Output = Result<A, E>> + Sized, F: Future<Output = Result<B, E>>,

Waits for two similarly-typed fallible futures to complete.

Awaits multiple futures simultaneously, returning all results once complete.

try_join is similar to join, but returns an error immediately if a future resolves to an error.

Examples

use async_std::prelude::*;
use async_std::future;

let a = future::ready(Err::<u8, &str>("Error"));
let b = future::ready(Ok(1u8));

let f = a.try_join(b);
assert_eq!(f.await, Err("Error"));

let a = future::ready(Ok::<u8, String>(1u8));
let b = future::ready(Ok::<u16, String>(2u16));

let f = a.try_join(b);
assert_eq!(f.await, Ok((1u8, 2u16)));

fn timeout(self, dur: Duration) -> TimeoutFuture<Self>

where Self: Sized,

Waits for both the future and a timeout, if the timeout completes before the future, it returns a TimeoutError.

Example

use std::time::Duration;

use async_std::prelude::*;
use async_std::future;

let fut = future::ready(0);
let dur = Duration::from_millis(100);
let res = fut.timeout(dur).await;
assert!(res.is_ok());

let fut = future::pending::<()>();
let dur = Duration::from_millis(100);
let res = fut.timeout(dur).await;
assert!(res.is_err())

Implementors

impl<T: Future + ?Sized> FutureExt for T