Struct TaskHandle 

pub struct TaskHandle<T> { /* private fields */ }

An owned tokio task, aborted when the handle drops.

Dropping the handle requests cancellation and returns at once: the task’s future is dropped at its next yield point, possibly after the drop returns. A task blocking its thread, never yielding, is not stopped.

Awaiting the handle yields the task’s output, or a JoinError when the task panicked or was aborted. The await is cancel safe: polling stops without losing the output, and the handle can be awaited again.

Implementations

impl<T> TaskHandle<T>

pub fn abort(&self)

Request cancellation of the task, as dropping the handle does.

pub fn is_finished(&self) -> bool

Whether the task has ended, by returning, panicking or being aborted.

pub fn detach(self)

Let the task run on with no owner.

It then ends only when its future returns or its runtime shuts down. A panic in it is still logged.

Trait Implementations

impl<T> Debug for TaskHandle<T>

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

Formats the value using the given formatter.

impl<T> Drop for TaskHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> Future for TaskHandle<T>

type Output = Result<T, JoinError>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.