Struct DocCache 

pub struct DocCache { /* private fields */ }

Document cache service

Implementations

impl DocCache

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

Create a new document cache

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

Get cached document

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

Set cached document

Errors

Returns an error if the cache operation fails

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

Get cached search results

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

Set cached search results

Errors

Returns an error if the cache operation fails

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

Get cached item documentation

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

Set cached item documentation

Errors

Returns an error if the cache operation fails

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

Clear cache

Errors

Returns an error if the cache operation fails

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.