Struct ProviderCache 

pub struct ProviderCache {
    pub cache: Arc<Mutex<HashMap<String, CacheEntry>>>,
}

Global cache for provider results with automatic cleanup

Fields

cache: Arc<Mutex<HashMap<String, CacheEntry>>>

Implementations

impl ProviderCache

pub fn new() -> Self

Creates a new provider cache.

Returns

A new ProviderCache instance.

pub fn get<T: Clone + Send + Sync + 'static>(&self, key: &str) -> Option<T>

Retrieves a cached result by key.

Arguments

• &self - A reference to the ProviderCache.
• key - The key to retrieve.

Returns

An Option<T> containing the cached data if available, or None if not found.

Side Effects

None.

pub fn get_with_options<T: Clone + Send + Sync + 'static>( &self, key: &str, options: CacheGetOptions, ) -> Option<CacheGetResult<T>>

Retrieves a cached result with configurable options

This unified method handles expiration, staleness checking, and other cache retrieval options.

Arguments

• &self - A reference to the ProviderCache.
• key - The key to retrieve.
• options - Cache retrieval options (expiration, stale time, etc.)

Returns

An Option<CacheGetResult<T>> containing the cached data and staleness info if available.

Example

use dioxus_provider::cache::{ProviderCache, CacheGetOptions};
use std::time::Duration;

let cache = ProviderCache::new();
let options = CacheGetOptions::new()
    .with_expiration(Duration::from_secs(300))
    .with_stale_time(Duration::from_secs(60));

if let Some(result) = cache.get_with_options::<String>("my_key", options) {
    println!("Data: {}, Stale: {}", result.data, result.is_stale);
}

pub fn get_with_expiration<T: Clone + Send + Sync + 'static>( &self, key: &str, expiration: Option<Duration>, ) -> Option<T>

👎Deprecated since 0.1.0: Use get_with_options() instead for more flexible cache retrieval

Retrieves a cached result by key, checking for expiration with a specific expiration duration.

Deprecated

Use get_with_options() instead for more flexible cache retrieval.

Arguments

• &self - A reference to the ProviderCache.
• key - The key to retrieve.
• expiration - An optional duration after which the entry is considered expired.

Returns

An Option<T> containing the cached data if available and not expired, or None if expired.

Side Effects

If expired, the entry is removed from the cache.

pub fn get_with_staleness<T: Clone + Send + Sync + 'static>( &self, key: &str, stale_time: Option<Duration>, expiration: Option<Duration>, ) -> Option<(T, bool)>

👎Deprecated since 0.1.0: Use get_with_options() instead for more flexible cache retrieval

Retrieves cached data with staleness information for SWR behavior.

Deprecated

Use get_with_options() instead for more flexible cache retrieval.

Arguments

• &self - A reference to the ProviderCache.
• key - The key to retrieve.
• stale_time - An optional duration after which the entry is considered stale.
• expiration - An optional duration after which the entry is considered expired.

Returns

An Option<(T, bool)> containing the cached data and a boolean indicating staleness.

Side Effects

None.

pub fn set<T: Clone + Send + Sync + PartialEq + 'static>( &self, key: String, value: T, ) -> bool

Sets a value for a given key.

Arguments

• &self - A reference to the ProviderCache.
• key - The key to set.
• value - The value to set.

Returns

A boolean indicating whether the value was updated (true) or unchanged (false).

Side Effects

Updates the cached_at timestamp if the value was updated.

pub fn remove(&self, key: &str) -> bool

Removes a cached result by key.

Arguments

• &self - A reference to the ProviderCache.
• key - The key to remove.

Returns

A boolean indicating whether the entry was removed.

Side Effects

None.

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

Invalidates a cached result by key (alias for remove).

Arguments

• &self - A reference to the ProviderCache.
• key - The key to invalidate.

Side Effects

The entry is removed from the cache.

pub fn clear(&self)

Clears all cached results.

Arguments

• &self - A reference to the ProviderCache.

Side Effects

All entries are removed from the cache.

pub fn size(&self) -> usize

Gets the number of cached entries.

Arguments

• &self - A reference to the ProviderCache.

Returns

The number of cached entries as a usize.

Side Effects

None.

pub fn cleanup_unused_entries(&self, unused_threshold: Duration) -> usize

Cleans up unused entries based on access time.

Arguments

• &self - A reference to the ProviderCache.
• unused_threshold - The duration after which an entry is considered unused.

Returns

The number of unused entries removed.

Side Effects

Unused entries are removed from the cache.

pub fn evict_lru_entries(&self, max_size: usize) -> usize

Evicts least recently used entries to maintain cache size limit.

Arguments

• &self - A reference to the ProviderCache.
• max_size - The maximum number of entries to keep.

Returns

The number of entries evicted.

Side Effects

Least recently used entries are removed from the cache.

pub fn maintain(&self) -> CacheMaintenanceStats

Performs comprehensive cache maintenance.

Arguments

• &self - A reference to the ProviderCache.

Returns

A CacheMaintenanceStats containing statistics about the maintenance.

Side Effects

Unused entries are removed and LRU entries are evicted.

pub fn stats(&self) -> CacheStats

Gets cache statistics.

Arguments

• &self - A reference to the ProviderCache.

Returns

A CacheStats containing statistics about the cache.

Side Effects

None.

Trait Implementations

impl Clone for ProviderCache

fn clone(&self) -> ProviderCache

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for ProviderCache

fn default() -> ProviderCache

Returns the “default value” for a type.