Struct futures_util::future::Abortable

[+] Show declaration

[+] Expand attributes
#[must_use = "futures do nothing unless polled"]
pub struct Abortable<Fut> { /* fields omitted */ }

[−] Expand description

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::{ready, Abortable, AbortHandle, Aborted};
use futures::executor::block_on;

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

Trait Implementations

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

[+]

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

[−]

Formats the value using the given formatter.

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

[+]

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: Unpin> Unpin for Abortable<Fut>

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

[+]

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

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

The result of the Future.

fn poll(self: PinMut<Self>, cx: &mut Context) -> Poll<Self::Output>

[−]

🔬 This is a nightly-only experimental API. (futures_api)

futures in libcore are unstable

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.