Struct SpscRing 

pub struct SpscRing<T>(/* private fields */);

Wait-free single-producer single-consumer ring buffer for audio samples.

SpscRing::channel hands back the two halves, the way mpsc::channel does. Each half is Send but not Sync, so the “exactly one producer, exactly one consumer” rule that a ring like this depends on is enforced by the type system instead of by a comment: the producer moves to the capture thread, the consumer to the playback thread, and neither can be shared.

Backed by [rtrb] (the ring used across the Rust audio ecosystem): no allocation after construction, no locks, no unsafe in this crate.

use gemini_genai_rs::buffer::SpscRing;

let (mut tx, mut rx) = SpscRing::<i16>::channel(1024);
assert_eq!(tx.write(&[1, 2, 3]), 3);
let mut out = [0i16; 8];
assert_eq!(rx.read(&mut out), 3);
assert_eq!(&out[..3], &[1, 2, 3]);

Implementations

impl<T: Copy> SpscRing<T>

pub fn channel(capacity: usize) -> (SpscProducer<T>, SpscConsumer<T>)

Create a ring holding exactly capacity samples and split it into its producer and consumer halves.

Panics

Panics if capacity is 0.

Trait Implementations

impl<T: Debug> Debug for SpscRing<T>

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

Formats the value using the given formatter.