Struct WorkerHandle 

pub struct WorkerHandle { /* private fields */ }

A handle to the worker task.

Used for shutting down the worker and waiting for it to finish.

Implementations

impl WorkerHandle

pub async fn shut_down(&self)

Signal the worker to shut down after processing any in-flight batches.

New items are still accepted while shutting down, and the worker only shuts down once all keys are idle. This means shutdown may never complete if:

• new items keep being added, or
• a batch never meets its policy’s processing condition, e.g. when using the Size policy, a final partial batch may wait indefinitely for more items.

Stopping the flow of new items is expected to be handled by the caller, e.g. by shutting down the message handlers which add items before shutting down the batcher.

pub async fn wait_for_shutdown(&self)

Wait for the worker to finish.

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.