Struct Consumer 

pub struct Consumer { /* private fields */ }

The consumer half of the ring buffer. Not Clone — enforces single-consumer.

Implementations

impl Consumer

pub fn pop(&self) -> Option<f32>

Pop the oldest sample from the buffer, or None if empty.

pub fn pop_slice(&self, buf: &mut [f32]) -> usize

Pop up to buf.len() samples into buf. Returns the number of samples read.

Examples

let (p, c) = rt_ring::new(4);
p.push_slice(&[10.0, 20.0, 30.0]);
let mut buf = [0.0f32; 4];
let n = c.pop_slice(&mut buf);
assert_eq!(n, 3);
assert_eq!(&buf[..n], &[10.0, 20.0, 30.0]);

pub fn available(&self) -> usize

Returns the number of samples currently available for reading.

Examples

let (p, c) = rt_ring::new(4);
assert_eq!(c.available(), 0);
p.push(1.0);
assert_eq!(c.available(), 1);

pub fn overwrite_count(&self) -> u64

Returns the total number of samples that were overwritten since creation.

Examples

let (p, c) = rt_ring::new(4);
for i in 0..10 {
    p.push(i as f32);
}
assert_eq!(c.overwrite_count(), 6);

pub fn capacity(&self) -> usize

Returns the buffer capacity (always a power of two).

Examples

let (_p, c) = rt_ring::new(3);
assert_eq!(c.capacity(), 4); // rounded up to next power of two