Struct vector::sinks::prelude::BatcherSettings

pub struct BatcherSettings {
    pub timeout: Duration,
    pub size_limit: usize,
    pub item_limit: usize,
}

Controls the behavior of the batcher in terms of batch size and flush interval.

This is a temporary solution for pushing in a fixed settings structure so we don’t have to worry about misordering parameters and what not. At some point, we will pull BatchConfig/BatchSettings/BatchSize out of vector and move them into vector_core, and make it more generalized. We can’t do that yet, though, until we’ve converted all of the sinks with their various specialized batch buffers.

Fields

timeout: Duration

size_limit: usize

item_limit: usize

Implementations

impl BatcherSettings

pub const fn new( timeout: Duration, size_limit: NonZero<usize>, item_limit: NonZero<usize>, ) -> BatcherSettings

pub fn as_byte_size_config<T>( &self, ) -> BatchConfigParts<SizeLimit<ByteSizeOfItemSize>, Vec<T>>

where T: ByteSizeOf,

A batcher config using the ByteSizeOf trait to determine batch sizes. The output is a Vec<T>.

pub fn as_item_size_config<T, I>( &self, item_size: I, ) -> BatchConfigParts<SizeLimit<I>, Vec<T>>

where I: ItemBatchSize<T>,

A batcher config using the ItemBatchSize trait to determine batch sizes. The output is a Vec<T>.

pub fn as_reducer_config<I, T, B>( &self, item_size: I, reducer: B, ) -> BatchConfigParts<SizeLimit<I>, B>

where I: ItemBatchSize<T>, B: BatchData<T>,

A batcher config using the ItemBatchSize trait to determine batch sizes. The output is built with the supplied object implementing BatchData.

Trait Implementations

impl Clone for BatcherSettings

fn clone(&self) -> BatcherSettings

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BatcherSettings

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

Formats the value using the given formatter.

impl Copy for BatcherSettings