Struct TaskHandle 

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

A handle to a spawned task that provides both join functionality and cancellation control

TaskHandle wraps a JoinHandle and provides access to the task’s individual cancellation token. This allows fine-grained control over individual tasks while maintaining the familiar JoinHandle API.

Example

let handle = tracker.spawn(async {
    tokio::time::sleep(std::time::Duration::from_millis(100)).await;
    Ok(42)
});

// Access the task's cancellation token
let cancel_token = handle.cancellation_token();

// Can cancel the specific task
// cancel_token.cancel();

// Await the task like a normal JoinHandle
let result = handle.await?;
assert_eq!(result?, 42);

Implementations

impl<T> TaskHandle<T>

pub fn cancellation_token(&self) -> &CancellationToken

Get the cancellation token for this specific task

This token is a child of the tracker’s cancellation token and can be used to cancel just this individual task without affecting other tasks.

Example

let handle = tracker.spawn(async {
    tokio::time::sleep(std::time::Duration::from_secs(10)).await;
    Ok("completed")
});

// Cancel this specific task
handle.cancellation_token().cancel();

// Task will be cancelled
let result = handle.await?;
assert!(result.is_err());

pub fn abort(&self)

Abort the task associated with this handle

This is equivalent to calling JoinHandle::abort() and will cause the task to be cancelled immediately without running any cleanup code.

pub fn is_finished(&self) -> bool

Check if the task associated with this handle has finished

This is equivalent to calling JoinHandle::is_finished().

Trait Implementations

impl<T> Debug for TaskHandle<T>

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

Formats the value using the given formatter.

impl<T> Future for TaskHandle<T>

type Output = Result<Result<T, TaskError>, 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.