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

pub struct AbortHandle { /* fields omitted */ }

A handle to a Abortable future.

Implementations

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

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]

impl Debug for AbortHandle[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized, [src]

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

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

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

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

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

type Owned = T

The resulting type after obtaining ownership.

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

type Error = Infallible

The type returned in the event of a conversion error.

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

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

The type returned in the event of a conversion error.