Struct safina_select::SelectFuture[][src]

#[must_use = "futures stay idle unless you await them"]pub struct SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
    FutA: Future<Output = A> + Send + Unpin + 'static,
    FutB: Future<Output = B> + Send + Unpin + 'static,
    FutC: Future<Output = C> + Send + Unpin + 'static,
    FutD: Future<Output = D> + Send + Unpin + 'static,
    FutE: Future<Output = E> + Send + Unpin + 'static, 
{ /* fields omitted */ }

A future that polls two futures and returns the value from the one that completes first.

Implementations

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
    FutA: Future<Output = A> + Send + Unpin + 'static,
    FutB: Future<Output = B> + Send + Unpin + 'static,
    FutC: Future<Output = C> + Send + Unpin + 'static,
    FutD: Future<Output = D> + Send + Unpin + 'static,
    FutE: Future<Output = E> + Send + Unpin + 'static, 
[src]

pub fn new(
    a: FutA,
    b: FutB,
    c: FutC,
    d: FutD,
    e: FutE
) -> SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>

Notable traits for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Future for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
    FutA: Future<Output = A> + Send + Unpin + 'static,
    FutB: Future<Output = B> + Send + Unpin + 'static,
    FutC: Future<Output = C> + Send + Unpin + 'static,
    FutD: Future<Output = D> + Send + Unpin + 'static,
    FutE: Future<Output = E> + Send + Unpin + 'static, 
type Output = OptionAbcde<A, B, C, D, E>;
[src]

Makes a future that awaits all of the provided futures, and returns the value from the one that completes first.

Note that they must be Unpin. Use std::boxed::Box::pin to make them Unpin. Or use pin_utils::pin_mut to do it with unsafe code that does not allocate memory.

Trait Implementations

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Future for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
    FutA: Future<Output = A> + Send + Unpin + 'static,
    FutB: Future<Output = B> + Send + Unpin + 'static,
    FutC: Future<Output = C> + Send + Unpin + 'static,
    FutD: Future<Output = D> + Send + Unpin + 'static,
    FutE: Future<Output = E> + Send + Unpin + 'static, 
[src]

type Output = OptionAbcde<A, B, C, D, E>

The type of value produced on completion.

Auto Trait Implementations

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> RefUnwindSafe for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
    FutA: RefUnwindSafe,
    FutB: RefUnwindSafe,
    FutC: RefUnwindSafe,
    FutD: RefUnwindSafe,
    FutE: RefUnwindSafe

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Send for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Sync for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
    FutA: Sync,
    FutB: Sync,
    FutC: Sync,
    FutD: Sync,
    FutE: Sync

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> Unpin for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE>

impl<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> UnwindSafe for SelectFuture<A, B, C, D, E, FutA, FutB, FutC, FutD, FutE> where
    FutA: UnwindSafe,
    FutB: UnwindSafe,
    FutC: UnwindSafe,
    FutD: UnwindSafe,
    FutE: UnwindSafe

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

type Output = <F as Future>::Output

🔬 This is a nightly-only experimental API. (into_future)

The output that the future will produce on completion.

type Future = F

🔬 This is a nightly-only experimental API. (into_future)

Which kind of future are we turning this into?

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.