Struct Reader

pub struct Reader { /* private fields */ }

Wraps RingBuffer and allows to receive messages. Multiple readers can be present at any time, they operate independently and are not part of any congestion control flow. As a result, each reader can be overrun by the producer if it’s unable to keep up.

Implementations

impl Reader

pub fn metadata(&self) -> &'static [u8]

Get metadata buffer associated with the underlying ring buffer.

pub fn with_initial_position(self, position: usize) -> Self

Set reader initial position (the default is producer current position).

pub fn reset(&self)

Reset reader position to current producer position, for recovering from overrun.

pub fn read_batch(&self) -> Option<Batch<'_>>

Construct Batch object that can efficiently read multiple messages in a batch between Reader current position and prevailing producer position. Returns None if there is no new data to read.

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

Receive next pending message from the ring buffer.