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

[+] Show declaration

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][+]

[+] Show hidden undocumented items

`fn fmt(&self, f: &mut Formatter) -> Result`[src][+]

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

[+] Show hidden undocumented items

`type Output = ()`

The type of value produced on completion.

`fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>`[src][+]

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

[+] Show hidden undocumented items

`fn is_terminated(&self) -> bool`[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,`

Blanket Implementations

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

ⓘImportant traits for Map<Fut, F>
Important traits for Map<Fut, F>
`impl<Fut, F, T> Future for Map<Fut, F> where Fut: Future, F: FnOnce(Fut::Output) -> T, type Output = T;`
`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>
Important traits for Then<Fut1, Fut2, F>
`impl<Fut1, Fut2, F> Future for Then<Fut1, Fut2, F> where Fut1: Future, Fut2: Future, F: FnOnce(Fut1::Output) -> Fut2, type Output = Fut2::Output;`
`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>
Important traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
`fn left_future(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>
Important traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = A::Output>, type Output = A::Output;`
`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>
Important traits for Flatten<Fut>
`impl<Fut> Future for Flatten<Fut> where Fut: Future, Fut::Output: Future, type Output = <Fut::Output as Future>::Output;`
`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>
Important traits for Fuse<Fut>
`impl<Fut: Future> Future for Fuse<Fut> type Output = Fut::Output;`
`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>
Important traits for Inspect<Fut, F>
`impl<Fut, F> Future for Inspect<Fut, F> where Fut: Future, F: FnOnce(&Fut::Output), type Output = Fut::Output;`
`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>
Important traits for CatchUnwind<Fut>
`impl<Fut> Future for CatchUnwind<Fut> where Fut: Future + UnwindSafe, type Output = Result<Fut::Output, Box<dyn Any + Send>>;`
`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>
Important traits for Shared<Fut>
`impl<Fut: Future> Future for Shared<Fut> where Fut::Output: Clone, type Output = Fut::Output;`
`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.

ⓘImportant traits for UnitError<Fut>
Important traits for UnitError<Fut>
`impl<Fut, T> Future for UnitError<Fut> where Fut: Future<Output = T>, type Output = Result<T, ()>;`
`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>
Important traits for NeverError<Fut>
`impl<Fut, T> Future for NeverError<Fut> where Fut: Future<Output = T>, type Output = Result<T, !>;`
`fn never_error(self) -> NeverError<Self> where Self: Sized,` [src][+]

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

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

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

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

[+] Show hidden undocumented items

`fn from(t: T) -> T`[src][+]

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

[+] Show hidden undocumented items

`fn into(self) -> U`[src][+]

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

[+] Show hidden undocumented items

`type Error = Infallible`

The type returned in the event of a conversion error.

`fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src][+]

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

[+] Show hidden undocumented items

ⓘImportant traits for &'_ mut I
Important traits for &'_ mut I
`impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src][+]

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

[+] Show hidden undocumented items

`fn type_id(&self) -> TypeId`[src][+]

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

[+] Show hidden undocumented items

ⓘImportant traits for &'_ mut I
Important traits for &'_ mut I
`impl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = ::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src][+]

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

[+] Show hidden undocumented items

`type Error = >::Error`

The type returned in the event of a conversion error.

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

Variants

Methods

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

pub fn output_mut<'a>(self: Pin<&'a mut Self>) -> Option<&'a mut Fut::Output>[src][+]

pub fn take_output(self: Pin<&mut Self>) -> Option<Fut::Output>[src][+]

Trait Implementations

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

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

fn fmt(&self, f: &mut Formatter) -> Result[src][+]

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

type Output = ()

fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>[src][+]

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

fn is_terminated(&self) -> bool[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,

Blanket Implementations

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

ⓘImportant traits for Map<Fut, F>Important traits for Map<Fut, F>impl<Fut, F, T> Future for Map<Fut, F> where Fut: Future, F: FnOnce(Fut::Output) -> T, type Output = T;fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U, Self: Sized, [src][+]

Important traits for Map<Fut, F>

Important traits for Then<Fut1, Fut2, F>

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

Important traits for Either<A, B>

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

Important traits for Either<A, B>

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

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

Important traits for Flatten<Fut>

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

ⓘImportant traits for Fuse<Fut>Important traits for Fuse<Fut>impl<Fut: Future> Future for Fuse<Fut> type Output = Fut::Output;fn fuse(self) -> Fuse<Self> where Self: Sized, [src][+]

Important traits for Fuse<Fut>

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

Important traits for Inspect<Fut, F>

ⓘImportant traits for CatchUnwind<Fut>Important traits for CatchUnwind<Fut>impl<Fut> Future for CatchUnwind<Fut> where Fut: Future + UnwindSafe, type Output = Result<Fut::Output, Box<dyn Any + Send>>;fn catch_unwind(self) -> CatchUnwind<Self> where Self: Sized + UnwindSafe, [src][+]

Important traits for CatchUnwind<Fut>

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

Important traits for Shared<Fut>

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

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

ⓘImportant traits for UnitError<Fut>Important traits for UnitError<Fut>impl<Fut, T> Future for UnitError<Fut> where Fut: Future<Output = T>, type Output = Result<T, ()>;fn unit_error(self) -> UnitError<Self> where Self: Sized, [src][+]

Important traits for UnitError<Fut>

ⓘImportant traits for NeverError<Fut>Important traits for NeverError<Fut>impl<Fut, T> Future for NeverError<Fut> where Fut: Future<Output = T>, type Output = Result<T, !>;fn never_error(self) -> NeverError<Self> where Self: Sized, [src][+]

Important traits for NeverError<Fut>

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

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

fn from(t: T) -> T[src][+]

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

fn into(self) -> U[src][+]

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

type Error = Infallible

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

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

ⓘImportant traits for &'_ mut IImportant traits for &'_ mut Iimpl<'_, I> Iterator for &'_ mut I where I: Iterator + ?Sized, type Item = <I as Iterator>::Item;impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow(&self) -> &T[src][+]

Important traits for &'_ mut I

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

fn type_id(&self) -> TypeId[src][+]

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

Important traits for &'_ mut I

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

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

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

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

`pub fn output_mut<'a>(self: Pin<&'a mut Self>) -> Option<&'a mut Fut::Output>`[src][+]

