Struct futures_util::future::AbortHandle

pub struct AbortHandle { /* fields omitted */ }

A handle to a Abortable future.

Methods

impl AbortHandle

pub fn new_pair() -> (Self, AbortRegistration)

Creates an (AbortHandle, AbortRegistration) pair which can be used to abort a running future.

This function is usually paired with a call to Abortable::new.

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));

impl AbortHandle

pub fn abort(&self)

Abort the Abortable future associated with this handle.

Notifies the Abortable future associated with this handle that it should abort. Note that if the future is currently being polled on another thread, it will not immediately stop running. Instead, it will continue to run until its poll method returns.

Trait Implementations

impl Debug for AbortHandle

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

Formats the value using the given formatter.

impl Clone for AbortHandle

fn clone(&self) -> AbortHandle

Returns a copy of the value.

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

Performs copy-assignment from source.