Struct Cache 

pub struct Cache { /* private fields */ }

Owns data about cached sources and is responsible for its persistence.

Implementations

impl Cache

pub fn create_at(cache_file: PathBuf) -> Self

Create a new cache at the specified file path.

pub fn read<P>(cache_dir: P) -> Result<Self, Error>

where P: AsRef<Path>,

Read the cache in the given directory.

Error if the directory or cache file do not exist, of if a deserialisation error occurs when reading the cache file

pub fn new<P>(cache_dir: P) -> Result<Self, Error>

where P: AsRef<Path>,

Create a new cache in the given directory.

Error if the directory doesn’t exist, or if there is already a cache file in this directory.

pub fn load_or_create<P>(cache_dir: P) -> Result<Self, Error>

where P: AsRef<Path>,

Loads the cache from a JSON file in the given directory, creating a new cache if the file does not exist. Requires that cache_dir exists. Note that this function doesn’t actually create the cache file - this happens when the cache is saved.

Returns an error if cache_dir doesn’t exist, or if a deserialisation error occurs when reading the cache file.

pub fn save(&self) -> Result<(), Error>

Saves the cache in the directory where it was created.

Returns an error if a serialisation or I/O error occurs.

pub fn cache_file(&self) -> &Path

Get the cache file path.

pub fn cache_dir(&self) -> CacheRoot

Get the directory of the cache file

pub fn cached_path(&self, source: &Source) -> CacheDir

Calculate the absolute path where a fetched source would be stored within the cache

pub fn items(&self) -> &CacheItems

Get a reference to the cache items.

pub fn items_mut(&mut self) -> &mut CacheItems

Get a mutable reference to the cache items.

pub fn cache_file_exists<P>(cache_dir: P) -> bool

where P: AsRef<Path>,

Check whether the cache file exists in the given directory.

Trait Implementations

impl Debug for Cache

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Cache

type Item = (&'a Digest, &'a Artefact)

The type of the elements being iterated over.

type IntoIter = Iter<'a, Digest, Artefact>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Cache

type Item = (Digest, Artefact)

The type of the elements being iterated over.

type IntoIter = IntoIter<Digest, Artefact>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.