Struct OutputLog 

pub struct OutputLog { /* private fields */ }

A byte-bounded append-only output log.

Implementations

impl OutputLog

pub fn new(capacity_bytes: usize) -> Self

Create a log with a fixed aggregate byte capacity.

pub fn append(&mut self, stream: StreamKind, bytes: impl Into<Vec<u8>>) -> u64

Append bytes and return their assigned sequence number.

Records that do not fit are not retained. Their sequence is still consumed, allowing existing cursors to report a precise gap.

pub fn first_sequence(&self) -> u64

Return the first sequence still retained, or the next sequence when empty.

pub fn next_sequence(&self) -> u64

Return the next sequence that will be assigned.

pub fn retained_bytes(&self) -> usize

Return the number of bytes currently retained.

pub fn len(&self) -> usize

Return the number of records currently retained.

pub fn is_empty(&self) -> bool

Whether the log contains no retained records.

pub fn cursor(&self) -> OutputCursor

Create a cursor positioned at the oldest currently retained record.

pub fn cursor_from(&self, sequence: u64) -> OutputCursor

Create a cursor positioned at an explicit sequence.

Trait Implementations

impl Debug for OutputLog

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

Formats the value using the given formatter.