[][src]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

Methods

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

pub fn ready(&self) -> bool[src]

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>[src]

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>[src]

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

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

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, C> Consumer<'a, T, N, u16, C> where
    N: ArrayLength<T>,
    C: XCore, 
[src]

pub fn ready(&self) -> bool[src]

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>[src]

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>[src]

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

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

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, C> Consumer<'a, T, N, usize, C> where
    N: ArrayLength<T>,
    C: XCore, 
[src]

pub fn ready(&self) -> bool[src]

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>[src]

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>[src]

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

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

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, C> Send for Consumer<'a, T, N, U, C> where
    N: ArrayLength<T>,
    T: Send,
    U: Uxx,
    C: XCore, 
[src]

Auto Trait Implementations

impl<'a, T, N, U, C> Unpin for Consumer<'a, T, N, U, C>

impl<'a, T, N, U = usize, C = MultiCore> !Sync for Consumer<'a, T, N, U, C>

Blanket Implementations

impl<T> From<T> for T[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

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

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Same<T> for T[src]

type Output = T

Should always be Self