[−][src]Struct futures::future::AbortHandle
A handle to a Abortable
future.
Methods
impl AbortHandle
[src]
impl AbortHandle
pub fn new_pair() -> (AbortHandle, AbortRegistration)
[src]
pub fn new_pair() -> (AbortHandle, 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
[src]
impl AbortHandle
pub fn abort(&self)
[src]
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 Clone for AbortHandle
[src]
impl Clone for AbortHandle
fn clone(&self) -> AbortHandle
[src]
fn clone(&self) -> AbortHandle
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Debug for AbortHandle
[src]
impl Debug for AbortHandle
Auto Trait Implementations
impl Send for AbortHandle
impl Send for AbortHandle
impl Sync for AbortHandle
impl Sync for AbortHandle
Blanket Implementations
impl<T, U> Into for T where
U: From<T>,
[src]
impl<T, U> Into for T where
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
type Owned = T
fn to_owned(&self) -> T
[src]
fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
fn clone_into(&self, target: &mut T)
[src]
fn clone_into(&self, target: &mut T)
🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more
impl<T> From for T
[src]
impl<T> From for T
impl<T, U> TryFrom for T where
T: From<U>,
[src]
impl<T, U> TryFrom for T where
T: From<U>,
type Error = !
try_from
)The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
try_from
)Performs the conversion.
impl<T> Borrow for T where
T: ?Sized,
[src]
impl<T> Borrow for T where
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
impl<T> Any for T where
T: 'static + ?Sized,
fn get_type_id(&self) -> TypeId
[src]
fn get_type_id(&self) -> TypeId
🔬 This is a nightly-only experimental API. (get_type_id
)
this method will likely be replaced by an associated static
Gets the TypeId
of self
. Read more
impl<T> BorrowMut for T where
T: ?Sized,
[src]
impl<T> BorrowMut for T where
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,