Struct RingBuffer 

pub struct RingBuffer { /* private fields */ }

Chunked ring buffer.

A ring buffer which is logically split into chunks where each chunk is at least chunk_size. A transaction API is provided if the caller needs to make multiple writes that must not be split across chunks. Chunks are discarded in their entirety when needed to make space.

A smaller chunk size has the advantage of higher utilization of the space in the ring buffer in exchange for more memory used keeping track of chunk boundaries and more work done when discarding chunks. Conversely a larger chunk size means that utilization of the buffer space has higher variance, but less memory is needed and discards are less often. Users should choose a chunk size appropriate for their use case.

Implementations

impl RingBuffer

pub fn new(size: usize, chunk_size: usize) -> Self

Create a new chunked ring buffer.

The capacity of the buffer is set to the next multiple of chunk_size larger than or equal to size.

pub fn len(&self) -> usize

Compute the total number of bytes stored in the buffer.

pub fn get_view(&self) -> (&[u8], &[u8])

Return the data stored in the ring buffer as two byte slices.

pub fn start_transaction(&mut self) -> Transaction<'_>

Start a transaction that groups a series of writes.

pub fn write(&mut self, slice: &[u8]) -> Result<(), WriteTooLarge>

Writes slice to the buffer and records a chunk if it is large enough.

Trait Implementations

impl Debug for RingBuffer

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

Formats the value using the given formatter.