Struct LogCompactor 

pub struct LogCompactor;

Handles compaction of the Raft log by replacing committed entries with a snapshot, thereby bounding log growth.

Implementations

impl LogCompactor

pub fn new() -> Self

Create a new LogCompactor.

pub fn compact(log: &mut Vec<LogEntry>, snapshot_idx: u64) -> Snapshot

Compact the Raft log up to (and including) snapshot_idx.

All log entries with index <= snapshot_idx are removed from log. Returns a Snapshot that captures the term of the last removed entry (or 0 if no entry was found at snapshot_idx) and an empty state-data payload. Callers are expected to replace the payload with the actual serialised state-machine snapshot before persisting.

Arguments

• log - Mutable reference to the Raft log.
• snapshot_idx - The log index up to which compaction should proceed.

Returns

A Snapshot representing the compaction boundary.

pub fn install_snapshot(log: &mut Vec<LogEntry>, snapshot: &Snapshot) -> bool

Apply a received snapshot to a log: truncate the entire log if the snapshot is newer than all existing entries.

Returns true if the snapshot was applied (log was truncated), false if the log already has entries beyond the snapshot (snapshot is stale).

Trait Implementations

impl Default for LogCompactor

fn default() -> Self

Returns the “default value” for a type.