devela::_dep::tokio::task

Struct AbortHandle

Help

pub struct AbortHandle { /* private fields */ }

Available on crate features dep_tokio and std only.

Expand description

An owned permission to abort a spawned task, without awaiting its completion.

Unlike a JoinHandle, an AbortHandle does not represent the permission to await the task’s completion, only to terminate it.

The task may be aborted by calling the AbortHandle::abort method. Dropping an AbortHandle releases the permission to terminate the task — it does not abort the task.

Be aware that tasks spawned using spawn_blocking cannot be aborted because they are not async. If you call abort on a spawn_blocking task, then this will not have any effect, and the task will continue running normally. The exception is if the task has not started running yet; in that case, calling abort may prevent the task from starting.

Implementations§

§

impl AbortHandle

pub fn abort(&self)

Abort the task associated with the handle.

Awaiting a cancelled task might complete as usual if the task was already completed at the time it was cancelled, but most likely it will fail with a cancelled JoinError.

If the task was already cancelled, such as by JoinHandle::abort, this method will do nothing.

Be aware that tasks spawned using spawn_blocking cannot be aborted because they are not async. If you call abort on a spawn_blocking task, then this will not have any effect, and the task will continue running normally. The exception is if the task has not started running yet; in that case, calling abort may prevent the task from starting.

See also the module level docs for more information on cancellation.

pub fn is_finished(&self) -> bool

Checks if the task associated with this AbortHandle has finished.

Please note that this method can return false even if abort has been called on the task. This is because the cancellation process may take some time, and this method does not return true until it has completed.

pub fn id(&self) -> Id

Returns a task ID that uniquely identifies this task relative to other currently spawned tasks.

Trait Implementations§

§

impl Clone for AbortHandle

§

fn clone(&self) -> AbortHandle

Returns a cloned AbortHandle that can be used to remotely abort this task.

1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

§

impl Debug for AbortHandle

§

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error> ⓘ

Formats the value using the given formatter. Read more

§

impl Drop for AbortHandle

§

fn drop(&mut self)

Executes the destructor for this type. Read more

§

impl UnwindSafe for AbortHandle

Auto Trait Implementations§

§

Struct AbortHandleCopy item path

Implementations§

impl AbortHandle

pub fn abort(&self)

pub fn is_finished(&self) -> bool

pub fn id(&self) -> Id

Trait Implementations§

impl Clone for AbortHandle

fn clone(&self) -> AbortHandle

fn clone_from(&mut self, source: &Self)

impl Debug for AbortHandle

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error> ⓘ

impl Drop for AbortHandle

fn drop(&mut self)

impl RefUnwindSafe for AbortHandle

impl Send for AbortHandle

impl Sync for AbortHandle

impl UnwindSafe for AbortHandle

Auto Trait Implementations§

impl Freeze for AbortHandle

impl Unpin for AbortHandle

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> ByteSized for T

const BYTE_ALIGN: usize = _

const BYTE_SIZE: usize = _

fn byte_align(&self) -> usize

fn byte_size(&self) -> usize

fn ptr_size_ratio(&self) -> [usize; 2]

impl<T, R> Chain<R> for Twhere T: ?Sized,

fn chain<F>(self, f: F) -> Rwhere F: FnOnce(Self) -> R, Self: Sized,

fn chain_ref<F>(&self, f: F) -> Rwhere F: FnOnce(&Self) -> R,

fn chain_mut<F>(&mut self, f: F) -> Rwhere F: FnOnce(&mut Self) -> R,

impl<T> CloneToUninit for Twhere T: Clone,

unsafe fn clone_to_uninit(&self, dst: *mut u8)

impl<T> ExtAny for Twhere T: Any + ?Sized,

fn type_id() -> TypeId

fn type_of(&self) -> TypeId

fn type_name(&self) -> &'static str ⓘ

fn type_is<T: 'static>(&self) -> bool

fn type_hash(&self) -> u64

fn type_hash_with<H: Hasher>(&self, hasher: H) -> u64

fn as_any_ref(&self) -> &dyn Anywhere Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Anywhere Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>where Self: Sized,

fn downcast_ref<T: 'static>(&self) -> Option<&T> ⓘ

fn downcast_mut<T: 'static>(&mut self) -> Option<&mut T> ⓘ

impl<T> ExtMem for Twhere T: ?Sized,

const NEEDS_DROP: bool = _

fn mem_align_of<T>() -> usize

fn mem_align_of_val(&self) -> usize

fn mem_size_of<T>() -> usize

fn mem_size_of_val(&self) -> usize

fn mem_copy(&self) -> Selfwhere Self: Copy,

fn mem_needs_drop(&self) -> bool

fn mem_drop(self)where Self: Sized,

fn mem_forget(self)where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Selfwhere Self: Sized,

fn mem_take(&mut self) -> Selfwhere Self: Default,

fn mem_swap(&mut self, other: &mut Self)where Self: Sized,

unsafe fn mem_zeroed<T>() -> T

unsafe fn mem_transmute_copy<Src, Dst>(src: &Src) -> Dst

fn mem_as_bytes(&self) -> &[u8] ⓘwhere Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘwhere Self: Sync + Unpin,

impl<T> From<T> for T

fn from(t: T) -> T

impl<S> FromSample<S> for S

fn from_sample_(s: S) -> S

impl<T> Hook for T

fn hook_ref<F>(self, f: F) -> Selfwhere F: FnOnce(&Self),

fn hook_mut<F>(self, f: F) -> Selfwhere F: FnOnce(&mut Self),

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

fn in_current_span(self) -> Instrumented<Self> ⓘ

impl<T, U> Into<U> for Twhere U: From<T>,

Struct AbortHandle

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, R> Chain<R> for T
where T: ?Sized,

fn chain<F>(self, f: F) -> R
where F: FnOnce(Self) -> R, Self: Sized,

fn chain_ref<F>(&self, f: F) -> R
where F: FnOnce(&Self) -> R,

fn chain_mut<F>(&mut self, f: F) -> R
where F: FnOnce(&mut Self) -> R,

impl<T> CloneToUninit for T
where T: Clone,

impl<T> ExtAny for T
where T: Any + ?Sized,

fn as_any_ref(&self) -> &dyn Any
where Self: Sized,

fn as_any_mut(&mut self) -> &mut dyn Any
where Self: Sized,

fn as_any_box(self: Box<Self>) -> Box<dyn Any>
where Self: Sized,

impl<T> ExtMem for T
where T: ?Sized,

fn mem_copy(&self) -> Self
where Self: Copy,

fn mem_drop(self)
where Self: Sized,

fn mem_forget(self)
where Self: Sized,

fn mem_replace(&mut self, other: Self) -> Self
where Self: Sized,

fn mem_take(&mut self) -> Self
where Self: Default,

fn mem_swap(&mut self, other: &mut Self)
where Self: Sized,

fn mem_as_bytes(&self) -> &[u8] ⓘ
where Self: Sync + Unpin,

fn mem_as_bytes_mut(&mut self) -> &mut [u8] ⓘ
where Self: Sync + Unpin,

fn hook_ref<F>(self, f: F) -> Self
where F: FnOnce(&Self),

fn hook_mut<F>(self, f: F) -> Self
where F: FnOnce(&mut Self),

impl<T, U> Into<U> for T
where U: From<T>,

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

impl<T> Ungil for T
where T: Send,