Enum WalRecord 

pub enum WalRecord {
    PageOwnership {
        record: PageOwnershipRecord,
    },
    Begin {
        tx_id: u64,
    },
    Commit {
        tx_id: u64,
    },
    Rollback {
        tx_id: u64,
    },
    PageWrite {
        tx_id: u64,
        page_id: u32,
        data: Vec<u8>,
    },
    TxCommitBatch {
        tx_id: u64,
        actions: Vec<Vec<u8>>,
    },
    FullPageImage {
        tx_id: u64,
        page_id: u32,
        ckpt_epoch: u64,
        data: Vec<u8>,
    },
    VectorInsert {
        collection: String,
        entity_id: u64,
        vector: Vec<f32>,
    },
    ProbabilisticDelta {
        kind: u8,
        operation: u8,
        name: String,
        operands: Vec<Vec<u8>>,
    },
    Checkpoint {
        lsn: u64,
    },
}

A single entry in the write-ahead log

Variants

PageOwnership

Durable page-ownership intent. It must be resolved before page reuse.

Fields

record: PageOwnershipRecord

Begin

Start of a transaction

Fields

tx_id: u64

Commit

Commit of a transaction

Fields

tx_id: u64

Rollback

Rollback of a transaction

Fields

tx_id: u64

PageWrite

Write of a page — always carries uncompressed data (transparent to callers: read() decompresses on-the-fly).

Fields

tx_id: u64

page_id: u32

data: Vec<u8>

TxCommitBatch

Atomic logical commit batch. Recovery applies all actions in order iff this complete record and checksum are present.

Fields

tx_id: u64

actions: Vec<Vec<u8>>

FullPageImage

Full-page image — pristine page bytes captured before the first modification per checkpoint cycle. Recovery applies these before redo so torn writes are healed without the -dwb sidecar.

Fields

tx_id: u64

page_id: u32

ckpt_epoch: u64

data: Vec<u8>

VectorInsert

Logical vector insert payload. Recovery can replay FP32 into the in-memory vector-turbo index without requiring snapshot files.

Fields

collection: String

entity_id: u64

vector: Vec<f32>

ProbabilisticDelta

Logical probabilistic-structure mutation delta. Checkpoints carry full snapshots through the regular store state; crash recovery replays these deltas after loading the latest snapshot.

Fields

kind: u8

operation: u8

name: String

operands: Vec<Vec<u8>>

Checkpoint

Checkpoint marker (indicates up to which LSN pages are flushed)

Fields

lsn: u64

Implementations

impl WalRecord

pub fn encode(&self) -> Vec<u8>

Serialize record to bytes (including checksum).

PageWrite compression and physical framing are owned by reddb-file.

pub fn encode_with_term(&self, term: u64) -> Vec<u8>

Serialize record to bytes with the replication term stamped into the physical record envelope.

pub fn encode_into(&self, out: &mut Vec<u8>)

Serialize record into a caller-owned scratch buffer, appending the encoded bytes (including checksum) to out.

This is the allocation-light entry point for the lock-free append path: concurrent appenders each encode into their own per-call out buffer before taking the WAL lock, so the scratch is never shared across threads and needs no thread_local!. Reusing one out across many records (the commit blob) avoids the fresh Vec + copy that encode allocates per record. The bytes appended are byte-identical to encode().

pub fn encode_with_term_into(&self, out: &mut Vec<u8>, term: u64)

Serialize record into a caller-owned scratch buffer with the replication term stamped into the physical envelope. See encode_into.

The checksum is computed over only the bytes this call appends (the slice starting at the buffer’s prior length), so appending after existing records leaves them untouched and keeps each record’s CRC self-contained.

The payload is written straight from this record’s own buffers — the append path never clones a page image or a commit batch into an owned file frame first.

pub fn encode_with_authority_into( &self, out: &mut Vec<u8>, authority: WalRecordAuthority, )

pub fn read<R: Read>(reader: &mut R) -> Result<Option<WalRecord>>

Read a record from a reader.

Handles both v1 (PageWrite) and v2 (PageWriteCompressed) record formats transparently — callers always receive uncompressed data.

pub fn read_with_term<R: Read>( reader: &mut R, ) -> Result<Option<(u64, WalRecord)>>

Read a record and return the term stamped into its physical envelope.

pub fn read_with_authority<R: Read>( reader: &mut R, ) -> Result<Option<(WalRecordAuthority, WalRecord)>>

Read a record and return the term + ownership epoch stamped into its physical envelope.

Trait Implementations

impl Clone for WalRecord

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WalRecord

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

Formats the value using the given formatter.

impl PartialEq for WalRecord

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for WalRecord