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

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

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

Adds an `item` to the end of the queue

Returns back the `item` if the queue is full

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

#### `pub unsafe fn enqueue_unchecked(&mut self, item: T)` [src]

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

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

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

Adds an `item` to the end of the queue

Returns back the `item` if the queue is full

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

#### `pub unsafe fn enqueue_unchecked(&mut self, item: T)` [src]

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

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

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

Adds an `item` to the end of the queue

Returns back the `item` if the queue is full

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

#### `pub unsafe fn enqueue_unchecked(&mut self, item: T)` [src]

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

## Auto Trait Implementations

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

### `impl<'a, T, N, U, C> Unpin for Producer<'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.