Struct futures_util::future::AbortHandle [−][src]
pub struct AbortHandle { /* fields omitted */ }
Expand description
A handle to an Abortable
task.
Implementations
impl AbortHandle
[src]
impl AbortHandle
[src]pub fn new_pair() -> (Self, AbortRegistration)
[src]
pub fn new_pair() -> (Self, AbortRegistration)
[src]Creates an (AbortHandle
, AbortRegistration
) pair which can be used
to abort a running future or stream.
This function is usually paired with a call to Abortable::new
.
impl AbortHandle
[src]
impl AbortHandle
[src]pub fn abort(&self)
[src]
pub fn abort(&self)
[src]Abort the Abortable
stream/future associated with this handle.
Notifies the Abortable task associated with this handle that it should abort. Note that if the task 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
[src]fn clone(&self) -> AbortHandle
[src]
fn clone(&self) -> AbortHandle
[src]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)
1.0.0[src]Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for AbortHandle
impl Send for AbortHandle
impl Sync for AbortHandle
impl Unpin for AbortHandle
impl !UnwindSafe for AbortHandle
Blanket Implementations
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more