Struct DocCache 

pub struct DocCache { /* private fields */ }

文档缓存服务

提供文档专用的缓存操作，支持 crate 文档、搜索结果和项目文档。

字段

• cache: 底层缓存实例
• ttl: TTL 配置

Implementations

impl DocCache

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

创建新的文档缓存（使用默认 TTL）

参数

• cache - 缓存实例

示例

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

创建新的文档缓存（使用自定义 TTL）

参数

• cache - 缓存实例
• ttl - TTL 配置

示例

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 {
    crate_docs_secs: 7200,
    search_results_secs: 600,
    item_docs_secs: 3600,
    jitter_ratio: 0.1,
};
let doc_cache = DocCache::with_ttl(cache, ttl);

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

获取缓存的 crate 文档

参数

• crate_name - crate 名称
• version - 可选的版本号

返回值

如果缓存命中，返回文档内容；否则返回 None

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

设置 crate 文档缓存

参数

• crate_name - crate 名称
• version - 可选的版本号
• content - 文档内容

错误

如果缓存操作失败，返回错误

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

获取缓存的搜索结果

参数

• query - 搜索查询
• limit - 结果数量限制

返回值

如果缓存命中，返回搜索结果；否则返回 None

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

设置搜索结果缓存

参数

• query - 搜索查询
• limit - 结果数量限制
• content - 搜索结果内容

错误

如果缓存操作失败，返回错误

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

获取缓存的项目文档

参数

• crate_name - crate 名称
• item_path - 项目路径
• version - 可选的版本号

返回值

如果缓存命中，返回项目文档；否则返回 None

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

设置项目文档缓存

参数

• crate_name - crate 名称
• item_path - 项目路径
• version - 可选的版本号
• content - 文档内容

错误

如果缓存操作失败，返回错误

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

清除缓存

错误

如果缓存操作失败，返回错误

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.