# [−] [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

## Implementations

### `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`

#### `pub fn capacity(&self) -> u8` [src]

Returns the maximum number of elements the queue can hold

#### `pub fn len(&self) -> u8` [src]

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,` [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`

#### `pub fn capacity(&self) -> u16` [src]

Returns the maximum number of elements the queue can hold

#### `pub fn len(&self) -> u16` [src]

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,` [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`

#### `pub fn capacity(&self) -> usize` [src]

Returns the maximum number of elements the queue can hold

#### `pub fn len(&self) -> usize` [src]

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

## Auto Trait Implementations

### `impl<'a, T, N, U = usize, C = MultiCore> !Sync for Consumer<'a, T, N, U, C>` [src]

### `impl<'a, T, N, U, C> Unpin for Consumer<'a, T, N, U, C>` [src]

## Blanket Implementations

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

#### `pub fn type_id(&self) -> TypeId` [src]

Gets the `TypeId` of `self`. Read more

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

#### `pub fn borrow(&self) -> &T` [src]

Immutably borrows from an owned value. Read more

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

#### `pub fn borrow_mut(&mut self) -> &mut T` [src]

Mutably borrows from an owned value. Read more

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

#### `pub fn from(t: T) -> T` [src]

Performs the conversion.

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

#### `pub fn into(self) -> U` [src]

Performs the conversion.

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

#### `type Output = T`

Should always be `Self`

### `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.

#### `pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>` [src]

Performs the conversion.

### `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.

#### `pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>` [src]

Performs the conversion.