Struct DiskCacheConfig 

pub struct DiskCacheConfig {
    pub root_cache_key: String,
}

Cache Policy

Fields

root_cache_key: String

Key for the root cache directory.

Implementations

impl DiskCacheConfig

pub fn new() -> Self

Create a new instance of the config.

Arguments

Default Arguments

root_cache_key

Key for the root cache directory.

• Defaults to "\"bimm\".to_string()"

impl DiskCacheConfig

pub fn with_root_cache_key(self, root_cache_key: String) -> Self

Sets the value for the field root_cache_key.

Key for the root cache directory.

• Defaults to "\"bimm\".to_string()"

impl DiskCacheConfig

pub fn base_cache_dir(&self) -> Result<PathBuf>

Fetch the base cache directory.

If the cache directory does not exist, does not create it.

pub fn ensure_base_cache_dir(&self) -> Result<PathBuf>

Fetch the base cache directory.

If the cache directory does not exist, creates it.

pub fn resource_to_path(&self, resource_key: &[String]) -> Result<PathBuf>

Map a resource key to a cache path.

Does not ensure that the path (or any of the parents) exist.

pub fn ensure_resource_parent_dir( &self, resource_key: &[String], ) -> Result<PathBuf>

Map a resource key to a cache path and ensure the parent directory exists.

pub fn fetch_resource(&self, url: &str, resource: &[String]) -> Result<PathBuf>

Fetch a Resource to the Cache.

Trait Implementations

impl Clone for DiskCacheConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Config for DiskCacheConfig

fn save<P>(&self, file: P) -> Result<(), Error>

where P: AsRef<Path>,

Saves the configuration to a file.

fn load<P>(file: P) -> Result<Self, ConfigError>

where P: AsRef<Path>,

Loads the configuration from a file.

fn load_binary(data: &[u8]) -> Result<Self, ConfigError>

Loads the configuration from a binary buffer.

impl Debug for DiskCacheConfig

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

Formats the value using the given formatter.

impl Default for DiskCacheConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DiskCacheConfig

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DiskCacheConfig

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

Formats the value using the given formatter.

impl Serialize for DiskCacheConfig

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.