[−][src]Enum futures_util::future::MaybeDone

pub enum MaybeDone<Fut: Future> {
    Future(Fut),
    Done(Fut::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::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.

Methods

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

pub fn output_mut<'a>(self: Pin<&'a mut Self>) -> Option<&'a mut Fut::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 Self>) -> Option<Fut::Output>[src]

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

Trait Implementations

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

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

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

type Output = ()

The type of value produced on completion.

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

Auto Trait Implementations

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, 

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

Blanket Implementations

impl<T> FutureExt for T where
    T: Future + ?Sized, [src]

ⓘImportant traits for Map<Fut, F>
fn map<U, F>(self, f: F) -> Map<Self, F> where
    F: FnOnce(Self::Output) -> U,
    Self: Sized, [src]

Map this future's output to a different type, returning a new future of the resulting type. Read more

ⓘImportant traits for Then<Fut1, Fut2, F>
fn then<Fut, F>(self, f: F) -> Then<Self, Fut, F> where
    F: FnOnce(Self::Output) -> Fut,
    Fut: Future,
    Self: Sized, [src]

Chain on a computation for when a future finished, passing the result of the future to the provided closure f. Read more

ⓘImportant traits for Either<A, B>
fn left_future<B>(self) -> Either<Self, B> where
    B: Future<Output = Self::Output>,
    Self: Sized, [src]

Wrap this future in an Either future, making it the left-hand variant of that Either. Read more

ⓘImportant traits for Either<A, B>
fn right_future<A>(self) -> Either<A, Self> where
    A: Future<Output = Self::Output>,
    Self: Sized, [src]

Wrap this future in an Either future, making it the right-hand variant of that Either. Read more

fn into_stream(self) -> IntoStream<Self> where
    Self: Sized, [src]

Convert this future into a single element stream. Read more

ⓘImportant traits for Flatten<Fut>
fn flatten(self) -> Flatten<Self> where
    Self::Output: Future,
    Self: Sized, [src]

Flatten the execution of this future when the successful result of this future is itself another future. Read more

fn flatten_stream(self) -> FlattenStream<Self> where
    Self::Output: Stream,
    Self: Sized, [src]

Flatten the execution of this future when the successful result of this future is a stream. Read more

ⓘImportant traits for Fuse<Fut>
fn fuse(self) -> Fuse<Self> where
    Self: Sized, [src]

Fuse a future such that poll will never again be called once it has completed. This method can be used to turn any Future into a FusedFuture. Read more

ⓘImportant traits for Inspect<Fut, F>
fn inspect<F>(self, f: F) -> Inspect<Self, F> where
    F: FnOnce(&Self::Output),
    Self: Sized, [src]

Do something with the output of a future before passing it on. Read more

ⓘImportant traits for CatchUnwind<Fut>
fn catch_unwind(self) -> CatchUnwind<Self> where
    Self: Sized + UnwindSafe, [src]

Catches unwinding panics while polling the future. Read more

ⓘImportant traits for Shared<Fut>
fn shared(self) -> Shared<Self> where
    Self: Sized,
    Self::Output: Clone, [src]

Create a cloneable handle to this future where all handles will resolve to the same result. Read more

fn remote_handle(self) -> (Remote<Self>, RemoteHandle<Self::Output>) where
    Self: Sized, [src]

Turn this future into a future that yields () on completion and sends its output to another future on a separate task. Read more

fn boxed<'a>(self) -> BoxFuture<'a, Self::Output> where
    Self: Sized + Send + 'a, [src]

Wrap the future in a Box, pinning it.

fn boxed_local<'a>(self) -> LocalBoxFuture<'a, Self::Output> where
    Self: Sized + 'a, [src]

Wrap the future in a Box, pinning it. Read more

ⓘImportant traits for UnitError<Fut>
fn unit_error(self) -> UnitError<Self> where
    Self: Sized, [src]

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = ()>. Read more

ⓘImportant traits for NeverError<Fut>
fn never_error(self) -> NeverError<Self> where
    Self: Sized, [src]

Turns a Future<Output = T> into a TryFuture<Ok = T, Error = Never>. Read more

fn poll_unpin(&mut self, cx: &mut Context) -> Poll<Self::Output> where
    Self: Unpin, [src]

A convenience for calling Future::poll on Unpin future types.

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

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

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.

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

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

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

impl<V, T> VZip<V> for T where
    V: MultiLane<T>,