Trait futures_concurrency::future::RaceOk

pub trait RaceOk {
    type Output;
    type Error;

    fn race_ok<'async_trait>(
        self
    ) -> Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + 'async_trait>>
    where
        Self: 'async_trait;
}

Wait for the first successful future to complete.

Awaits multiple futures simultaneously, returning the output of the first future which completes. If no future completes successfully, returns an aggregate error of all failed futures.

Required Associated Types

type Output

The resulting output type.

type Error

The resulting error type.

Required Methods

fn race_ok<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + 'async_trait>>where
    Self: 'async_trait,

Waits for the first successful future to complete.

Implementations on Foreign Types

impl<Fut, T, E, const N: usize> RaceOk for [Fut; N]where
    T: Debug,
    Fut: IntoFuture<Output = Result<T, E>>,
    E: Debug,

type Output = T

type Error = AggregateError<E, N>

fn race_ok<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + 'async_trait>>where
    Self: 'async_trait,

impl<Fut, T, E> RaceOk for Vec<Fut>where
    T: Debug,
    E: Debug,
    Fut: IntoFuture<Output = Result<T, E>>,

type Output = T

type Error = AggregateError<E>

fn race_ok<'async_trait>(
    self
) -> Pin<Box<dyn Future<Output = Result<Self::Output, Self::Error>> + 'async_trait>>where
    Self: 'async_trait,

Implementors