Struct LockFreeRingBuffer 

pub struct LockFreeRingBuffer { /* private fields */ }

Single-producer single-consumer lock-free ring buffer for f32 samples.

Designed for real-time audio pipelines where one thread writes audio data (the audio callback or capture thread) and another thread reads it (the processing or playback thread).

Samples are stored as their u32 bit patterns in AtomicU32 cells so that the entire structure is Send + Sync without any unsafe code. The SPSC ring-buffer protocol using AtomicUsize head/tail indices ensures correct ordering between producer and consumer.

Capacity

The actual number of samples that can be buffered is capacity - 1. Choose a power-of-two capacity (e.g., 2048, 4096) for best performance.

Thread safety

Only one writer and one reader are supported. Using more than one writer or more than one reader concurrently results in incorrect data ordering.

Implementations

impl LockFreeRingBuffer

pub fn new(capacity: usize) -> Self

Create a new ring buffer that can hold up to capacity - 1 samples.

capacity should be a power of two for best performance. A minimum capacity of 2 is enforced.

pub fn capacity(&self) -> usize

Returns the total capacity of the buffer (number of samples that can ever be stored). The usable capacity is capacity() - 1.

pub fn available(&self) -> usize

Number of samples currently available for reading.

pub fn free(&self) -> usize

Number of free slots available for writing.

pub fn is_empty(&self) -> bool

Returns true when the buffer contains no readable samples.

pub fn is_full(&self) -> bool

Returns true when the buffer is full (cannot accept more writes).

pub fn write(&self, sample: f32) -> bool

Write a single sample.

Returns true when successful, false when the buffer is full.

Must only be called from the producer thread.

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

Read a single sample.

Returns Some(sample) when data is available, None when empty.

Must only be called from the consumer thread.

pub fn write_samples(&self, samples: &[f32]) -> usize

Write a block of samples.

Returns the number of samples actually written (may be less than samples.len() when the buffer does not have enough free space).

Must only be called from the producer thread.

pub fn read_samples(&self, dst: &mut [f32]) -> usize

Read samples into dst.

Returns the number of samples actually read (may be less than dst.len() when the buffer does not have enough data).

Must only be called from the consumer thread.

pub fn clear(&self)

Clear all samples from the buffer.

Must only be called when no concurrent reads/writes are in progress.

Trait Implementations

impl Debug for LockFreeRingBuffer

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

Formats the value using the given formatter.