Struct heapless::ring_buffer::Consumer

pub struct Consumer<'a, T, N, U = usize> where
    N: Add<U1> + Unsigned,
    Sum<N, U1>: ArrayLength<T>,
    U: Uxx,  { /* fields omitted */ }

A ring buffer "consumer"; it can dequeue items from the ring buffer

Methods

impl<'a, T, N> Consumer<'a, T, N, u8> where     N: Add<U1> + Unsigned,     Sum<N, U1>: ArrayLength<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 it's empty

Unsafety

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

impl<'a, T, N> Consumer<'a, T, N, u16> where     N: Add<U1> + Unsigned,     Sum<N, U1>: ArrayLength<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 it's empty

Unsafety

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

impl<'a, T, N> Consumer<'a, T, N, usize> where     N: Add<U1> + Unsigned,     Sum<N, U1>: ArrayLength<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 it's empty

Unsafety

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

Trait Implementations

impl<'a, T, N, U> Send for Consumer<'a, T, N, U> where     N: Add<U1> + Unsigned,     Sum<N, U1>: ArrayLength<T>,     T: Send,     U: Uxx,