Struct spmc_ring::SpmsRing

pub struct SpmsRing<T, N: ArrayLength<T>> { /* fields omitted */ }

This is a ring-buffer queue that is intended to be used for pub-sub applications. That is, a single producer writes items to the circular queue, and multiple consumers can read items from the queue. When a write to the fixed-size circular buffer overflows, the oldest items in the queue are overwritten. It is up to the readers to keep track of which items they have already read and poll for the next available item.

Implementations

impl<T, N> SpmsRing<T, N> where
    T: Default + Copy,
    N: ArrayLength<T>, 

pub fn publish(&mut self, val: &T)

Publish a single item

pub fn read_next(&self, token: &mut ReadToken) -> Result<T, ()>

Read an item from the queue Returns either an available msg or WouldBlock

pub fn empty(&self) -> bool

Is the queue empty?

pub fn available(&self) -> usize

How many total items are available to read?

Trait Implementations

impl<T, N> Default for SpmsRing<T, N> where
    T: Default + Copy,
    N: ArrayLength<T>, 

fn default() -> Self

Returns the "default value" for a type.