Struct spitebuf::MpScQueue

pub struct MpScQueue<T, STO: Storage<T>> {
    pub(crate) storage: STO,
    pub(crate) dequeue_pos: AtomicUsize,
    pub(crate) enqueue_pos: AtomicUsize,
    pub(crate) cons_wait: WaitCell,
    pub(crate) prod_wait: WaitQueue,
    pub(crate) closed: AtomicBool,
    pub(crate) pd: PhantomData<T>,
}

Fields

storage: STO

dequeue_pos: AtomicUsize

enqueue_pos: AtomicUsize

cons_wait: WaitCell

prod_wait: WaitQueue

closed: AtomicBool

pd: PhantomData<T>

Implementations

impl<T, STO: Storage<T>> MpScQueue<T, STO>

pub fn new(storage: STO) -> Self

Creates an empty queue

The capacity of storage must be >= 2 and a power of two, or this code will panic.

pub fn close(&self)

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

Returns the item in the front of the queue, or None if the queue is empty

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

Adds an item to the end of the queue

Returns back the item if the queue is full

pub async fn enqueue_async(&self, item: T) -> Result<(), EnqueueError<T>>

pub async fn dequeue_async(&self) -> Result<T, DequeueError>

Trait Implementations

impl<T, STO: Storage<T>> Drop for MpScQueue<T, STO>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, STO: Storage<T>> Sync for MpScQueue<T, STO>

where T: Send,