Struct Batch

pub struct Batch<'a> { /* private fields */ }

Represents pending batch of messages between last observed producer position and the reader current position. Should be used in conjunction with BatchIter to allow iteration.

Implementations

impl Batch<'_>

pub const fn remaining(&self) -> usize

Return the number of remaining bytes to be consumed by this instance of batch.

pub fn receive_next(&mut self) -> Option<Result<Message>>

Receive next message from the current batch or None if end of batch. This is a low level method that will also return padding frames. Use into_iter() to work with more user-friendly BatchIter.

Trait Implementations

impl<'a> IntoIterator for Batch<'a>

type Item = <BatchIter<'a> as Iterator>::Item

The type of the elements being iterated over.

type IntoIter = BatchIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.