Trait RingStorage 

pub trait RingStorage {
    type Item;

    // Required methods
    fn push(&self, item: Self::Item) -> Result<(), Self::Item>;
    fn dequeue(&self) -> Option<Self::Item>;
    fn len(&self) -> usize;
    fn capacity(&self) -> usize;

    // Provided methods
    fn is_empty(&self) -> bool { ... }
    fn drain_into(&self, out: &mut [Self::Item]) -> usize { ... }
}

The storage a BoundedQueue drives: a lock-free MPMC ring, in either the inline StaticRing (no-alloc) or heap Ring (alloc) form. push hands the item back on a full ring (never blocks); dequeue pops FIFO. The item type is associated so a BoundedQueue<R> names a single storage rather than threading a redundant element parameter.

Required Associated Types

type Item

The queued element.

Required Methods

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

Push one item; on a full ring the item is handed back via Err.

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

Pop the oldest item, or None when empty.

fn len(&self) -> usize

Snapshot of the number of queued items (not linearizable).

fn capacity(&self) -> usize

The ring’s capacity (a power of two).

Provided Methods

fn is_empty(&self) -> bool

True when the ring holds nothing (snapshot).

fn drain_into(&self, out: &mut [Self::Item]) -> usize

Pop up to out.len() items FIFO into out, returning the count filled. Default is a dequeue loop; the heap Ring overrides it with its prefetching batch Drainer.

Dyn Compatibility

This trait is dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety".

Implementors

impl<T, const N: usize> RingStorage for StaticRing<T, N>

type Item = T

impl<T> RingStorage for Ring<T>

Available on crate feature alloc only.

type Item = T