Struct ProcessSharedRing 

pub struct ProcessSharedRing<T> { /* private fields */ }

Preallocated bounded ring used at process-site stream boundaries.

Cloning is unsupported: a ring handle owns one process-boundary buffer, so copies must be explicit higher-level handles with documented shared state.

use sim_lib_stream_host::ProcessSharedRing;

let ring = ProcessSharedRing::<u8>::with_capacity(1).unwrap();
let _copy = ring.clone();

Implementations

impl<T> ProcessSharedRing<T>

pub fn with_capacity(capacity: usize) -> Result<Self>

Creates a ring preallocated to hold capacity items.

Returns an evaluation error when capacity is zero.

Examples

use sim_lib_stream_host::{ProcessRingPush, ProcessSharedRing};

let mut ring = ProcessSharedRing::with_capacity(2).unwrap();
assert_eq!(ring.try_push(1), ProcessRingPush::Accepted);
assert_eq!(ring.try_push(2), ProcessRingPush::Accepted);
assert_eq!(ring.try_push(3), ProcessRingPush::DroppedNewest(3));
assert_eq!(ring.try_pop(), Some(1));

pub fn try_push(&mut self, item: T) -> ProcessRingPush<T>

Pushes an item, returning whether it was accepted, dropped (full), or rejected (closed).

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

Pops the oldest item, or returns None when the ring is empty.

pub fn close(&mut self)

Closes the ring; further pushes are rejected.

pub fn cancel(&mut self)

Drains all buffered items and closes the ring, recording cancellation.

pub fn len(&self) -> usize

Returns the number of buffered items.

pub fn is_empty(&self) -> bool

Returns whether the ring is empty.

pub fn capacity(&self) -> usize

Returns the ring capacity in items.

pub fn allocated_slots(&self) -> usize

Returns the number of slots backing storage has allocated.

pub fn is_closed(&self) -> bool

Returns whether the ring has been closed.

pub fn snapshot(&self) -> ProcessRingSnapshot

Captures a capacity snapshot for steady-state checks.

pub fn stats(&self) -> StreamStats

Returns a clone of the ring’s running statistics.

Trait Implementations

impl<T: Debug> Debug for ProcessSharedRing<T>

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

Formats the value using the given formatter.