[−][src]Struct futures::future::AbortHandle
A handle to a Abortable
future.
Methods
impl AbortHandle
[src]
pub fn new_pair() -> (AbortHandle, 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]
fn clone(&self) -> AbortHandle
[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for AbortHandle
[src]
Auto Trait Implementations
impl Send for AbortHandle
impl Unpin for AbortHandle
impl Sync for AbortHandle
impl !UnwindSafe for AbortHandle
impl !RefUnwindSafe for AbortHandle
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
fn to_owned(&self) -> T
[src]
fn clone_into(&self, target: &mut T)
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
ⓘImportant traits for &'_ mut Ffn borrow_mut(&mut self) -> &mut T
[src]
ⓘImportant traits for &'_ mut F
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,