Struct ProdEnd 

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

Producer endpoint for inserting data into the circular buffer. See ProdEnd::push() and ProdEnd::write().

Implementations

impl<T> ProdEnd<T>

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

Moves a single item of into the circular buffer. Returns None on success, Some<T> containing the item if the buffer was full.

Examples

use scbuf;

let (mut prod_ep, _) = scbuf::new_scbuf(1);
assert_eq!(prod_ep.push('a'), None);
assert_eq!(prod_ep.push('b'), Some('b'));

pub fn write(&mut self, data: &mut Drain<'_, T>)

Moves n elements from data into the buffer, where n is the minimum of data.len() and the space available in the buffer. Drain is used instead of Vec to avoid possibly unnecessary shift of items in the original vector, should it not be drained completely.

Examples

use scbuf;

let (mut prod_ep, _) = scbuf::new_scbuf(2);
let mut data = vec!['a', 'b', 'c'];
let mut drain = data.drain(..);

prod_ep.write(&mut drain);
// we can pop the leftover directly from `drain` without having it shifted
// into the first position of `data`
assert_eq!(drain.next(), Some('c'));