[][src]Struct futures_util::future::AbortHandle

pub struct AbortHandle { /* fields omitted */ }

A handle to a Abortable future.

Methods

impl AbortHandle[src]

pub fn new_pair() -> (Self, AbortRegistration)[src]

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

pub fn abort(&self)[src]

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 Clone for AbortHandle[src]

default fn clone_from(&mut self, source: &Self)
1.0.0
[src]

Performs copy-assignment from source. Read more

impl Debug for AbortHandle[src]

Auto Trait Implementations

impl Send for AbortHandle

impl Sync for AbortHandle

Blanket Implementations

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

type Owned = T

impl<T> From for T[src]

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

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

type Error = Infallible

The type returned in the event of a conversion error.

impl<T> Borrow for T where
    T: ?Sized
[src]

impl<T> BorrowMut for T where
    T: ?Sized
[src]

impl<T, U> TryInto 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> Any for T where
    T: 'static + ?Sized
[src]