Struct CanonicalLog 

pub struct CanonicalLog { /* private fields */ }

The append-only canonical log file.

Implementations

impl CanonicalLog

pub fn open(path: impl AsRef<Path>) -> Result<Self, LogError>

Open or create the canonical log at path. File is opened in read+write+append-friendly mode; existing content is preserved.

On a freshly-created (or pre-existing zero-byte) file, the 8-byte header (MIMR + format version 1 LE) is written and fsync’d before this returns. On a file that already has bytes, the first 8 bytes are validated against the expected header and rejected with LogError::IncompatibleFormat on mismatch — before any truncation, append, or replay path runs. This guards against the destructive-truncate footgun where pointing Store::open at a misrouted path would silently zero the file.

Errors

• LogError::Io if the file cannot be created or opened.
• LogError::IncompatibleFormat if the file’s first bytes are not a valid Mimir log header (truncated, wrong magic, or wrong format version).

pub fn path(&self) -> &Path

The filesystem path of this log.

Trait Implementations

impl Debug for CanonicalLog

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

Formats the value using the given formatter.

impl LogBackend for CanonicalLog

fn append(&mut self, bytes: &[u8]) -> Result<(), LogError>

Append bytes at the current end. No fsync is implied.

fn sync(&mut self) -> Result<(), LogError>

Fsync the log. Spec § 6 — data + metadata.

fn truncate(&mut self, new_len: u64) -> Result<(), LogError>

Truncate the log to new_len bytes (and fsync the truncation).

fn read_all(&mut self) -> Result<Vec<u8>, LogError>

Read the entire log into a buffer.

fn len(&self) -> u64

Byte length of the log.

fn last_checkpoint_end(&mut self) -> Result<u64, LogError>

Scan forward from offset 0 and return the byte offset after the last Checkpoint record. Returns 0 if no Checkpoint has committed yet.

fn is_empty(&self) -> bool

true if the log is empty.