Struct JoinHandle 

pub struct JoinHandle { /* private fields */ }

A handle to a spawned task, allowing individual cancellation.

Created by TaskScope::spawn and TaskScope::spawn_with_priority. Dropping the handle does not cancel the task — call cancel explicitly, or drop the owning TaskScope to cancel all tasks at once.

Implementations

impl JoinHandle

pub fn cancel(&self)

Cancel this specific task.

Cancellation drops the task’s Future on the next executor flush — it is cooperative (.await-bound), same as all async cancellation in Rust.

No-op if the task has already completed or was spawned into an already-cancelled scope.

pub fn is_finished(&self) -> bool

Return true if the task has completed (normally or via cancellation).

Returns true for handles created by spawning into an already-cancelled scope (they never had a real task).

pub fn task_id(&self) -> Option<u64>

Return the id of the wrapped task, or None if the handle was created by spawning into an already-cancelled scope.

Trait Implementations

impl Debug for JoinHandle

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

Formats the value using the given formatter.