Struct WorkerHandle 

pub struct WorkerHandle { /* private fields */ }

Handle to a running worker task.

Cheap to clone — internally Arc’d so multiple call sites can hold references. Dropping the last clone does NOT trigger shutdown; callers should explicitly invoke Self::shutdown on graceful-stop paths.

Implementations

impl WorkerHandle

pub fn is_shutting_down(&self) -> bool

Returns true if the worker has been signaled to stop.

pub fn cancellation_token(&self) -> CancellationToken

Returns a child CancellationToken tied to the worker’s lifecycle.

Child tokens are cancelled when the worker itself is shut down. Useful when downstream subtasks want to share the same shutdown semantics.

CancellationToken is leaked here from tokio-util deliberately: it is the de-facto-standard cooperative cancellation primitive in the tokio ecosystem, and exposing it gives consumers direct interoperability with the rest of their async code.

pub async fn shutdown(&self)

Signals the worker to stop and waits for it to drain.

The worker finishes its current job (if any), declines to claim a new one, and exits. If the drain timeout elapses first, the task is aborted and any in-flight claim leaks until the lease expires.

Calling shutdown more than once is safe — subsequent calls observe the already-shut-down state and return immediately.

pub async fn abort(&self)

Aborts the worker task without waiting for graceful drain.

In-flight claims leak until their lease expires. Prefer Self::shutdown except in emergency shutdown paths.

Trait Implementations

impl Clone for WorkerHandle

fn clone(&self) -> WorkerHandle

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WorkerHandle

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

Formats the value using the given formatter.