Struct multistream_batch::buf_batch::BufBatch

pub struct BufBatch<I: Debug> { /* fields omitted */ }

Batches items in internal buffer up to max_size items or until max_duration has elapsed since the first item appended to the batch.

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

Implementations

impl<I: Debug> BufBatch<I>

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

Creates batch given maximum batch size in the number of items stored (max_size) and maximum duration that batch can last (max_duration) since the first item appended to it.

Panics if max_size == 0.

pub fn poll(&self) -> PollResult

Checks if the batch has reached one of its limits.

Returns:

• PollResult::Ready - batch has reached one of its limits and is ready to be consumed,
• PollResult::NotReady(None) - batch is not ready yet and has no items appended 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, item: I) -> &I

Appends item to batch and returns a reference to that item.

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

Panics if the batch has already reached its max_size limit.

pub fn clear(&mut self)

Starts a new batch by dropping all buffered items.

pub fn drain(&mut self) -> Drain<I>

Starts a new batch by draining all buffered items.

pub fn pop(&mut self) -> Option<I>

Pops last item from internal buffer.

pub fn remove(&mut self, index: usize) -> I

Removes item from internal buffer at index.

Panics if index is out of bounds.

pub fn into_vec(self) -> Vec<I>

Converts into internal item buffer.

pub fn as_slice(&self) -> &[I]

Returns slice of internal item buffer.

Trait Implementations

impl<I: Debug> Debug for BufBatch<I>

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

Formats the value using the given formatter.