Struct heapless::spsc::Consumer

pub struct Consumer<'a, T, N, U = usize, C = MultiCore> where
    N: ArrayLength<T>,
    U: Uxx,
    C: XCore,  { /* fields omitted */ }

A queue “consumer”; it can dequeue items from the queue

Implementations

impl<'a, T, N, C> Consumer<'a, T, N, u8, C> where
    N: ArrayLength<T>,
    C: XCore, 

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 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;
use heapless::consts::*;

let mut queue: Queue<u8, U235, _> = Queue::u8();
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());

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 it’s empty

Unsafety

If the queue is empty this is equivalent to calling mem::uninitialized

pub fn capacity(&self) -> u8

Returns the maximum number of elements the queue can hold

pub fn len(&self) -> u8

Returns the number of elements in the queue

Note

This is a conservative estimate. Interrupt during this function might cause that the Consumer actually has more than N items available.

impl<'a, T, N, C> Consumer<'a, T, N, u16, C> where
    N: ArrayLength<T>,
    C: XCore, 

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 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;
use heapless::consts::*;

let mut queue: Queue<u8, U235, _> = Queue::u8();
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());

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 it’s empty

Unsafety

If the queue is empty this is equivalent to calling mem::uninitialized

pub fn capacity(&self) -> u16

Returns the maximum number of elements the queue can hold

pub fn len(&self) -> u16

Returns the number of elements in the queue

Note

This is a conservative estimate. Interrupt during this function might cause that the Consumer actually has more than N items available.

impl<'a, T, N, C> Consumer<'a, T, N, usize, C> where
    N: ArrayLength<T>,
    C: XCore, 

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 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;
use heapless::consts::*;

let mut queue: Queue<u8, U235, _> = Queue::u8();
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());

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 it’s empty

Unsafety

If the queue is empty this is equivalent to calling mem::uninitialized

pub fn capacity(&self) -> usize

Returns the maximum number of elements the queue can hold

pub fn len(&self) -> usize

Returns the number of elements in the queue

Note

This is a conservative estimate. Interrupt during this function might cause that the Consumer actually has more than N items available.

Trait Implementations

impl<'a, T, N, U, C> Send for Consumer<'a, T, N, U, C> where
    N: ArrayLength<T>,
    T: Send,
    U: Uxx,
    C: XCore,