Struct AuditLog 

pub struct AuditLog { /* private fields */ }

Implementations

impl AuditLog

pub fn open(path: &Path, retention: Duration) -> Result<AuditLog>

Open (creating and migrating) the log at path.

pub fn in_memory() -> Result<AuditLog>

A throwaway in-memory log (tests).

pub fn with_clock(self, clock: impl Fn() -> i64 + Send + Sync + 'static) -> Self

Replace the clock (unix milliseconds), for tests of retention.

pub fn with_history_limits(self, retention: Duration, max_rows: i64) -> Self

Keep history rows for retention, and at most max_rows of them.

pub fn path(&self) -> Option<&Path>

pub fn retention(&self) -> Duration

pub fn append(&self, n: NewEntry) -> Result<Entry>

Append one row, chained to the newest. Returns it.

pub fn prune(&self) -> Result<usize>

Remove rows older than the retention, keeping the chain anchored. The only way rows ever leave.

pub fn list(&self, q: &Query, vis: &Visibility) -> Result<Vec<Entry>>

Rows matching q that vis may see: newest first, or oldest first with after (for tailing).

pub fn generation(&self) -> u64

The current append generation (see Self::wait_change).

pub fn wait_change(&self, seen: u64, timeout: Duration) -> u64

Wait up to timeout for this process to append anything after generation seen; returns the generation now. Other writers (the CLI) show up at the next poll.

pub fn head(&self) -> Result<i64>

The newest id, 0 when empty.

pub fn verify(&self) -> Result<Verified>

Walk the chain from the oldest kept row to the head.

impl AuditLog

pub fn history_append(&self, n: NewRecord) -> Result<Record>

Append one history row, chained to the newest.

pub fn history_last_time(&self) -> Result<Option<i64>>

The newest history row’s time, if any.

pub fn history_list( &self, q: &HistoryQuery, vis: &Visibility, upto: Option<i64>, from: Option<i64>, limit: usize, ) -> Result<Vec<Record>>

History rows matching q that vis may see, newest first (or oldest first with ascending), time <= upto when given.

pub fn history_after( &self, after: i64, vis: &Visibility, limit: usize, ) -> Result<Vec<Record>>

Rows appended after id after, oldest first (tailing).

pub fn history_head(&self) -> Result<i64>

The newest history id, 0 when empty.

pub fn history_verify(&self) -> Result<Verified>

Walk the history chain, as AuditLog::verify does the audit one.

pub fn timeline( &self, q: &HistoryQuery, hvis: &Visibility, avis: Option<&Visibility>, ) -> Result<Page>

The merged timeline: history rows hvis may see and, when avis is given, audit rows it may see.

Trait Implementations

impl Debug for AuditLog

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

Formats the value using the given formatter.