Struct Wal 

pub struct Wal { /* private fields */ }

The main entry point for the IronWal library. Thread-safe and cloneable (internally strictly synchronized).

Implementations

impl Wal

pub fn new(options: WalOptions) -> Result<Self>

pub fn current_segment_start_id(&self, stream: &str) -> Option<u64>

Returns the Start ID of the currently active segment. Useful for monitoring rotation and testing.

pub fn iter(&self, stream: &str, start_id: u64) -> Result<WalIterator>

Creates an iterator to read entries sequentially starting from start_id.

pub fn append(&self, stream: &str, entry: &[u8]) -> Result<u64>

Appends a single entry to the stream.

pub fn append_batch( &self, stream: &str, entries: &[&[u8]], ) -> Result<Range<u64>>

Appends a batch of entries atomically to the WAL.

pub fn writer(&self, stream: &str) -> TxnWriter

Returns a TxnWriter handle for accumulating a batch of writes in memory.

pub fn get(&self, stream: &str, id: u64) -> Result<Option<Vec<u8>>>

Reads a single entry by its sequence ID.

pub fn truncate(&self, stream: &str, safe_id: u64) -> Result<usize>

Truncates the stream’s history, deleting all segment files containing records with IDs strictly less than safe_id.

Returns the number of segments deleted.

Trait Implementations

impl Clone for Wal

fn clone(&self) -> Wal

Returns a duplicate of the value.

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

Performs copy-assignment from source.