Struct heapless::spsc::Consumer

source ·
pub struct Consumer<'a, T, const N: usize> { /* private fields */ }
Expand description

A queue “consumer”; it can dequeue items from the queue NOTE the consumer semantically owns the head pointer of the queue

Implementations§

source§

impl<'a, T, const N: usize> Consumer<'a, T, N>

source

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

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

source

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

See Queue::dequeue_unchecked for safety

source

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

source

pub fn len(&self) -> usize

Returns the number of elements in the queue

source

pub fn capacity(&self) -> usize

Returns the maximum number of elements the queue can hold

source

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§

source§

impl<'a, T, const N: usize> Send for Consumer<'a, T, N>
where T: Send,

Auto Trait Implementations§

§

impl<'a, T, const N: usize> !RefUnwindSafe for Consumer<'a, T, N>

§

impl<'a, T, const N: usize> !Sync for Consumer<'a, T, N>

§

impl<'a, T, const N: usize> Unpin for Consumer<'a, T, N>

§

impl<'a, T, const N: usize> !UnwindSafe for Consumer<'a, T, N>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.