Struct heapless::spsc::Producer

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

A queue “producer”; it can enqueue items into the queue

Implementations

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

pub fn ready(&self) -> bool

Returns if there is any space to enqueue a new item. When this returns true, at least the first subsequent enqueue will succeed.

pub fn enqueue(&mut self, item: T) -> Result<(), T>

Adds an item to the end of the queue

Returns back the item if the queue is full

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 Producer actually has more than N items of available space.

pub unsafe fn enqueue_unchecked(&mut self, item: T)

Adds an item to the end of the queue without checking if it’s full

Unsafety

If the queue is full this operation will leak a value (T’s destructor won’t run on the value that got overwritten by item), and will allow the dequeue operation to create a copy of item, which could result in T’s destructor running on item twice.

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

pub fn ready(&self) -> bool

Returns if there is any space to enqueue a new item. When this returns true, at least the first subsequent enqueue will succeed.

pub fn enqueue(&mut self, item: T) -> Result<(), T>

Adds an item to the end of the queue

Returns back the item if the queue is full

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 Producer actually has more than N items of available space.

pub unsafe fn enqueue_unchecked(&mut self, item: T)

Adds an item to the end of the queue without checking if it’s full

Unsafety

If the queue is full this operation will leak a value (T’s destructor won’t run on the value that got overwritten by item), and will allow the dequeue operation to create a copy of item, which could result in T’s destructor running on item twice.

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

pub fn ready(&self) -> bool

Returns if there is any space to enqueue a new item. When this returns true, at least the first subsequent enqueue will succeed.

pub fn enqueue(&mut self, item: T) -> Result<(), T>

Adds an item to the end of the queue

Returns back the item if the queue is full

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 Producer actually has more than N items of available space.

pub unsafe fn enqueue_unchecked(&mut self, item: T)

Adds an item to the end of the queue without checking if it’s full

Unsafety

If the queue is full this operation will leak a value (T’s destructor won’t run on the value that got overwritten by item), and will allow the dequeue operation to create a copy of item, which could result in T’s destructor running on item twice.

Trait Implementations

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