`pub fn take_output(self: Pin<&mut Self>) -> Option<Fut::Output>`[src][+]

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

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

`fn fmt(&self, f: &mut Formatter) -> Result`[src][+]

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

`type Output = ()`

`fn poll(self: Pin<&mut Self>, cx: &mut Context) -> Poll<Self::Output>`[src][+]

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

`fn is_terminated(&self) -> bool`[src][+]

`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<T> FutureExt for T where T: Future + ?Sized,` [src][+]

ⓘImportant traits for Map<Fut, F>
Important traits for Map<Fut, F>
`impl<Fut, F, T> Future for Map<Fut, F> where Fut: Future, F: FnOnce(Fut::Output) -> T, type Output = T;`
`fn map<U, F>(self, f: F) -> Map<Self, F> where F: FnOnce(Self::Output) -> U, Self: Sized,` [src][+]

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

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

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

ⓘImportant traits for Flatten<Fut>
Important traits for Flatten<Fut>
`impl<Fut> Future for Flatten<Fut> where Fut: Future, Fut::Output: Future, type Output = <Fut::Output as Future>::Output;`
`fn flatten(self) -> Flatten<Self> where Self::Output: Future, Self: Sized,` [src][+]

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

ⓘImportant traits for Fuse<Fut>
Important traits for Fuse<Fut>
`impl<Fut: Future> Future for Fuse<Fut> type Output = Fut::Output;`
`fn fuse(self) -> Fuse<Self> where Self: Sized,` [src][+]

ⓘImportant traits for Inspect<Fut, F>
Important traits for Inspect<Fut, F>
`impl<Fut, F> Future for Inspect<Fut, F> where Fut: Future, F: FnOnce(&Fut::Output), type Output = Fut::Output;`
`fn inspect<F>(self, f: F) -> Inspect<Self, F> where F: FnOnce(&Self::Output), Self: Sized,` [src][+]

ⓘImportant traits for CatchUnwind<Fut>
Important traits for CatchUnwind<Fut>
`impl<Fut> Future for CatchUnwind<Fut> where Fut: Future + UnwindSafe, type Output = Result<Fut::Output, Box<dyn Any + Send>>;`
`fn catch_unwind(self) -> CatchUnwind<Self> where Self: Sized + UnwindSafe,` [src][+]

ⓘImportant traits for Shared<Fut>
Important traits for Shared<Fut>
`impl<Fut: Future> Future for Shared<Fut> where Fut::Output: Clone, type Output = Fut::Output;`
`fn shared(self) -> Shared<Self> where Self: Sized, Self::Output: Clone,` [src][+]

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

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

ⓘImportant traits for UnitError<Fut>
Important traits for UnitError<Fut>
`impl<Fut, T> Future for UnitError<Fut> where Fut: Future<Output = T>, type Output = Result<T, ()>;`
`fn unit_error(self) -> UnitError<Self> where Self: Sized,` [src][+]

ⓘImportant traits for NeverError<Fut>
Important traits for NeverError<Fut>
`impl<Fut, T> Future for NeverError<Fut> where Fut: Future<Output = T>, type Output = Result<T, !>;`
`fn never_error(self) -> NeverError<Self> where Self: Sized,` [src][+]

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

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

`fn from(t: T) -> T`[src][+]

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

`fn into(self) -> U`[src][+]

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

`type Error = Infallible`

`fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src][+]

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

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

`fn type_id(&self) -> TypeId`[src][+]

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

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

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

`fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src][+]