Struct WorkerHandle 

pub struct WorkerHandle<B> { /* private fields */ }

A cloneable handle for interacting with a running PooledWorker.

Obtained from PooledWorker::spawn. The handle is cheap to clone and can be shared across tasks. Dropping all handles triggers a graceful shutdown of the worker (equivalent to calling shutdown).

Implementations

impl<B> WorkerHandle<B>

pub fn shutdown(&self)

Request a graceful shutdown of the worker.

The worker will finish its current task (if any) and then exit. This is a non-async, fire-and-forget operation — errors are ignored (the actor may have already stopped).

pub async fn join(&self) -> Result<(), RuntimeError>

Wait for the worker task to finish.

The first caller gets the real result; subsequent callers get Ok(()).

Errors

Returns an error if the worker task panicked or returned an error.

pub fn backend(&self) -> &Arc<B>

Get a reference to the backend.

impl<B: SignalStore> WorkerHandle<B>

pub async fn cancel_workflow( &self, instance_id: &str, reason: Option<String>, cancelled_by: Option<String>, ) -> Result<(), RuntimeError>

Request cancellation of a workflow.

This stores a cancel signal directly in the backend. The worker will pick it up at the next guard check (task boundary).

Errors

Returns an error if the signal cannot be stored (workflow not found or in terminal state).

pub async fn pause_workflow( &self, instance_id: &str, reason: Option<String>, paused_by: Option<String>, ) -> Result<(), RuntimeError>

Request pausing of a workflow.

This stores a pause signal directly in the backend. The worker will pick it up at the next guard check (task boundary).

Errors

Returns an error if the signal cannot be stored (workflow not found or in terminal/paused state).

Trait Implementations

impl<B> Clone for WorkerHandle<B>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.