Struct OutputRing 

pub struct OutputRing { /* private fields */ }

Per-pane bounded live output storage with independent cursor polling.

Implementations

impl OutputRing

pub fn new(event_capacity: usize, recent_byte_capacity: usize) -> Self

Creates an empty output ring with explicit event and recent-byte limits.

Both limits must be positive. A zero-sized ring would make every subscriber permanently lagged and is rejected at construction.

pub fn with_default_capacities() -> Self

Creates an empty output ring using the v1 defaults.

pub fn push(&mut self, bytes: Vec<u8>) -> u64

Appends one output event, rotates the ring, and updates recent live bytes.

pub fn push_with_recent_retention( &mut self, bytes: Vec<u8>, retain_recent: bool, ) -> u64

Appends one output event, optionally updating the lag-recovery buffer.

pub fn push_shared(&mut self, bytes: Arc<[u8]>) -> u64

Appends one shared output event without copying its byte payload.

pub fn push_shared_with_recent_retention( &mut self, bytes: Arc<[u8]>, retain_recent: bool, ) -> u64

Appends one shared output event, optionally updating lag recovery bytes.

pub fn clear_retained(&mut self)

Clears retained events and recent bytes without rewinding the sequence.

pub fn cursor_from_oldest(&self) -> OutputCursor

Returns a cursor that starts with the oldest retained event.

pub fn cursor_from_now(&self) -> OutputCursor

Returns a cursor that starts after the newest appended event.

pub const fn cursor_from_sequence(sequence: u64) -> OutputCursor

Returns a cursor that starts at an explicit output sequence.

pub fn poll_cursor(&self, cursor: &mut OutputCursor) -> Option<OutputCursorItem>

Polls one item for cursor, reporting gaps before retained events.

pub fn poll_cursor_batch( &self, cursor: &mut OutputCursor, limit: usize, ) -> Vec<OutputCursorItem>

Polls up to limit items for cursor from one retained-ring snapshot.

A lag gap is returned only as the first item. Once the cursor is inside the retained range, the same immutable ring view cannot produce a later gap in this batch; callers therefore never advance over an event and then replace it with a lag response from a concurrently rotated ring.

pub fn oldest_sequence(&self) -> u64

Returns the oldest retained event sequence, or the next sequence if empty.

pub const fn next_sequence(&self) -> u64

Returns the next sequence that will be assigned.

pub fn newest_sequence(&self) -> u64

Returns the newest appended sequence, or zero before the first append.

pub const fn event_capacity(&self) -> usize

Returns the configured event capacity.

pub const fn recent_byte_capacity(&self) -> usize

Returns the configured recent live byte capacity.

pub fn retained_len(&self) -> usize

Returns retained event count.

pub const fn retained_event_bytes(&self) -> usize

Returns the total raw bytes retained by event payloads.

pub fn recent_len(&self) -> usize

Returns the total bytes currently retained in recent live storage.

pub fn recent_snapshot(&self) -> RecentOutputSnapshot

Returns a bounded recent live output snapshot.

pub fn retained_events(&self) -> Vec<OutputEvent>

Returns retained events in sequence order.

Trait Implementations

impl Clone for OutputRing

fn clone(&self) -> OutputRing

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OutputRing

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

Formats the value using the given formatter.

impl Default for OutputRing

fn default() -> Self

Returns the “default value” for a type.