Struct CacheRoot 

pub struct CacheRoot { /* private fields */ }

Represents a discovered or explicit cache root directory.

Use CacheRoot::from_discovery() to find the nearest crate root from the current working directory and anchor caches under .cache, or CacheRoot::from_root(...) to construct one from an explicit path.

Implementations

impl CacheRoot

pub fn from_discovery() -> Result<Self>

Discover the cache root by searching parent directories for Cargo.toml.

The discovered cache root is always <crate-root-or-cwd>/.cache.

Note: from_discovery only uses the configured CACHE_DIR_NAME (by default .cache) as the discovered cache directory. It does not detect or prefer other custom directory names (for example .cache-v2). To use a non-standard cache root name use CacheRoot::from_root(...) with an explicit path.

Falls back to the current working directory when no crate root is found.

pub fn from_root<P: Into<PathBuf>>(root: P) -> Self

Create a CacheRoot from an explicit filesystem path.

pub fn path(&self) -> &Path

Return the underlying path for this CacheRoot.

pub fn group<P: AsRef<Path>>(&self, relative_group: P) -> CacheGroup

Build a CacheGroup for a relative subdirectory under this root.

pub fn group_path<P: AsRef<Path>>(&self, relative_group: P) -> PathBuf

Resolve a relative group path to an absolute PathBuf under this root.

pub fn ensure_group<P: AsRef<Path>>(&self, relative_group: P) -> Result<PathBuf>

Ensure the given group directory exists, creating parents as required.

pub fn ensure_group_with_policy<P: AsRef<Path>>( &self, relative_group: P, policy: Option<&EvictPolicy>, ) -> Result<PathBuf>

Ensure the given group exists and optionally apply an eviction policy.

When policy is Some, files will be evaluated and removed according to the EvictPolicy rules. Passing None performs only directory creation.

pub fn cache_path<P: AsRef<Path>, Q: AsRef<Path>>( &self, cache_dir: P, relative_path: Q, ) -> PathBuf

Resolve a cache entry path given a cache directory (relative to the root) and a relative entry path. Absolute relative_path values are returned unchanged.

Trait Implementations

impl Clone for CacheRoot

fn clone(&self) -> CacheRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheRoot

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

Formats the value using the given formatter.

impl PartialEq for CacheRoot

fn eq(&self, other: &CacheRoot) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for CacheRoot

impl StructuralPartialEq for CacheRoot