Struct RingBuf

pub struct RingBuf { /* private fields */ }

A data structure that uses a single, fixed-size buffer as if it were connected end-to-end

Implementations

impl RingBuf

pub fn with_capacity(value: NonZeroUsize) -> Self

Create a new RingBuf object with provided capacity.

The provided capacity must be NonZeroUsize.

pub fn remaining(&self) -> usize

Returns the number of bytes can be read.

pub fn remaining_mut(&self) -> usize

Returns the number of bytes that can be written from the current position until the end of the buffer is reached.

pub fn chunk_mut(&mut self) -> &mut [u8]

Returns a mutable slice starting at the write pointer, the length may shorter than remaining_mut.

pub fn chunk(&self) -> &[u8]

Returns a immutable slice starting at the read pointer, the length may shorter than remaining.

pub fn advance_mut(&mut self, offset: usize)

Advance the innner write cursor of this RingBuf.

if the offset value > remaining_mut will cause an panic.

pub fn advance(&mut self, offset: usize)

Advance the innner read cursor of this RingBuf.

if the offset value > remaining will cause an panic.

pub fn write(&mut self, buf: &[u8]) -> usize

Write data into ring buf.

Returns the number of written bytes. the number of written bytes returned can be shorter than the length of the input buffer when the ring buf doesn’t have enough capacity.

pub fn read(&mut self, buf: &mut [u8]) -> usize

Read data from RingBuf and copy to provided mutable slice.

Returns the number of read bytes.