Struct cached_path::Cache

pub struct Cache {
    pub dir: PathBuf,
    /* private fields */
}

Fetches and manages resources in a local cache directory.

Fields

dir: PathBuf

The root directory of the cache.

Implementations

impl Cache

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

Create a new Cache instance.

pub fn builder() -> CacheBuilder

Create a CacheBuilder.

pub fn cached_path(&self, resource: &str) -> Result<PathBuf, Error>

Get the cached path to a resource.

If the resource is local file, it’s path is returned. If the resource is a static HTTP resource, it will cached locally and the path to the cache file will be returned.

pub fn cached_path_with_options( &self, resource: &str, options: &Options ) -> Result<PathBuf, Error>

Get the cached path to a resource using the given options.

Examples

Use a particular subdirectory of the cache root:

let path = cache.cached_path_with_options(
    resource,
    &Options::default().subdir(subdir),
).unwrap();

Treat the resource as an archive and extract it. The path returned is the path to the extraction directory:

let path = cache.cached_path_with_options(
    resource,
    &Options::default().extract(),
).unwrap();
assert!(path.is_dir());

pub fn cached_path_in_subdir( &self, resource: &str, subdir: Option<&str> ) -> Result<PathBuf, Error>

👎Deprecated since 0.4.4: Please use Cache::cached_path_with_options() instead

A convenience method to get the cached path to a resource using the given cache subdirectory (relative to the cache root).

This is equivalent to:

let path = cache.cached_path_with_options(
    resource,
    &Options::default().subdir(subdir),
).unwrap();

Trait Implementations

impl Clone for Cache

fn clone(&self) -> Cache

Returns a copy 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.