Struct ShmRingLaneView 

pub struct ShmRingLaneView<'a> { /* private fields */ }

One physical lane of a ShmRingView.

Implementations

impl ShmRingLaneView<'_>

pub fn index(self) -> usize

pub fn head(self) -> u64

Snapshot the currently visible committed/reserved head.

pub fn retained_range(self) -> Range<u64>

Counter range that may still be retained at the observed head.

pub fn read_at(self, counter: u64) -> Option<Frame>

Read the exact counter if its frame is still committed in this lane.

pub fn read_head(self) -> Option<Frame>

Read the frame immediately below the observed head.

Trait Implementations

impl<'a> Clone for ShmRingLaneView<'a>

fn clone(&self) -> ShmRingLaneView<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for ShmRingLaneView<'a>

impl<'a> Debug for ShmRingLaneView<'a>

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

Formats the value using the given formatter.

impl RingFrameSource for ShmRingLaneView<'_>

fn kind(&self) -> u8

The OrbitTyped::KIND carried by this ring.

fn head(&self) -> u64

Monotonic visible head. Depending on topology, this counts counters reserved by writers or frames committed by writers.

fn capacity(&self) -> usize

Fixed slot count for this ring.

fn read_at(&self, counter: u64) -> Option<Frame>

Read the frame currently occupying counter % capacity.

fn read_state_at(&self, counter: u64) -> RingRead

Classify the logical counter currently addressed by counter % capacity.