Struct futures_util::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, 

pub fn new(future: Fut, reg: AbortRegistration) -> Self

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:

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

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

Trait Implementations

impl<Fut: Unpin> Unpin for Abortable<Fut>

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

Important traits for Abortable<Fut>

impl<Fut> Future for Abortable<Fut> where
    Fut: Future,  type Output = Result<Fut::Output, Aborted>;

fn clone(&self) -> Abortable<Fut>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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

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

Formats the value using the given formatter.

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

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

The type of value produced on completion.

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.