Struct Queue 

pub struct Queue<T> { /* private fields */ }

Queue that is limited in size and does not support resizing.

This queue implementation has the following characteristics:

• Based on crossbeam_queue::ArrayQueue
• Has limit capacity with back pressure on push
• Does not support resizing
• Enabled via the limited feature in your Cargo.toml

Implementations

impl<T> Queue<T>

pub fn new(max_size: usize) -> Self

Create new empty queue

pub async fn pop(&self) -> T

Get an item from the queue. If the queue is currently empty this method blocks until an item is available.

pub fn try_pop(&self) -> Option<T>

Try to get an item from the queue. If the queue is currently empty return None instead.

pub async fn push(&self, item: T)

Push an item into the queue

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

Try to push an item into the queue. If the queue is full the item is returned as Err<T>.

pub fn capacity(&self) -> usize

Get capacity of the queue (maximum number of items queue can store)

pub fn len(&self) -> usize

Get current length of queue (number of items currently stored)

pub fn is_empty(&self) -> bool

Returns true if the queue is empty.

pub fn is_full(&self) -> bool

Returns true if the queue is full.

pub fn available(&self) -> isize

The number of available items in the queue. If there are no items in the queue this number can become negative and stores the number of futures waiting for an item.

pub async fn wait_full(&self)

Await until the queue is full.

pub fn subscribe_full(&self) -> Receiver

Get a Receiver object that can repeatedly be awaited for queue-full notifications.

pub async fn wait_empty(&self)

Await until the queue is empty.

pub fn subscribe_empty(&self) -> Receiver

Get a Receiver object that can repeatedly be awaited for queue-empty notifications.

Trait Implementations

impl<T> Debug for Queue<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T, I> From<I> for Queue<T>

where I: IntoIterator<Item = T>, <I as IntoIterator>::IntoIter: ExactSizeIterator,

fn from(iter: I) -> Self

Create new queue from the given exact size iterator of objects.