Struct Consumer 

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

A consumer; it can dequeue items from the queue.

Note: The consumer semantically owns the head pointer of the queue.

Implementations

impl<T> Consumer<'_, T>

pub fn dequeue(&mut self) -> Option<T>

Returns the item in the front of the queue, or None if the queue is empty.

pub unsafe fn dequeue_unchecked(&mut self) -> T

Returns the item in the front of the queue, without checking if there are elements in the queue.

Safety

See Queue::dequeue_unchecked.

pub fn ready(&self) -> bool

Returns if there are any items to dequeue. When this returns true, at least the first subsequent dequeue 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!(consumer.is_empty());

pub fn capacity(&self) -> usize

Returns the maximum number of elements the queue can hold.

pub fn peek(&self) -> Option<&T>

Returns the item in the front of the queue without dequeuing, or None if 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_eq!(None, consumer.peek());
producer.enqueue(1);
assert_eq!(Some(&1), consumer.peek());
assert_eq!(Some(1), consumer.dequeue());
assert_eq!(None, consumer.peek());

Trait Implementations

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

where T: Send,