Struct vector_stream::batcher::limiter::SizeLimit

pub struct SizeLimit<I> {
    pub batch_size_limit: usize,
    pub batch_item_limit: usize,
    pub current_size: usize,
    pub item_size_calculator: I,
}

Fields

batch_size_limit: usize

The total “size” of all items in a batch. Size is intentionally vague here since it is user defined, and can vary.

To ensure any individual event can be placed in a batch, the first element in a batch is not subject to this limit.

batch_item_limit: usize

Total number of items that will be placed in a single batch.

To ensure any individual event can be placed in a batch, the first element in a batch is not subject to this limit.

current_size: usize

item_size_calculator: I

Trait Implementations

impl<T, B, I> BatchLimiter<T, B> for SizeLimit<I>

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

type ItemMetadata = usize

fn is_batch_full(&self, batch: &B) -> bool

Return true if it is not possible for another item to fit in the batch

fn item_fits_in_batch(&self, item: &T, batch: &B) -> (bool, Self::ItemMetadata)

It is safe to assume that is_batch_full would return false before this is called. You can return arbitrary metadata for an item that will be given back when the item is actually pushed onto the batch. This is useful if there is an expensive calculation to determine the “size” of the item.

fn push_item(&mut self, item_size: usize)

Add a single item to the batch using the metadata that was calculated by item_fits_in_batch

fn reset(&mut self)

Reset internal state from a batch being taken.