Struct RingBufferWriter

pub struct RingBufferWriter<T, const N: usize> { /* private fields */ }

Implementations

impl<T, const N: usize> RingBufferWriter<T, N>

pub fn push(&mut self, t: T) -> Option<T>

Push an element into the RingBuffer. It returns Some(T) if the RingBuffer is full, giving back the ownership of T.

Examples found in repository

examples/throughput.rs (line 13)

fn main() {
    let (mut tx, mut rx) = RingBuffer::<usize, 16>::init();
    let counter = Arc::new(AtomicUsize::new(0));

    std::thread::spawn(move || {
        let mut current: usize = 0;
        loop {
            if tx.push(current).is_none() {
                current = current.wrapping_add(1);
            } else {
                std::thread::yield_now();
            }
        }
    });

    let c_counter = counter.clone();
    std::thread::spawn(move || {
        let mut current: usize = 0;
        loop {
            if let Some(c) = rx.pull() {
                assert_eq!(c, current);
                current = current.wrapping_add(1);
                c_counter.fetch_add(1, Ordering::Relaxed);
            } else {
                std::thread::yield_now();
            }
        }
    });

    loop {
        std::thread::sleep(Duration::from_secs(1));
        println!("{} elem/s", counter.swap(0, Ordering::Relaxed));
    }
}

pub fn is_full(&mut self) -> bool

Check if the RingBuffer is full and evenutally updates the internal cached indexes.

Trait Implementations

impl<T: Send, const N: usize> Send for RingBufferWriter<T, N>

impl<T: Sync, const N: usize> Sync for RingBufferWriter<T, N>