Struct futures_util::stream::AbortHandle
source · [−]pub struct AbortHandle { /* private fields */ }Expand description
A handle to an Abortable task.
Implementations
sourceimpl AbortHandle
impl AbortHandle
sourcepub fn new_pair() -> (Self, AbortRegistration)
pub fn new_pair() -> (Self, AbortRegistration)
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.
sourceimpl AbortHandle
impl AbortHandle
sourcepub fn abort(&self)
pub fn abort(&self)
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
sourceimpl Clone for AbortHandle
impl Clone for AbortHandle
sourcefn clone(&self) -> AbortHandle
fn clone(&self) -> AbortHandle
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
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
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcefn clone_into(&self, target: &mut T)
fn clone_into(&self, target: &mut T)
toowned_clone_into)Uses borrowed data to replace owned data, usually by cloning. Read more