Struct TokioTaskHandle 

pub struct TokioTaskHandle<R, E> { /* private fields */ }

Async handle returned by Tokio-backed executor services.

Awaiting this handle reports the accepted task’s final result, including task failure, panic, or cancellation.

Type Parameters

• R - The task success value.
• E - The task error value.

Implementations

impl<R, E> TokioTaskHandle<R, E>

pub fn cancel(&self) -> bool

Requests cancellation of the underlying Tokio task.

For blocking tasks submitted through spawn_blocking, Tokio can prevent execution only if the task has not started yet. Already running blocking work continues until the closure returns.

Returns

true after cancellation has been requested.

pub fn is_done(&self) -> bool

Returns whether the underlying Tokio task has finished.

Returns

true if the Tokio task is complete.

Trait Implementations

impl<R, E> Future for TokioTaskHandle<R, E>

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

Polls the underlying Tokio task.

Parameters

• cx - Async task context used to register the current waker.

Returns

Poll::Ready with the task result when the Tokio task completes, or Poll::Pending while it is still running. Tokio cancellation and panic join errors are converted to TaskExecutionError values.

type Output = Result<R, TaskExecutionError<E>>

The type of value produced on completion.