Struct Buffer 

pub struct Buffer<const N: usize> { /* private fields */ }

A lock-free ring buffer.

The buffer has a fixed capacity N which must be a power of two. It tracks the read and write positions using atomic counters.

Implementations

impl<const N: usize> Buffer<N>

pub const fn new() -> Self

Creates a new empty Buffer.

Panics

Panics if N is not a power of two.

pub fn producer(&self) -> Producer<'_, N>

Returns a producer handle for this buffer.

The producer handles writing data into the buffer.

Panics

Panics if a producer has already been created and not dropped.

pub fn consumer(&self) -> Consumer<'_, N>

Returns a consumer handle for this buffer.

The consumer handles reading data from the buffer.

Panics

Panics if a consumer has already been created and not dropped.

pub fn is_full(&self) -> bool

Returns true if the buffer is full.

pub fn is_empty(&self) -> bool

Returns true if the buffer is empty.

pub fn len(&self) -> usize

Returns the number of bytes currently in the buffer.

Trait Implementations

impl<const N: usize> Debug for Buffer<N>

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

Formats the value using the given formatter.

impl<const N: usize> Default for Buffer<N>

fn default() -> Self

Returns the “default value” for a type.

impl<const N: usize> Sync for Buffer<N>