Producer

Struct Producer 

Source
pub struct Producer<'a, T> { /* private fields */ }
Expand description

A producer; it can enqueue items into the queue.

Note: The producer semantically owns the tail pointer of the queue.

Implementations§

Source§

impl<T> Producer<'_, T>

Source

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.

Source

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

Adds an item to the end of the queue, without checking if the queue is full.

§Safety

See Queue::enqueue_unchecked.

Source

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.

Source

pub fn len(&self) -> usize

Returns the number of elements in the queue.

Source

pub fn is_empty(&self) -> bool

Returns whether 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!(producer.is_empty());
Source

pub fn capacity(&self) -> usize

Returns the maximum number of elements the queue can hold.

Trait Implementations§

Source§

impl<T> Send for Producer<'_, T>
where T: Send,

Auto Trait Implementations§

§

impl<'a, T> Freeze for Producer<'a, T>

§

impl<'a, T> !RefUnwindSafe for Producer<'a, T>

§

impl<'a, T> !Sync for Producer<'a, T>

§

impl<'a, T> Unpin for Producer<'a, T>

§

impl<'a, T> !UnwindSafe for Producer<'a, T>

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

Source§

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

Source§

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.