Struct Batcher 

pub struct Batcher<P: Processor> { /* private fields */ }

Groups items to be processed in batches.

Takes inputs one at a time and sends them to a background worker task which groups them into batches according to the specified BatchingPolicy and Limits, and processes them using the provided Processor.

Cheap to clone. Cloned instances share the same background worker task.

Drop

When the last instance of a Batcher is dropped, the worker task will be aborted (ungracefully shut down).

If you want to shut down the worker gracefully, call WorkerHandle::shut_down().

Implementations

impl<P: Processor> Batcher<P>

pub async fn add( &self, key: P::Key, input: P::Input, ) -> BatchResult<P::Output, P::Error>

Add an item to be batched and processed, and await the result.

pub fn worker_handle(&self) -> Arc<WorkerHandle>

Get a handle to the worker.

pub fn builder<I1>() -> BatcherBuilder<P, I1>

where I1: Into<String>,

Create a new batcher.

Notes

If batching_policy is Balanced { min_size_hint } where min_size_hint is greater than limits.max_batch_size, the min_size_hint will be clamped to max_batch_size.

Trait Implementations

impl<P: Processor> Clone for Batcher<P>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<P: Debug + Processor> Debug for Batcher<P>

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

Formats the value using the given formatter.