Struct CacheStorage 

pub struct CacheStorage { /* private fields */ }

Manages the file system storage for cached crates and their documentation

Implementations

impl CacheStorage

pub fn new(custom_cache_dir: Option<PathBuf>) -> Result<Self>

Create a new cache storage instance

pub fn cache_dir(&self) -> &Path

Get the cache directory path

pub fn crate_path(&self, name: &str, version: &str) -> Result<PathBuf>

Get the path for a specific crate version

pub fn crate_path_for_id(&self, crate_id: &CrateIdentifier) -> PathBuf

Get the path for a specific crate using CrateIdentifier

pub fn member_path( &self, name: &str, version: &str, member_name: &str, ) -> Result<PathBuf>

Get the path for a specific workspace member

pub fn source_path(&self, name: &str, version: &str) -> Result<PathBuf>

Get the source directory path for a crate

pub fn docs_path( &self, name: &str, version: &str, member_name: Option<&str>, ) -> Result<PathBuf>

Get the documentation JSON path for a crate or workspace member

pub fn metadata_path( &self, name: &str, version: &str, member_name: Option<&str>, ) -> Result<PathBuf>

Get the metadata path for a crate or workspace member

pub fn dependencies_path( &self, name: &str, version: &str, member_name: Option<&str>, ) -> Result<PathBuf>

Get the dependencies path for a crate or workspace member

pub fn search_index_path( &self, name: &str, version: &str, member_name: Option<&str>, ) -> Result<PathBuf>

Get the search index path for a crate or workspace member

pub fn is_cached(&self, name: &str, version: &str) -> bool

Check if a crate version is cached

pub fn is_member_cached( &self, name: &str, version: &str, member_path: &str, ) -> bool

Check if a workspace member is cached

Accepts full member paths (e.g., “crates/rmcp”) which are normalized internally

pub fn has_docs( &self, name: &str, version: &str, member_name: Option<&str>, ) -> bool

Check if documentation is generated for a crate or workspace member

pub fn has_search_index( &self, name: &str, version: &str, member_name: Option<&str>, ) -> bool

Check if a search index exists for a crate or workspace member

pub fn ensure_dir(&self, path: &Path) -> Result<()>

Ensure a directory exists

pub fn calculate_dir_size(&self, path: &Path) -> Result<u64>

Calculate the total size of a directory in bytes

pub fn save_metadata(&self, name: &str, version: &str) -> Result<()>

Save metadata for a crate

pub fn save_metadata_with_source( &self, name: &str, version: &str, source: &str, source_path: Option<&str>, member_info: Option<MemberInfo>, ) -> Result<()>

Save metadata for a crate with source information

pub fn load_metadata( &self, name: &str, version: &str, member_name: Option<&str>, ) -> Result<CacheMetadata>

Load metadata for a crate or workspace member

pub fn list_cached_crates(&self) -> Result<Vec<CacheMetadata>>

Get all cached crate versions

pub fn list_workspace_members( &self, name: &str, version: &str, ) -> Result<Vec<String>>

Get all workspace members for a cached crate

pub fn remove_crate(&self, name: &str, version: &str) -> Result<()>

Remove a cached crate version

pub fn backup_crate_to_temp(&self, name: &str, version: &str) -> Result<PathBuf>

Copy a crate to a temporary backup location

pub fn restore_crate_from_backup( &self, name: &str, version: &str, backup_path: &Path, ) -> Result<()>

Restore a crate from temporary backup

pub fn cleanup_backup(&self, backup_path: &Path) -> Result<()>

Clean up temporary backup

Trait Implementations

impl Clone for CacheStorage

fn clone(&self) -> CacheStorage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheStorage

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

Formats the value using the given formatter.