Struct PinBook 

pub struct PinBook { /* private fields */ }

The pin book of one config dir. Every change is a locked read-modify-write (<file>.lock), so the daemon and a CLI clearing an entry never lose each other’s writes.

Implementations

impl PinBook

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

pub fn for_active_profile() -> Self

The active profile’s book.

pub fn path(&self) -> &Path

pub fn load(&self) -> Vec<PinEntry>

Every entry this build can read (missing or unreadable file: none).

pub fn update<R>(&self, f: impl FnOnce(&mut Vec<PinEntry>) -> R) -> Result<R>

Locked read-modify-write. Writes only when f changed something; an empty book never creates the file. Err when the file is from a newer schema (or unreadable) and so read-only here.

pub fn remove(&self, id: &str) -> Result<bool>

Drop the entry for id (journal id, exact). true if there was one.

Trait Implementations

impl Clone for PinBook

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 PinBook

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

Formats the value using the given formatter.

impl PinSink for PinBook

fn pinned( &self, id: &str, journal_id: &str, name: Option<&str>, cwd: Option<&Path>, cache_keepwarm: Option<&str>, )

The session is pinned: add or refresh its entry (journal_id is current; id is the actor id, which may name an older journal). cache_keepwarm: the session’s /keepwarm override (off/auto/<N>h).

fn unpinned(&self, id: &str, journal_id: &str)

Unpinned, or ended on purpose while pinned: drop its entry.

fn moved(&self, from: &str, to: &str)

A pinned session’s journal changed (/clear, a successor compaction, resume): the entry follows it.