Struct RingBuffer

pub struct RingBuffer { /* private fields */ }

Single producer, many consumer (SPMC) ring buffer backed by shared memory.

Implementations

impl RingBuffer

pub fn new(bytes: &[u8]) -> Self

Create new RingBuffer by wrapping provided bytes. It is necessary to call into_writer() or into_reader() following the buffer construction to start using it.

pub fn into_writer(self) -> Writer

Will consume self and return instance of writer backed by this ring buffer. The writer will write from the beginning of the ring buffer. If you need to continue writing to the previous buffer use RingBuffer::join_writer instead.

pub fn join_writer(self) -> Writer

Will consume self and return instance of writer backed by this ring buffer. The writer will not reset current producer_position and will continue writing from that point.

pub fn into_writer_with_metadata<F: FnOnce(&mut [u8])>( self, metadata: F, ) -> Writer

Will consume self and return instance of writer backed by this ring buffer. This method also accepts closure to populate metadata buffer.

pub fn into_reader(self) -> Reader

Will consume self and return instance of reader backed by this ring buffer. The reader position will be set to producer most up-to-date position.

Trait Implementations

impl Clone for RingBuffer

fn clone(&self) -> RingBuffer

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for RingBuffer

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

Formats the value using the given formatter.

impl From<RingBuffer> for Writer

fn from(ring: RingBuffer) -> Self

Converts to this type from the input type.