Struct Queue 

pub struct Queue<T, S = Auto>
where
    T: AsPackedValue,
    S: SlotType<T>,
{ /* private fields */ }

A MPMCQueue over a heap-allocated array.

This queue only accepts items that implement PtrLike.

If you need to store larger types, consider using PooledQueue instead.

only available on feature alloc

Implementations

impl<T> Queue<T, Auto>

where T: AsPackedValue,

pub fn new(size: usize) -> Self

Constructs a new Queue with capacity size and slot type Auto. T must fit into the chosen slot type

pub fn with_slot<S>(size: usize) -> Queue<T, S>

where S: SlotType<T>,

Constructs a new Queue with capacity size and slot type S. T must fit into the slot type S

Trait Implementations

impl<T, S> MPMCQueue for Queue<T, S>

where T: AsPackedValue, S: SlotType<T>,

type Item = T

The item stored in the queue

fn push(&self, item: Self::Item) -> Result<(), Self::Item>

Attempts to push an item into the queue. Returns the item as an error if the queue is full.

fn pop(&self) -> Option<Self::Item>

Attempts to pop an item from the queue. Returns None if the queue was empty.

fn len(&self) -> usize

Returns the current len of the queue. The returned value may be stale under concurrent access and should not be used for synchronization.

fn capacity(&self) -> usize

Returns the total capacity of the queue.

fn is_empty(&self) -> bool

Indicates whether the queue is empty. The returned value may be stale under concurrent access and should not be used for synchronization.

fn is_full(&self) -> bool

Indicates whether the queue is full. The returned value may be stale under concurrent access and should not be used for synchronization.

fn force_push(&self, item: Self::Item) -> Option<Self::Item>

Pushes an item into the queue, removing an existing item if the queue is full.

fn force_push_and_do<F>(&self, item: Self::Item, f: F)

where F: FnMut(Self::Item),

Pushes an item into the queue, removing an existing item if the queue is full.