Struct Ledger 

pub struct Ledger {
    dir: PathBuf,
    pub(super) document: Document,
    state: LedgerState,
}

Fields

dir: PathBuf

document: Document

state: LedgerState

Implementations

impl Ledger

pub fn open(game_dir: impl AsRef<Path>) -> Ledger

pub fn state(&self) -> LedgerState

pub fn state_dir(&self) -> &Path

.pacenotes inside the game folder.

pub fn put(&mut self, key: &str, entry: LedgerEntry) -> Result<()>

pub fn mark_installed(&mut self, key: &str) -> Result<()>

Separate from put, so a write-ahead entry and a finished one cannot be confused.

pub fn remove(&mut self, key: &str) -> Result<()>

pub fn replace_all( &mut self, packages: BTreeMap<String, LedgerEntry>, ) -> Result<()>

What restoring a point does.

pub fn save_snapshot(&self, path: &Path) -> Result<()>

The packages alone, as replace_all takes them back.

pub fn read_snapshot(path: &Path) -> Option<BTreeMap<String, LedgerEntry>>

What save_snapshot wrote, or None when it is missing or unreadable.

pub fn save(&mut self) -> Result<()>

After each package, as a temp file renamed over the old one, so a run that dies leaves a ledger that still describes the disk. Refuses to replace a ledger it could not read, which may record a newer build’s packages.

impl Ledger

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn packages(&self) -> &BTreeMap<String, LedgerEntry>

By game/directory/name.

pub fn get(&self, key: &str) -> Option<&LedgerEntry>

pub fn unfinished(&self) -> Vec<String>

Entries a dead run left mid-install, to deal with before planning anything.

pub fn owners_of(&self, path: &str) -> Vec<&str>

Compared folded, since two packages spelling a shared path differently own one file.

pub fn owns(&self, path: &str) -> bool

A file nothing owns was the user’s, and is backed up before it is overwritten.