Struct CacheConfig 

pub struct CacheConfig {
    pub app_name: String,
    pub cache_dir: PathBuf,
    pub max_age: Duration,
    pub max_entries: Option<usize>,
}

Configuration for the file cache system.

The cache directory defaults to the operating system’s cache folder (e.g. %LOCALAPPDATA% on Windows, ~/Library/Caches on macOS, $XDG_CACHE_HOME on Linux) joined with the application name. On platforms where no cache directory can be determined (including some Android configurations), std::env::temp_dir is used as a fallback.

Fields

app_name: String

Application name used to derive the manifest filename ("{app_name}.cache_manifest").

cache_dir: PathBuf

Filesystem directory for cache files and the manifest.

max_age: Duration

Maximum age of an entry before it becomes eligible for cleanup at application exit.

max_entries: Option<usize>

Maximum number of cache entries. None means unlimited. Enforced at application exit — new entries are never rejected.

Implementations

impl CacheConfig

pub fn new(app_name: &str) -> Self

Create a new config using the OS cache directory for the given app name.

pub fn manifest_file_name(&self) -> String

Returns the manifest filename, e.g. "my_game.cache_manifest".

pub fn file_path(&self, file_name: &str) -> PathBuf

Filesystem path for a cached file.

pub fn manifest_fs_path(&self) -> PathBuf

Filesystem path for the manifest, e.g. <cache_dir>/my_game.cache_manifest.

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

Ensure the cache directory exists on disk.

pub fn validate_key(&self, key: &str) -> Result<(), CacheError>

Validate that a cache key is a safe relative path within the cache root. Forward-slash subpaths are allowed, but traversal, absolute paths, backslashes, empty segments, and manifest filename collisions are rejected.

Trait Implementations

impl Clone for CacheConfig

fn clone(&self) -> CacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheConfig

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

Formats the value using the given formatter.

impl Default for CacheConfig

fn default() -> Self

Returns the “default value” for a type.

impl Resource for CacheConfig

where Self: Send + Sync + 'static,