Struct Consumer 

pub struct Consumer<'a, T: Copy, const N: usize> { /* private fields */ }

Consumer handle for reading from the ring.

This handle is !Sync to prevent concurrent consumers.

Implementations

impl<'a, T: Copy, const N: usize> Consumer<'a, T, N>

pub fn dropped(&self) -> usize

How many items have been dropped since consumer creation (or since reset).

pub fn reset_dropped(&mut self)

Reset the internal drop counter.

pub fn poll_one(&mut self, hook: impl FnOnce(u32, &T)) -> bool

Drain at most one item (in-order). Returns true if an item was delivered to the hook.

pub fn poll_up_to(&mut self, max: usize, hook: impl FnMut(u32, &T)) -> PollStats

Drain up to max items (in-order). Hook sees &T but it is a reference to a local copy inside poll.

If max == 0, this returns immediately with read = 0, dropped = 0, and newest set to the latest published sequence.

pub fn latest(&self, hook: impl FnOnce(u32, &T)) -> bool

“Give me the newest thing right now” (not in-order). Returns true if it delivered something.

This does not advance the consumer cursor.

pub fn skip_to_latest(&mut self)

Fast-forward consumer so the next poll_one() yields the newest item (i.e. skip backlog).

This does not modify the dropped counter.

Trait Implementations

impl<T: Copy, const N: usize> Debug for Consumer<'_, T, N>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a, T: Copy, const N: usize> Drop for Consumer<'a, T, N>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Copy, const N: usize> Source<T> for Consumer<'_, T, N>

fn try_pop(&mut self) -> Option<T>

Pull the next event, or None if nothing is available.