Struct WorkerHandle 

pub struct WorkerHandle { /* private fields */ }

Handle to a worker registered on a SharedRuntime.

This handle can be used to stop the worker.

Warning

If every clone of this handle is dropped without calling WorkerHandle::stop, the worker remains registered on the SharedRuntime and can only be torn down by shutting the runtime down. Workers are expected to detect that their input channel has been closed and park themselves to avoid spinning, but they will not be freed until the runtime stops.

Implementations

impl WorkerHandle

pub fn set_fork_restart( &self, restart_on_fork: bool, ) -> Result<(), WorkerHandleError>

Configure whether this worker restarts in a fork child.

When disabled, the next ForkSafeRuntime::after_fork_child call drops the worker without running its shutdown logic. Language runtimes can disable restart in a managed before-fork hook, restore it in the parent hook, and replace the inherited worker in the child.

Errors

Returns an error if the worker has already been stopped or dropped.

pub async fn stop(self) -> Result<(), WorkerHandleError>

Stop the worker and execute the shutdown logic.

Errors

Returns an error if the worker has already been stopped.

Cancel safety

This function is NOT cancel safe and shouldn’t be called in Worker::trigger. If cancelled, the stopped worker can end up in an invalid state if a fork occurs while stopping.

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.