Struct deadqueue::limited::Queue

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

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

Methods

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

pub fn len(&self) -> usize

Get current length of queue

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.

Trait Implementations

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.