Struct multistream_batch::multi_buf_batch::MultiBufBatch

pub struct MultiBufBatch<K: Debug + Ord + Hash, I: Debug> { /* fields omitted */ }

Collects items into multiple batches based on stream key. A batch may become ready after collecting max_size number of items or until max_duration has elapsed since first item was appended to the batch.

Batch item buffers are cached and reused to avoid allocations.

This base implementation does not handle actual awaiting for batch duration timeout.

Implementations

impl<K, I> MultiBufBatch<K, I> where
    K: Debug + Ord + Hash + Clone,
    I: Debug, 

pub fn new(max_size: usize, max_duration: Duration) -> MultiBufBatch<K, I>

Crates new instance with given maximum batch size (max_size) and maximum duration (max_duration) that batch can last since first item appended to it.

Panics if max_size == 0.

pub fn poll(&self) -> PollResult<K>

Checks if batch has reached one of its limits.

Returns:

• PollResult::Ready(K) - batch for stream key K has reached one of its limit and is ready to be consumed,
• PollResult::NotReady(None) - batch is not ready yet and has no items appeded yet,
• PollResult::NotReady(Some(duration)) - batch is not ready yet but it will be ready after time duration due to duration limit.

pub fn append(&mut self, key: K, item: I)

Appends item to batch with given stream key.

It is an contract error to append batch that is ready according to self.poll().

Panics if batch has already reached its max_size limit.

pub fn outstanding(&self) -> impl Iterator<Item = &K>

Lists keys of outstanding batches.

pub fn clear(&mut self, key: &K)

Starts new batch dropping all buffered items.

pub fn drain(&mut self, key: &K) -> Option<Drain<'_, I>>

Consumes batch by draining items from internal buffer.

pub fn flush(&mut self) -> Vec<(K, Vec<I>)>

Flushes all outstanding batches starting from oldest.

pub fn get(&self, key: &K) -> Option<&[I]>

Returns slice of internal item buffer of given outstanding batch.

pub fn clear_cache(&mut self)

Drops cached batch buffers.

pub fn stats(&self) -> Stats

Provides usage statistics.

Trait Implementations

impl<K: Debug + Ord + Hash, I: Debug> Debug for MultiBufBatch<K, I>

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

Formats the value using the given formatter.