Struct RingBuffer 

pub struct RingBuffer<'m> {
    pub dropped_frames: u64,
    pub high_water_frames: usize,
    /* private fields */
}

A whole-frame byte ring over borrowed memory.

Fields

dropped_frames: u64

Frames refused or overwritten because the ring was full.

high_water_frames: usize

Most frames ever stored at once.

Implementations

impl<'m> RingBuffer<'m>

pub fn new(buf: &'m mut [u8], format: PcmFormat) -> Result<Self>

A ring over buf for frames of format. buf must hold at least one frame; a trailing partial frame is unused.

pub fn capacity_frames(&self) -> usize

Frames the ring can hold.

pub fn available_frames(&self) -> usize

Frames stored right now.

pub fn free_frames(&self) -> usize

Frames that can still be pushed without dropping.

pub fn is_empty(&self) -> bool

True when nothing is stored.

pub fn clear(&mut self)

Forget the contents (counters are kept).

pub fn push(&mut self, data: &[u8]) -> Result<()>

Append whole frames. When they do not all fit, nothing is stored, the frames count as dropped and Err(Busy) comes back — the producer keeps running and the drop is on the record.

pub fn push_overwrite(&mut self, data: &[u8]) -> Result<usize>

Append whole frames, discarding the oldest stored frames to make room. Returns how many frames were discarded (also added to dropped_frames). Use it when latency matters more than continuity.

pub fn pop(&mut self, out: &mut [u8]) -> usize

Move up to out.len() bytes of whole frames out; returns bytes moved (0 when the ring is empty).

pub fn pop_exact(&mut self, out: &mut [u8]) -> bool

Like pop but only when out.len() bytes are stored; otherwise nothing moves and false comes back. This is how a consumer waits for one whole block.

Trait Implementations

impl<'m> Debug for RingBuffer<'m>

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

Formats the value using the given formatter.