Struct ultra_batch::BatcherBuilder

pub struct BatcherBuilder<F> where
    F: Fetcher + Send + Sync + 'static,  { /* private fields */ }

Used to configure a new Batcher. A BatcherBuilder is returned from Batcher::build.

Implementations

impl<F> BatcherBuilder<F> where
    F: Fetcher + Send + Sync + 'static, 

pub fn delay_duration(self, delay: Duration) -> Self

The maximum amount of time the Batcher will wait to queue up more keys before calling the Fetcher.

pub fn eager_batch_size(self, eager_batch_size: Option<usize>) -> Self

The maximum number of keys to wait for before eagerly calling the Fetcher. A value of Some(n) will load the batch once n or more keys have been queued (or once the timeout set by delay_duration is reached, whichever comes first). A value of None will never eagerly dispatch the queue, and the Batcher will always wait for the timeout set by delay_duration.

Note that eager_batch_size does not set an upper limit on the batch! For example, if Batcher::load_many is called with more than eager_batch_size items, then the batch will be sent immediately with all of the provided keys.

pub fn label(self, label: impl Into<String>) -> Self

Set a label for the Batcher. This is only used to improve diagnostic messages, such as logs.

pub fn finish(self) -> Batcher<F>

Create and return a Batcher with the given options.