Struct tokio::task::AbortHandle

pub struct AbortHandle { /* private fields */ }

Available on crate feature rt and tokio_unstable only.

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.

Note: This is an unstable API. The public API of this type may break in 1.x releases. See the documentation on unstable features for details.

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.

pub fn id(&self) -> Id

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

Note: This is an unstable API. The public API of this type may break in 1.x releases. See the documentation on unstable features for details.

Trait Implementations

impl Debug for AbortHandle

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

Formats the value using the given formatter.

impl Drop for AbortHandle

fn drop(&mut self)

Executes the destructor for this type.

impl RefUnwindSafe for AbortHandle

impl Send for AbortHandle

impl Sync for AbortHandle

impl UnwindSafe for AbortHandle