Enum MaybeDone

pub enum MaybeDone<Fut: Future>

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.

Implementations

impl<Fut: Future> MaybeDone<Fut>

fn output_mut(self: Pin<&mut Self>) -> Option<&mut Fut::Output>

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.

fn take_output(self: Pin<&mut Self>) -> Option<Fut::Output>

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

Trait Implementations

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

fn fmt(&self, f: &mut Formatter<'_>) -> Result

impl<Fut: Future + Unpin> Unpin for MaybeDone<Fut>

impl<Fut: Future> FusedFuture for MaybeDone<Fut>

fn is_terminated(&self) -> bool

impl<Fut: Future> Future for MaybeDone<Fut>

type Output = ();
fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Auto Trait Implementations

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

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> UnsafeUnpin for MaybeDone<Fut> where Fut: UnsafeUnpin, <Fut as Future>::Output: UnsafeUnpin,

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

Blanket Implementations

impl<F> IntoFuture for MaybeDone<Fut> where F: Future,

type Output = <F as Future>::Output;
type IntoFuture = F;
fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T> Any for MaybeDone<Fut> where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for MaybeDone<Fut> where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for MaybeDone<Fut> where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for MaybeDone<Fut>

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> FutureExt for MaybeDone<Fut> where T: Future + ?Sized,

impl<T, U> Into<U> for MaybeDone<Fut> where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T, U> TryFrom<U> for MaybeDone<Fut> where U: Into<T>,

type Error = never;
fn try_from(value: U) -> Result<T, never>

impl<T, U> TryInto<U> for MaybeDone<Fut> where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error;
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>