[][src]Struct futures::future::Fuse

#[must_use = "futures do nothing unless polled"]
pub struct Fuse<A: Future> { /* fields omitted */ }

A future which "fuses" a future once it's been resolved.

Normally futures can behave unpredictable once they're used after a future has been resolved, but Fuse is always defined to return Async::NotReady from poll after it has resolved successfully or returned an error.

This is created by the Future::fuse method.

Methods

impl<A: Future> Fuse<A>[src]

pub fn is_done(&self) -> bool[src]

Returns whether the underlying future has finished or not.

If this method returns true, then all future calls to poll are guaranteed to return Ok(Async::NotReady). If this returns false, then the underlying future has not been driven to completion.

Trait Implementations

impl<A: Debug + Future> Debug for Fuse<A>[src]

impl<A: Future> Future for Fuse<A>[src]

type Item = A::Item

The type of value that this future will resolved with if it is successful. Read more

type Error = A::Error

The type of error that this future will resolve with if it fails in a normal fashion. Read more

Auto Trait Implementations

impl<A> RefUnwindSafe for Fuse<A> where
    A: RefUnwindSafe

impl<A> Send for Fuse<A> where
    A: Send

impl<A> Sync for Fuse<A> where
    A: Sync

impl<A> Unpin for Fuse<A> where
    A: Unpin

impl<A> UnwindSafe for Fuse<A> where
    A: 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, U> Into<U> for T where
    U: From<T>, 
[src]

impl<F> IntoFuture for F where
    F: Future
[src]

type Future = F

The future that this type can be converted into.

type Item = <F as Future>::Item

The item that the future may resolve with.

type Error = <F as Future>::Error

The error that the future may resolve with.

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.