Struct ThingsCache 

pub struct ThingsCache { /* private fields */ }

Main cache manager for Things 3 data with intelligent invalidation

Implementations

impl ThingsCache

pub fn new(config: &CacheConfig) -> Self

Create a new cache with the given configuration

pub fn new_default() -> Self

Create a new cache with default configuration

pub async fn get_tasks<F, Fut>( &self, key: &str, fetcher: F, ) -> Result<Vec<Task>>

where F: FnOnce() -> Fut, Fut: Future<Output = Result<Vec<Task>>>,

Get tasks from cache or fetch if not cached

Errors

Returns an error if the fetcher function fails.

pub async fn get_projects<F, Fut>( &self, key: &str, fetcher: F, ) -> Result<Vec<Project>>

where F: FnOnce() -> Fut, Fut: Future<Output = Result<Vec<Project>>>,

Get projects from cache or fetch if not cached

Errors

Returns an error if the fetcher function fails.

pub async fn get_areas<F, Fut>( &self, key: &str, fetcher: F, ) -> Result<Vec<Area>>

where F: FnOnce() -> Fut, Fut: Future<Output = Result<Vec<Area>>>,

Get areas from cache or fetch if not cached

Errors

Returns an error if the fetcher function fails.

pub async fn get_search_results<F, Fut>( &self, key: &str, fetcher: F, ) -> Result<Vec<Task>>

where F: FnOnce() -> Fut, Fut: Future<Output = Result<Vec<Task>>>,

Get search results from cache or fetch if not cached

Errors

Returns an error if the fetcher function fails.

pub fn invalidate_all(&self)

Invalidate all caches

pub async fn invalidate(&self, key: &str)

Invalidate specific cache entry

pub fn get_stats(&self) -> CacheStats

Get cache statistics

pub fn reset_stats(&self)

Reset cache statistics

pub fn set_preloader(&self, preloader: Arc<dyn CachePreloader>)

Register a preloader. Replaces any previously-registered preloader.

The preloader’s predict will be invoked after every get_* call, and warm will be invoked by the warming-loop tick for queued keys.

pub fn clear_preloader(&self)

Remove the registered preloader. Subsequent get_* calls and warming ticks become no-ops with respect to predictive preloading.

pub fn add_to_warming(&self, key: String, priority: u32)

Add entry to cache warming list

pub fn remove_from_warming(&self, key: &str)

Remove entry from cache warming list

pub async fn invalidate_by_entity( &self, entity_type: &str, entity_id: Option<&ThingsId>, ) -> usize

Selectively invalidate cache entries whose dependencies match (entity_type, entity_id). Returns the number of keys submitted for eviction (moka eviction may complete asynchronously).

entity_id == None is a wildcard that matches any cached entry depending on entity_type. Entries that do not depend on the mutated entity are left untouched.

pub async fn invalidate_by_operation(&self, operation: &str) -> usize

Selectively invalidate cache entries whose dependencies list operation among their invalidating operations. Returns the number of keys submitted for eviction (moka eviction may complete asynchronously).

pub fn get_warming_stats(&self) -> (usize, u32)

Get cache warming statistics

pub fn stop_cache_warming(&mut self)

Stop cache warming

Trait Implementations

impl Default for ThingsCache

fn default() -> Self

Returns the “default value” for a type.