Struct CrateCache 

pub struct CrateCache { /* private fields */ }

Service for managing crate caching and documentation generation

Implementations

impl CrateCache

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

Create a new crate cache instance

pub async fn ensure_crate_docs( &self, name: &str, version: &str, source: Option<&str>, ) -> Result<Crate>

Ensure a crate’s documentation is available, downloading and generating if necessary

pub async fn ensure_workspace_member_docs( &self, name: &str, version: &str, source: Option<&str>, member_path: &str, ) -> Result<Crate>

Ensure a workspace member’s documentation is available

pub async fn ensure_crate_or_member_docs( &self, name: &str, version: &str, member: Option<&str>, ) -> Result<Crate>

Ensure documentation is available for a crate or workspace member

pub async fn download_or_copy_crate( &self, name: &str, version: &str, source: Option<&str>, ) -> Result<PathBuf>

Download or copy a crate based on source type

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

Generate JSON documentation for a crate

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

Generate JSON documentation for a workspace member

pub async fn load_docs( &self, name: &str, version: &str, member_name: Option<&str>, ) -> Result<Crate>

Load documentation from cache for a crate or workspace member

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

Get cached versions of a crate

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

Get all cached crates with their metadata

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

Remove a cached crate version

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

Check if docs exist without ensuring they’re generated

pub async fn try_load_docs( &self, crate_name: &str, version: &str, member: Option<&str>, ) -> Result<Option<Crate>>

Try to load existing docs without generating

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

Get the source path for a crate

pub async fn ensure_crate_source( &self, name: &str, version: &str, source: Option<&str>, ) -> Result<PathBuf>

Ensure a crate’s source is available, downloading if necessary (without generating docs)

pub async fn ensure_crate_or_member_source( &self, name: &str, version: &str, member: Option<&str>, source: Option<&str>, ) -> Result<PathBuf>

Ensure source is available for a crate or workspace member

pub async fn load_dependencies( &self, name: &str, version: &str, ) -> Result<Value>

Load dependency information from cache

pub async fn cache_crate_with_source(&self, source: CrateSource) -> String

Common method to cache a crate from any source

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

Create search index for a crate or workspace member (exposed for search module)

Trait Implementations

impl Clone for CrateCache

fn clone(&self) -> CrateCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CrateCache

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

Formats the value using the given formatter.