Struct Producer 

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

A producer; it can enqueue items into the queue.

Note: The producer semantically owns the tail pointer of the queue.

Implementations

impl<T> Producer<'_, T>

pub fn enqueue(&mut self, item: T) -> Result<(), T>

Adds an item to the end of the queue, returns back the item if the queue is full.

pub unsafe fn enqueue_unchecked(&mut self, item: T)

Adds an item to the end of the queue, without checking if the queue is full.

Safety

See Queue::enqueue_unchecked.

pub fn ready(&self) -> bool

Returns if there is any space to enqueue a new item. When this returns true, at least the first subsequent enqueue will succeed.

pub fn len(&self) -> usize

Returns the number of elements in the queue.

pub fn is_empty(&self) -> bool

Returns whether the queue is empty.

Examples

use heapless::spsc::Queue;

let mut queue: Queue<u8, 235> = Queue::new();
let (mut producer, mut consumer) = queue.split();
assert!(producer.is_empty());

pub fn capacity(&self) -> usize

Returns the maximum number of elements the queue can hold.

Trait Implementations

impl<T> Send for Producer<'_, T>

where T: Send,