Struct RingBufferReader 

pub struct RingBufferReader<T> { /* private fields */ }

Reader handle of the ringbuffer.

Implementations

impl<T> RingBufferReader<T>

pub fn capacity(&self) -> usize

Returns the capacity (number of slots) of the ringbuffer.

pub fn pull(&mut self) -> Option<T>

Pull an element from the ringbuffer.

Returns Some(T) if an element is available, otherwise None when the buffer is empty.

Examples found in repository

examples/throughput.rs (line 18)

fn main() {
    static COUNTER: AtomicUsize = AtomicUsize::new(0);
    let (mut tx, mut rx) = ringbuffer::<usize>(2_usize.pow(10));

    std::thread::spawn(move || loop {
        if tx.push(1).is_some() {
            std::thread::yield_now();
        }
    });

    std::thread::spawn(move || loop {
        if rx.pull().is_some() {
            COUNTER.fetch_add(1, Ordering::Relaxed);
        } else {
            std::thread::yield_now();
        }
    });

    static STEP: Duration = Duration::from_secs(1);
    let start = Instant::now();
    for i in 1..=u32::MAX {
        std::thread::sleep(start + i * STEP - Instant::now());
        println!("{} elem/s", COUNTER.swap(0, Ordering::Relaxed));
    }
}

pub fn peek(&mut self) -> Option<&T>

Peek an element from the ringbuffer without pulling it out.

Returns Some(&T) when at lease one element is present, or None when the buffer is empty.

pub fn peek_mut(&mut self) -> Option<&mut T>

Peek a mutable element from the ringbuffer without pulling it out.

Returns Some(&mut T) when at lease one element is present, or None when the buffer is empty.

pub fn is_empty(&mut self) -> bool

Check if the ringbuffer is empty.

Trait Implementations

impl<T: Send> Send for RingBufferReader<T>

impl<T: Sync> Sync for RingBufferReader<T>