Struct RingBuffer 

pub struct RingBuffer<T: Send + Sized + 'static> { /* private fields */ }

Ring buffer itself.

Implementations

impl<T: Send + Sized + 'static> RingBuffer<T>

pub fn new(capacity: usize) -> Self

Creates a new instance of a ring buffer.

Examples found in repository

examples/simple.rs (line 9)

fn main() {
    let collector = Collector::new();

    let rb = RingBuffer::<i32>::new(2);
    let (mut prod, mut cons) = rb.split(&collector.handle());

    prod.push(0).unwrap();
    prod.push(1).unwrap();
    assert_eq!(prod.push(2), Err(2));

    assert_eq!(cons.pop().unwrap(), 0);

    prod.push(2).unwrap();

    assert_eq!(cons.pop().unwrap(), 1);
    assert_eq!(cons.pop().unwrap(), 2);
    assert_eq!(cons.pop(), None);
}

examples/message.rs (line 13)

fn main() {
    let collector = Collector::new();

    let buf = RingBuffer::<u8>::new(10);
    let (mut prod, mut cons) = buf.split(&collector.handle());

    let smsg = "The quick brown fox jumps over the lazy dog";

    let pjh = thread::spawn(move || {
        println!("-> sending message: '{}'", smsg);

        let zero = [0];
        let mut bytes = smsg.as_bytes().chain(&zero[..]);
        loop {
            if prod.is_full() {
                println!("-> buffer is full, waiting");
                thread::sleep(Duration::from_millis(1));
            } else {
                let n = prod.read_from(&mut bytes, None).unwrap();
                if n == 0 {
                    break;
                }
                println!("-> {} bytes sent", n);
            }
        }

        println!("-> message sent");
    });

    let cjh = thread::spawn(move || {
        println!("<- receiving message");

        let mut bytes = Vec::<u8>::new();
        loop {
            if cons.is_empty() {
                if bytes.ends_with(&[0]) {
                    break;
                } else {
                    println!("<- buffer is empty, waiting");
                    thread::sleep(Duration::from_millis(1));
                }
            } else {
                let n = cons.write_into(&mut bytes, None).unwrap();
                println!("<- {} bytes received", n);
            }
        }

        assert_eq!(bytes.pop().unwrap(), 0);
        let msg = String::from_utf8(bytes).unwrap();
        println!("<- message received: '{}'", msg);

        msg
    });

    pjh.join().unwrap();
    let rmsg = cjh.join().unwrap();

    assert_eq!(smsg, rmsg);
}

pub fn split(self, handle: &Handle) -> (Producer<T>, Consumer<T>)

Splits ring buffer into producer and consumer.

Examples found in repository

examples/simple.rs (line 10)

fn main() {
    let collector = Collector::new();

    let rb = RingBuffer::<i32>::new(2);
    let (mut prod, mut cons) = rb.split(&collector.handle());

    prod.push(0).unwrap();
    prod.push(1).unwrap();
    assert_eq!(prod.push(2), Err(2));

    assert_eq!(cons.pop().unwrap(), 0);

    prod.push(2).unwrap();

    assert_eq!(cons.pop().unwrap(), 1);
    assert_eq!(cons.pop().unwrap(), 2);
    assert_eq!(cons.pop(), None);
}

examples/message.rs (line 14)

fn main() {
    let collector = Collector::new();

    let buf = RingBuffer::<u8>::new(10);
    let (mut prod, mut cons) = buf.split(&collector.handle());

    let smsg = "The quick brown fox jumps over the lazy dog";

    let pjh = thread::spawn(move || {
        println!("-> sending message: '{}'", smsg);

        let zero = [0];
        let mut bytes = smsg.as_bytes().chain(&zero[..]);
        loop {
            if prod.is_full() {
                println!("-> buffer is full, waiting");
                thread::sleep(Duration::from_millis(1));
            } else {
                let n = prod.read_from(&mut bytes, None).unwrap();
                if n == 0 {
                    break;
                }
                println!("-> {} bytes sent", n);
            }
        }

        println!("-> message sent");
    });

    let cjh = thread::spawn(move || {
        println!("<- receiving message");

        let mut bytes = Vec::<u8>::new();
        loop {
            if cons.is_empty() {
                if bytes.ends_with(&[0]) {
                    break;
                } else {
                    println!("<- buffer is empty, waiting");
                    thread::sleep(Duration::from_millis(1));
                }
            } else {
                let n = cons.write_into(&mut bytes, None).unwrap();
                println!("<- {} bytes received", n);
            }
        }

        assert_eq!(bytes.pop().unwrap(), 0);
        let msg = String::from_utf8(bytes).unwrap();
        println!("<- message received: '{}'", msg);

        msg
    });

    pjh.join().unwrap();
    let rmsg = cjh.join().unwrap();

    assert_eq!(smsg, rmsg);
}

pub fn capacity(&self) -> usize

Returns capacity of the ring buffer.

pub fn is_empty(&self) -> bool

Checks if the ring buffer is empty.

pub fn is_full(&self) -> bool

Checks if the ring buffer is full.

pub fn len(&self) -> usize

The length of the data in the buffer.

pub fn remaining(&self) -> usize

The remaining space in the buffer.

Trait Implementations

impl<T: Send + Sized + 'static> Drop for RingBuffer<T>

fn drop(&mut self)

Executes the destructor for this type.