Struct RefLog 

pub struct RefLog { /* private fields */ }

The ref log of one repository.

Implementations

impl RefLog

pub fn new(path: impl Into<PathBuf>) -> Self

pub fn next_push_seq(&self) -> Result<u64>

The next push_seq this log should use: one past the highest already recorded. Derived from the log itself, so a crashed writer that lost its counter cannot reuse a sequence number and silently reorder history.

pub fn push(&self, updates: &[RefUpdate]) -> Result<u64>

Append one push atomically. Returns the push_seq it was given.

pub fn append_batch(&self, batch: &RecordBatch) -> Result<u64>

Append an already-built push batch, whose push_seq the caller assigned.

For a server that holds its own counter: push re-derives the sequence by rescanning the log, which is the safe default but is O(log) per push. Returns the byte offset the frame starts at.

pub fn scan(&self) -> Result<PushLogScan>

pub fn compact(&self) -> Result<CompactionReport>

Fold every frame into one. See PushLog::compact — rows and their order are preserved, so fold answers identically before and after.

pub fn maybe_compact( &self, policy: CompactionPolicy, ) -> Result<Option<CompactionReport>>

Compact if the log has grown past policy.

pub fn current(&self) -> Result<BTreeMap<String, RefState>>

The current ref namespace.

pub fn seal_section(&self) -> Result<ReservedSection>

The reserved section to seal into the archive.