Struct TaskHandle

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

A handle to a spawned task

A TaskHandle can be awaited to wait for the completion of its associated task and get its result.

A TaskHandle detaches its task when dropped. This means the it can no longer be awaited, but the executor will still poll its task.

This is created by Executor::spawn and Executor::spawn_rc.

Implementations

impl<T> TaskHandle<T>

pub fn cancel(&self)

Cancel the task

Deletes the task from the executor so that it won’t be polled again.

If the handle is awaited after cancellation, it might still complete if the task was already finished before it was cancelled. However, the likelier outcomes is that it never completes.

pub fn is_finished(&self) -> bool

Check if this task is finished

If this returns true, the next poll call is guaranteed to return Poll::Ready.

pub fn is_cancelled(&self) -> bool

Check if this task has been cancelled

Trait Implementations

impl<T> Future for TaskHandle<T>

type Output = T

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.