Struct futures_util::stream::AbortHandle
source · pub struct AbortHandle {
inner: Arc<AbortInner>,
}
Expand description
A handle to an Abortable
task.
Fields§
§inner: Arc<AbortInner>
Implementations§
source§impl 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
.
source§impl 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.
sourcepub fn is_aborted(&self) -> bool
pub fn is_aborted(&self) -> bool
Checks whether AbortHandle::abort
was called on any associated
AbortHandle
s, which includes all the AbortHandle
s linked with
the same AbortRegistration
. This means that it will return true
even if:
abort
was called after the task had completed.abort
was called while the task was being polled - the task may still be running and will not be stopped untilpoll
returns.
This operation has a Relaxed ordering.
Trait Implementations§
source§impl Clone for AbortHandle
impl Clone for AbortHandle
source§fn clone(&self) -> AbortHandle
fn clone(&self) -> AbortHandle
Returns a copy of the value. Read more
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations§
impl Freeze for AbortHandle
impl !RefUnwindSafe for AbortHandle
impl Send for AbortHandle
impl Sync for AbortHandle
impl Unpin for AbortHandle
impl !UnwindSafe for AbortHandle
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
source§unsafe fn clone_to_uninit(&self, dst: *mut T)
unsafe fn clone_to_uninit(&self, dst: *mut T)
🔬This is a nightly-only experimental API. (
clone_to_uninit
)