Struct Cache 

pub struct Cache { /* private fields */ }

Persistent store of previously seen flake URIs.

Powers shell-completion suggestions, ranked by hit count.

Implementations

impl Cache

pub fn commit(&self) -> Result<()>

Write the cache to its on-disk location, creating the parent directory if needed.

pub fn load() -> Self

Load the cache from the default location, or return an empty cache on any failure.

pub fn from_path(path: &Path) -> Self

Load the cache from path, or return an empty cache on any failure.

pub fn try_from_path(path: &Path) -> Result<Self>

Load the cache from path, surfacing read or parse errors.

Errors

Returns std::io::Error if path cannot be opened or its JSON payload cannot be deserialized.

pub fn add_entry(&mut self, id: String, uri: String)

Insert or bump the hit count of the (id, uri) entry.

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

All cached URIs sorted by descending hit count.

pub fn list_uris_for_id(&self, id: &str) -> Vec<String>

Cached URIs for id sorted by descending hit count.

Useful for the change workflow, which suggests URIs that have been used for the same input id (e.g. both a remote github: and a local path: URI for testing).

pub fn populate_from_inputs<'a>( &mut self, inputs: impl Iterator<Item = (&'a str, &'a str)>, )

Insert any (id, uri) pairs not already present, without bumping hit counts on existing entries.

Use this when populating the cache as a side effect of any command that reads inputs (list, change, update, …), not only add.

Trait Implementations

impl Clone for Cache

fn clone(&self) -> Cache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Cache

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

Formats the value using the given formatter.

impl Default for Cache

fn default() -> Cache

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Cache

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Cache

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.