Struct DocCache 

pub struct DocCache { /* private fields */ }

Document cache service

Provides document-specific cache operations, supports crate docs, search results, and item docs.

Fields

• cache: Underlying cache instance
• ttl: TTL configuration
• stats: Cache statistics

Implementations

impl DocCache

pub fn new(cache: Arc<dyn Cache>) -> Self

Create new document cache (with default TTL)

Arguments

• cache - cache instance

Examples

use std::sync::Arc;
use crates_docs::tools::docs::cache::DocCache;
use crates_docs::cache::memory::MemoryCache;

let cache = Arc::new(MemoryCache::new(1000));
let doc_cache = DocCache::new(cache);

pub fn with_ttl(cache: Arc<dyn Cache>, ttl: DocCacheTtl) -> Self

Create new document cache (with custom TTL)

Arguments

• cache - cache instance
• ttl - TTL configuration

Examples

use std::sync::Arc;
use crates_docs::tools::docs::cache::{DocCache, DocCacheTtl};
use crates_docs::cache::memory::MemoryCache;

let cache = Arc::new(MemoryCache::new(1000));
let ttl = DocCacheTtl::with_jitter(
    7200,  // crate_docs_secs
    600,   // search_results_secs
    3600,  // item_docs_secs
    0.1,   // jitter_ratio
);
let doc_cache = DocCache::with_ttl(cache, ttl);

pub async fn get_crate_docs( &self, crate_name: &str, version: Option<&str>, ) -> Option<Arc<str>>

Get cached crate documentation

Arguments

• crate_name - crate name
• version - Optional version

Returns

Returns document content if cache hit; otherwise returns None

pub async fn set_crate_docs( &self, crate_name: &str, version: Option<&str>, content: String, ) -> Result<()>

Set crate document cache

Arguments

• crate_name - crate name
• version - Optional version
• content - Document content

Errors

Returns error if cache operation fails

pub async fn get_crate_html( &self, crate_name: &str, version: Option<&str>, ) -> Option<Arc<str>>

Get cached crate HTML

Returns Arc<str> to avoid unnecessary cloning on cache hits. The caller can clone if an owned String is needed.

pub async fn set_crate_html( &self, crate_name: &str, version: Option<&str>, content: String, ) -> Result<()>

Set crate HTML cache

Errors

Returns error if cache operation fails

pub async fn get_search_results( &self, query: &str, limit: u32, sort: Option<&str>, ) -> Option<Arc<str>>

Get cached search results

Arguments

• query - Search query
• limit - Result count limit
• sort - Optional search sort order

Returns

Returns search results if cache hit;otherwise returns None

pub async fn set_search_results( &self, query: &str, limit: u32, sort: Option<&str>, content: String, ) -> Result<()>

Set search results cache

Arguments

• query - Search query
• limit - Result count limit
• sort - Optional search sort order
• content - search result content

Errors

Returns error if cache operation fails

pub async fn get_item_docs( &self, crate_name: &str, item_path: &str, version: Option<&str>, ) -> Option<Arc<str>>

Get cached item docs

Arguments

• crate_name - crate name
• item_path - Item path
• version - Optional version

Returns

Returns item docs if cache hit;otherwise returns None

pub async fn set_item_docs( &self, crate_name: &str, item_path: &str, version: Option<&str>, content: String, ) -> Result<()>

Set item docs cache

Arguments

• crate_name - crate name
• item_path - Item path
• version - Optional version
• content - Document content

Errors

Returns error if cache operation fails

pub async fn get_item_html( &self, crate_name: &str, item_path: &str, version: Option<&str>, ) -> Option<Arc<str>>

Get cached item HTML

Returns Arc<str> to avoid unnecessary cloning on cache hits. The caller can clone if an owned String is needed.

pub async fn set_item_html( &self, crate_name: &str, item_path: &str, version: Option<&str>, content: String, ) -> Result<()>

Set item HTML cache

Errors

Returns error if cache operation fails

pub async fn clear(&self) -> Result<()>

Clear cache

Errors

Returns error if cache operation fails

pub fn stats(&self) -> &CacheStats

Get cache statistics

pub fn ttl(&self) -> &DocCacheTtl

Get TTL configuration

Trait Implementations

impl Clone for DocCache

fn clone(&self) -> DocCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for DocCache

fn default() -> Self

Returns the “default value” for a type.