Struct IdentityJournal 

pub struct IdentityJournal { /* private fields */ }

The journal in a manifests directory.

Implementations

impl IdentityJournal

pub fn new(manifests_dir: &Path) -> Self

The journal under manifests_dir.

pub fn path(&self) -> PathBuf

Journal file path.

pub fn exists(&self) -> bool

Does the journal file exist?

pub fn lock(&self) -> Result<JournalLock, IdentityError>

Take the exclusive lock (blocking). On a brand-new install (no lock file and no journal yet) this also creates the journal with an init record, so from then on a missing journal is an error.

pub fn try_lock(&self) -> Result<Option<JournalLock>, IdentityError>

Take the exclusive lock if free; None when someone holds it.

pub fn lock_shared(&self) -> Result<SharedLock, IdentityError>

Take a shared lock for reading. Never creates the lock file (a reader must not make an unused install look initialised).

pub fn read( &self, other_evidence: bool, ) -> Result<Vec<JournalRecord>, IdentityError>

Every record, oldest first (the init marker is not returned), under a shared lock. other_evidence says whether anything else proves the journal should exist (a certificate file or a user.projects chain event). See Self::read_locked.

pub fn read_locked( &self, _lock: &JournalLock, other_evidence: bool, ) -> Result<Vec<JournalRecord>, IdentityError>

Self::read for a caller already holding the exclusive lock.

pub fn append( &self, lock: &JournalLock, rec: &JournalRecord, ) -> Result<(), IdentityError>

Append rec, fsynced. Parses the existing journal first and refuses (leaving it untouched) if it does not parse or does not end in a newline.

pub fn salvage(&self, _lock: &JournalLock) -> Vec<JournalRecord>

Every record of the journal that parses, line by line, ignoring any line that does not (a torn tail must not hide earlier records). Unverified: the caller rebuilds a view, which re-verifies certificates.

pub fn replace( &self, _lock: &JournalLock, records: &[JournalRecord], ) -> Result<Option<PathBuf>, IdentityError>

Repair: move the current journal (if any) aside as identity.journal.jsonl.corrupt-<unix secs> and write a new one from records. Returns the path of the moved file.

Trait Implementations

impl Clone for IdentityJournal

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 IdentityJournal

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

Formats the value using the given formatter.