[][src]Struct futures::future::Abortable

#[must_use = "futures do nothing unless you `.await` or poll them"]
pub struct Abortable<Fut> { /* fields omitted */ }

A future which can be remotely short-circuited using an AbortHandle.

Methods

impl<Fut> Abortable<Fut> where
    Fut: Future
[src]

Important traits for Abortable<Fut>
pub fn new(future: Fut, reg: AbortRegistration) -> Abortable<Fut>[src]

Creates a new Abortable future using an existing AbortRegistration. AbortRegistrations can be acquired through AbortHandle::new.

When abort is called on the handle tied to reg or if abort has already been called, the future will complete immediately without making any further progress.

Example:

#![feature(async_await)]
use futures::future::{ready, Abortable, AbortHandle, Aborted};

let (abort_handle, abort_registration) = AbortHandle::new_pair();
let future = Abortable::new(ready(2), abort_registration);
abort_handle.abort();
assert_eq!(future.await, Err(Aborted));

Trait Implementations

impl<Fut> Clone for Abortable<Fut> where
    Fut: Clone
[src]

impl<Fut> Unpin for Abortable<Fut> where
    Fut: Unpin
[src]

impl<Fut> Debug for Abortable<Fut> where
    Fut: Debug
[src]

impl<Fut> Future for Abortable<Fut> where
    Fut: Future
[src]

type Output = Result<<Fut as Future>::Output, Aborted>

The type of value produced on completion.

Auto Trait Implementations

impl<Fut> Send for Abortable<Fut> where
    Fut: Send

impl<Fut> Sync for Abortable<Fut> where
    Fut: Sync

impl<Fut> !UnwindSafe for Abortable<Fut>

impl<Fut> !RefUnwindSafe for Abortable<Fut>

Blanket Implementations

impl<T> ToOwned for T where
    T: Clone
[src]

type Owned = T

The resulting type after obtaining ownership.

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

impl<T> From<T> for 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<F, T, E> TryFuture for F where
    F: Future<Output = Result<T, E>> + ?Sized
[src]

type Ok = T

The type of successful values yielded by this future

type Error = E

The type of failures yielded by this future

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

impl<Fut> TryFutureExt for Fut where
    Fut: TryFuture + ?Sized
[src]