Enum futures_util::future::TryMaybeDone

source · [−]

pub enum TryMaybeDone<Fut: TryFuture> {
    Future(Fut),
    Done(Fut::Ok),
    Gone,
}

Expand description

A future that may have completed with an error.

This is created by the try_maybe_done() function.

Variants

`Future(Fut)`

A not-yet-completed future

`Done(Fut::Ok)`

The output of the completed future

`Gone`

The empty variant after the result of a TryMaybeDone has been taken using the take_output method, or if the future returned an error.

Implementations

source

impl<Fut: TryFuture> TryMaybeDone<Fut>

source

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

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 completed successfully and take_output has not yet been called.

source

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

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

Trait Implementations

source

impl<Fut: Debug + TryFuture> Debug for TryMaybeDone<Fut>where
Fut::Ok: Debug,

source

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

Formats the value using the given formatter. Read more

source

impl<Fut: TryFuture> FusedFuture for TryMaybeDone<Fut>

source

fn is_terminated(&self) -> bool

Returns true if the underlying future should no longer be polled.

source

impl<Fut: TryFuture> Future for TryMaybeDone<Fut>

type Output = Result<(), <Fut as TryFuture>::Error>

The type of value produced on completion.

source

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

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

source

impl<Fut: TryFuture + Unpin> Unpin for TryMaybeDone<Fut>

Auto Trait Implementations

impl<Fut> RefUnwindSafe for TryMaybeDone<Fut>where
Fut: RefUnwindSafe,
<Fut as TryFuture>::Ok: RefUnwindSafe,

impl<Fut> Send for TryMaybeDone<Fut>where
Fut: Send,
<Fut as TryFuture>::Ok: Send,

impl<Fut> Sync for TryMaybeDone<Fut>where
Fut: Sync,
<Fut as TryFuture>::Ok: Sync,

impl<Fut> UnwindSafe for TryMaybeDone<Fut>where
Fut: UnwindSafe,
<Fut as TryFuture>::Ok: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere
U: From<T>,

const: unstable

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<F> IntoFuture for Fwhere
F: Future,

type Output = <F as Future>::Output

The output that the future will produce on completion.

type IntoFuture = F

Which kind of future are we turning this into?

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<F, T, E> TryFuture for Fwhere
F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

source

fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

Poll this TryFuture as if it were a Future. Read more

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Enum futures_util::future::TryMaybeDone

Variants

Future(Fut)

Done(Fut::Ok)

Gone

Implementations

impl<Fut: TryFuture> TryMaybeDone<Fut>

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

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

Trait Implementations

impl<Fut: Debug + TryFuture> Debug for TryMaybeDone<Fut>where Fut::Ok: Debug,

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

impl<Fut: TryFuture> FusedFuture for TryMaybeDone<Fut>

fn is_terminated(&self) -> bool

impl<Fut: TryFuture> Future for TryMaybeDone<Fut>

type Output = Result<(), <Fut as TryFuture>::Error>

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

impl<Fut: TryFuture + Unpin> Unpin for TryMaybeDone<Fut>

Auto Trait Implementations

impl<Fut> RefUnwindSafe for TryMaybeDone<Fut>where Fut: RefUnwindSafe, <Fut as TryFuture>::Ok: RefUnwindSafe,

impl<Fut> Send for TryMaybeDone<Fut>where Fut: Send, <Fut as TryFuture>::Ok: Send,

impl<Fut> Sync for TryMaybeDone<Fut>where Fut: Sync, <Fut as TryFuture>::Ok: Sync,

impl<Fut> UnwindSafe for TryMaybeDone<Fut>where Fut: UnwindSafe, <Fut as TryFuture>::Ok: UnwindSafe,

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

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

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<F> IntoFuture for Fwhere F: Future,

type Output = <F as Future>::Output

type IntoFuture = F

fn into_future(self) -> <F as IntoFuture>::IntoFuture

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<F, T, E> TryFuture for Fwhere F: Future<Output = Result<T, E>> + ?Sized,

type Ok = T

type Error = E

fn try_poll( self: Pin<&mut F>, cx: &mut Context<'_>) -> Poll<<F as Future>::Output>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

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

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

`Future(Fut)`

`Done(Fut::Ok)`

`Gone`

impl<Fut: Debug + TryFuture> Debug for TryMaybeDone<Fut>where
Fut::Ok: Debug,

impl<Fut> RefUnwindSafe for TryMaybeDone<Fut>where
Fut: RefUnwindSafe,
<Fut as TryFuture>::Ok: RefUnwindSafe,

impl<Fut> Send for TryMaybeDone<Fut>where
Fut: Send,
<Fut as TryFuture>::Ok: Send,

impl<Fut> Sync for TryMaybeDone<Fut>where
Fut: Sync,
<Fut as TryFuture>::Ok: Sync,

impl<Fut> UnwindSafe for TryMaybeDone<Fut>where
Fut: UnwindSafe,
<Fut as TryFuture>::Ok: UnwindSafe,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<F> IntoFuture for Fwhere
F: Future,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<F, T, E> TryFuture for Fwhere
F: Future<Output = Result<T, E>> + ?Sized,

fn try_poll(
self: Pin<&mut F>,
cx: &mut Context<'_>
) -> Poll<<F as Future>::Output>

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,