Struct Journal 

pub struct Journal { /* private fields */ }

The journal of a host: the mutating commands that succeeded, in order, with scrubbed params (replay, session logs, agent “what happened”). Also tracks the current nesting depth of crate::Registry::execute.

A capped ring: past cap entries the oldest drop are removed in one go. By default only top-level calls (depth 0) are recorded; Journal::record_nested records nested calls too.

Implementations

impl Journal

pub fn new() -> Self

pub fn with_cap(cap: usize, drop: usize) -> Self

Keep at most cap entries (at least 1), dropping the oldest drop (1..=cap) when full.

pub fn record_nested(self, yes: bool) -> Self

Also record commands run from inside other commands.

pub fn set_observer(&mut self, observer: Option<RunObserver>)

Tell observer about every top-level command that runs from now on (None: nobody). Telemetry uses this; crate::Registry::execute calls it after crate::Host::after.

pub fn observer(&self) -> Option<&RunObserver>

pub fn depth(&self) -> usize

Current nesting depth: 0 outside any command, 1 inside a top-level command…

pub fn set_depth(&mut self, depth: usize)

Set the nesting depth. crate::Registry::execute does this around every command; a host sets it only to run a command from one of its hooks as nested (see crate::Host), and puts the old value back afterwards.

pub fn records(&self, depth: usize) -> bool

Whether a call at depth is recorded.

pub fn push(&mut self, id: impl Into<String>, params: Value)

Record a call (the chokepoint does this; hosts may record extra entries).

pub fn entries( &self, ) -> impl DoubleEndedIterator<Item = &JournalEntry> + ExactSizeIterator

pub fn since(&self, seq: u64) -> impl Iterator<Item = &JournalEntry>

Entries recorded at or after sequence number seq.

pub fn last(&self) -> Option<&JournalEntry>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn next_seq(&self) -> u64

The sequence number the next recorded entry gets.

pub fn truncate(&mut self, len: usize)

Keep only the first len entries (drop the newest; e.g. calls undone and then replaced). Sequence numbers already handed out are not reused.

pub fn retain(&mut self, keep: impl FnMut(&JournalEntry) -> bool)

Keep only the entries keep returns true for, in order.

pub fn pop(&mut self) -> Option<JournalEntry>

Remove and return the newest entry.

pub fn clear(&mut self)

pub fn to_json(&self) -> Value

The entries as a JSON array ([{seq, id, params}]).

Trait Implementations

impl Clone for Journal

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 Journal

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

Formats the value using the given formatter.

impl Default for Journal

fn default() -> Self

Returns the “default value” for a type.