Struct TaskGuard 

pub struct TaskGuard { /* private fields */ }

RAII owner for a spawned tokio task.

Dropping the guard aborts the task. Await or release the handle with Self::disarm when the task must outlive the current scope.

Implementations

impl TaskGuard

pub fn new(handle: JoinHandle<()>) -> Self

Own a spawned task with a default label.

pub fn with_label(handle: JoinHandle<()>, label: &'static str) -> Self

Own a spawned task with a static label used for debugging.

pub fn disarm(&mut self) -> Option<JoinHandle<()>>

Release the handle without aborting, for documented-detached handoff.

Returns None only if the guard was already disarmed.

pub fn is_finished(&self) -> bool

Whether the owned task has finished.

Returns false once the guard is disarmed (no handle held), since the task is no longer owned by this guard.

pub fn label(&self) -> &'static str

Static label identifying the owned task.

Trait Implementations

impl Debug for TaskGuard

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

Formats the value using the given formatter.

impl Drop for TaskGuard

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.