Struct PositionMonitor

pub struct PositionMonitor<T: 'static> { /* private fields */ }

PositionMonitor<T> records the current read/write positions of a queue.

The PositionMonitor works by keeping track how many times the ring buffer wrapped around, and the current offsets that are used. The former (how many times the ring buffer wrapped around) is kept in an AtomicU64 that is updated each time a value is read. The latter (current offsets) is kept by looking at the Fifo directly.

Even though a queue is comprised of a limited number of slots arranged as a ring buffer, we can assign a position to each value written/ read to/from the queue. This is useful in case we want to know whether or not a particular value written to the queue has been read.

Implementations

impl<T> PositionMonitor<T>

pub fn read_position(&self) -> ReadPosition

pub fn write_position(&self) -> WritePosition

Trait Implementations

impl<T> Clone for PositionMonitor<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.