Enum futures::prelude::future::MaybeDone[][src]

pub enum MaybeDone<Fut> where
    Fut: Future
{ Future(Fut), Done(<Fut as Future>::Output), Gone, }

A future that may have completed.

This is created by the maybe_done() function.

Variants

Future(Fut)

A not-yet-completed future

Done(<Fut as Future>::Output)

The output of the completed future

Gone

The empty variant after the result of a MaybeDone has been taken using the take_output method.

Implementations

impl<Fut> MaybeDone<Fut> where
    Fut: Future
[src]

pub fn output_mut(
    self: Pin<&mut MaybeDone<Fut>>
) -> Option<&mut <Fut as Future>::Output>
[src]

Returns an Option containing a mutable reference to the output of the future. The output of this method will be Some if and only if the inner future has been completed and take_output has not yet been called.

pub fn take_output(
    self: Pin<&mut MaybeDone<Fut>>
) -> Option<<Fut as Future>::Output>
[src]

Attempt to take the output of a MaybeDone without driving it towards completion.

Trait Implementations

impl<Fut> Debug for MaybeDone<Fut> where
    Fut: Debug + Future,
    <Fut as Future>::Output: Debug
[src]

impl<Fut> FusedFuture for MaybeDone<Fut> where
    Fut: Future
[src]

impl<Fut> Future for MaybeDone<Fut> where
    Fut: Future
[src]

type Output = ()

The type of value produced on completion.

impl<Fut> Unpin for MaybeDone<Fut> where
    Fut: Future + Unpin
[src]

Auto Trait Implementations

impl<Fut> RefUnwindSafe for MaybeDone<Fut> where
    Fut: RefUnwindSafe,
    <Fut as Future>::Output: RefUnwindSafe

impl<Fut> Send for MaybeDone<Fut> where
    Fut: Send,
    <Fut as Future>::Output: Send

impl<Fut> Sync for MaybeDone<Fut> where
    Fut: Sync,
    <Fut as Future>::Output: Sync

impl<Fut> UnwindSafe for MaybeDone<Fut> where
    Fut: UnwindSafe,
    <Fut as Future>::Output: 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> FutureExt for T where
    T: Future + ?Sized
[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.