Struct rustasim::spsc::Producer

pub struct Producer<T> { /* fields omitted */ }

The producer side of a bounded single-producer single-consumer queue.

Examples

use rustasim::{spsc, PushError};

let (p, c) = spsc::new::<i32>(1);

assert_eq!(p.push(10), Ok(()));
assert_eq!(p.push(20), Err(PushError(20)));

assert!(!p.is_empty());
assert!(p.is_full());

Implementations

impl<T> Producer<T>

pub fn push(&self, value: T) -> Result<(), PushError<T>>

Attempts to push an element into the queue.

If the queue is full, the element is returned back as an error.

Examples

use rustasim::{spsc, PushError};

let (p, c) = spsc::new(1);

assert_eq!(p.push(10), Ok(()));
assert_eq!(p.push(20), Err(PushError(20)));

pub fn capacity(&self) -> usize

Returns the capacity of the queue.

Examples

use rustasim::spsc;

let (p, c) = spsc::new::<i32>(100);

assert_eq!(p.capacity(), 100);

pub fn is_empty(&self) -> bool

Returns true if the queue is empty.

Examples

use rustasim::spsc;

let (p, c) = spsc::new(100);

assert!(p.is_empty());
p.push(1).unwrap();
assert!(!p.is_empty());

pub fn is_full(&self) -> bool

Returns true if the queue is full.

Examples

use rustasim::spsc;

let (p, c) = spsc::new(1);

assert!(!p.is_full());
p.push(1).unwrap();
assert!(p.is_full());

pub fn len(&self) -> usize

Returns the number of elements in the queue.

Examples

use rustasim::spsc;

let (p, c) = spsc::new(100);
assert_eq!(p.len(), 0);

p.push(10).unwrap();
assert_eq!(p.len(), 1);

p.push(20).unwrap();
assert_eq!(p.len(), 2);

Trait Implementations

impl<T> Debug for Producer<T>

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

Formats the value using the given formatter.

impl<T: Send> Send for Producer<T>