Struct FixityCache 

pub struct FixityCache { /* private fields */ }

What this device remembers of a workspace’s file digests.

Keyed by workspace-relative path, so a workspace that moves keeps its cache; root is recorded only to refuse a cache that was written for a different workspace entirely.

Implementations

impl FixityCache

pub fn new(root: impl Into<PathBuf>) -> Self

An empty cache for the workspace rooted at root.

pub fn decode(bytes: &[u8], root: &Path) -> Option<Self>

Decode what was persisted for the workspace at root.

None for anything that is not exactly what some build of prov wrote for this workspace — the caller’s move is to start new, never to investigate.

pub fn encode(&self) -> Vec<u8>

The bytes to persist. Pair with is_dirty: a cache that learned nothing this run is worth writing to nobody.

pub fn get(&self, path: &Path, meta: &Metadata) -> Option<&str>

The remembered digest for the workspace-relative path, if the file meta describes is still the one it was recorded against.

Both halves of the stat must agree: a length alone misses an edit that preserved the size, and a timestamp alone trusts a clock the file may have arrived with.

pub fn put(&mut self, path: &Path, meta: &Metadata, hash: &str)

Remember that path hashed to hash at the stat meta describes.

Three things are declined rather than stored wrong: a file whose backend reports no modification time (nothing could ever validate it, so keeping it would only cost space), a path that is not valid UTF-8 (it has no stable key, and a lossy one could collide with a different file), and anything at all once [MAX_ENTRIES] is reached.

pub fn forget(&mut self, path: &Path)

Forget path — what a write to it means.

pub fn clear(&mut self)

Forget everything. For a write prov cannot attribute to one path.

pub fn is_dirty(&self) -> bool

Whether anything has changed since this was decoded.

pub fn root(&self) -> &Path

The workspace this cache was built for.

pub fn len(&self) -> usize

How many files are remembered.

pub fn is_empty(&self) -> bool

Whether nothing is remembered.

Trait Implementations

impl Clone for FixityCache

fn clone(&self) -> FixityCache

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for FixityCache

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

Formats the value using the given formatter.