Struct WordchipperDiskCache 

pub struct WordchipperDiskCache { /* private fields */ }

Disk cache for downloaded files.

Implementations

impl WordchipperDiskCache

pub fn init(options: WordchipperDiskCacheOptions) -> Result<Self>

Construct a new WordchipperDiskCache.

pub fn cache_dir(&self) -> &Path

Get the cache directory.

pub fn data_dir(&self) -> &Path

Get the data directory.

pub fn downloader(&self) -> &Downloader

Get the downloader.

pub fn cache_path<C, F>(&self, context: &[C], file: F) -> PathBuf

where C: AsRef<Path>, F: AsRef<Path>,

Get the cache path for the given key.

• Does not check that the path exists.
• Does not initialize the containing directories.

Arguments

• context - prefix dirs, inserted between self.cache_dir and file.
• file - the final file name.

pub fn load_cached_path<C>( &mut self, context: &[C], urls: &[&str], download: bool, ) -> Result<PathBuf>

where C: AsRef<Path>,

Loads a cached file from a specified path or downloads it if it does not exist.

Arguments

• context: A slice of C containing path-related context used in determining the cache location. These paths are combined to build the cached file’s location.
• urls: A slice of string references specifying the URLs to download the file from if it is not already cached.
• download: A boolean flag indicating whether to attempt downloading the file from the provided URLs if it does not already exist in the cache.

Returns

• Returns a PathBuf pointing to the cached file if it exists or is successfully downloaded.
• Returns an error if the file is not found in the cache and downloading is not allowed or fails.

Errors

• Returns an error if the cached file does not exist and download is false.
• Returns an error if the downloading process fails.

pub fn data_path<C, F>(&self, context: &[C], file: F) -> PathBuf

where C: AsRef<Path>, F: AsRef<Path>,

Get the data path for the given key.

• Does not check that the path exists.
• Does not initialize the containing directories.

Arguments

• context - prefix dirs, inserted between self.cache_dir and file.
• file - the final file name.

Trait Implementations

impl Default for WordchipperDiskCache

fn default() -> Self

Returns the “default value” for a type.