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


impl<Fut> Abortable<Fut> where
    Fut: Future

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.


use futures::future::{Abortable, AbortHandle, Aborted};

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

Trait Implementations

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

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

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

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

The type of value produced on completion.

impl<'pin, Fut> Unpin for Abortable<Fut> where
    __Abortable<'pin, Fut>: Unpin

Auto Trait Implementations

impl<Fut> !RefUnwindSafe for Abortable<Fut>

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

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

impl<Fut> !UnwindSafe for Abortable<Fut>

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

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

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

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

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

impl<F, T, E> TryFuture for F where
    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

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

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

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

The type returned in the event of a conversion error.