Struct Producer 

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

A producer for the FastQueue. This is used to send elements to the queue.

Implementations

impl<T> Producer<T>

A producer for the FastQueue. This is used to send elements to the queue.

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

Pushes a value into the queue. Returns Ok(()) on success or Err(T) if the queue is full.

Example

use fq::FastQueue;
let (mut producer, mut consumer) = FastQueue::new(2);
producer.push(42).unwrap();
assert_eq!(consumer.pop(), Some(42));

pub fn len(&self) -> usize

Returns the current number of elements in the queue (may be stale)

This function may return stale data when holding a lock on the queue.

Example

use fq::FastQueue;
let (mut producer, mut consumer) = FastQueue::new(2);
assert_eq!(consumer.len(), 0);
producer.push(42).unwrap();
assert_eq!(consumer.len(), 1);

pub fn is_empty(&self) -> bool

Checks if the queue is empty (may be stale). This function will return true if the queue is empty, and false otherwise.

This function will return stale data when holding a lock on the queue.

Example

use fq::FastQueue;
let (mut producer, mut consumer) = FastQueue::new(2);
assert!(consumer.is_empty());
producer.push(42).unwrap();
assert!(!consumer.is_empty());

pub fn is_full(&self) -> bool

Checks if the queue is full (may be stale). This function will return true if the queue is full, and false otherwise.

Example

use fq::FastQueue;
let (mut producer, mut consumer) = FastQueue::<usize>::new(2);
producer.push(42).unwrap(); // ⚠️ Prefer handling the error over using unwrap()
assert_eq!(producer.is_full(), false);
producer.push(43).unwrap();
assert_eq!(producer.is_full(), true);

Trait Implementations

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