Struct IndexCache

pub struct IndexCache { /* private fields */ }

The IndexCache allows access to the local cache entries for a remote index

This implementation does no network I/O whatsoever, but does do disk I/O

Implementations

impl IndexCache

pub fn at_path(path: PathBuf) -> Self

Creates a local index exactly at the specified path

pub fn cached_krate( &self, name: KrateName<'_>, revision: Option<&str>, lock: &FileLock, ) -> Result<Option<IndexKrate>, Error>

Reads a crate from the local cache of the index.

You may optionally pass in the revision the cache entry is expected to have, if it does match the cache entry will be ignored and an error returned

pub fn write_to_cache( &self, krate: &IndexKrate, revision: &str, _lock: &FileLock, ) -> Result<PathBuf, Error>

Writes the specified crate and revision to the cache

pub fn cache_path(&self, name: KrateName<'_>) -> PathBuf

Gets the path the crate’s cache file would be located at if it exists

pub fn read_cache_file( &self, name: KrateName<'_>, _lock: &FileLock, ) -> Result<Option<Vec<u8>>, Error>

Attempts to read the cache entry for the specified crate

It is recommended to use Self::cached_krate