Struct FusionCache

pub struct FusionCache<TKey: Hash + Eq + Send + Sync + Clone + Serialize + DeserializeOwned + 'static, TValue: Clone + Send + Sync + Serialize + DeserializeOwned + 'static> { /* private fields */ }

The main struct of the fusioncache-rs library.

This struct is used to create a cache that can be used to store and retrieve values.

Implementations

impl<TKey: Hash + Eq + Send + Sync + Clone + Serialize + DeserializeOwned + Debug + 'static, TValue: Clone + Send + Sync + Serialize + DeserializeOwned + Debug + 'static> FusionCache<TKey, TValue>

pub async fn get_or_set<TError: Clone + Send + Sync + Display + 'static, F: Factory<TKey, TValue, TError>>( &mut self, key: TKey, factory: F, options: Option<FusionCacheOptions>, ) -> Result<TValue, FusionCacheError>

Retrieves a value from the cache, or generates it using the provided factory if not found. If the distributed cache is enabled, the value will be retrieved and written to the distributed cache as well.

This method implements a sophisticated cache stampede protection mechanism:

• If the value exists in cache, returns it immediately
• If the value is being generated by another request, waits for and returns that result
• If no request is in flight, generates the value using the factory

Arguments

• key - The key to look up in the cache
• factory - The factory to use for generating the value if not found
• options - The options to use for this specifc entry. If not provided, the default options will be used.

Returns

• Ok(TValue) - The cached or newly generated value
• Err(FusionCacheError) - If value generation failed or timed out

pub async fn get(&mut self, key: TKey) -> Option<TValue>

Retrieves a value from the cache without invoking the factory.

Arguments

• key - The key to look up in the cache

Returns

• Some(TValue) - The cached value if it exists
• None - If the value is not in the cache

pub async fn set( &mut self, key: TKey, value: TValue, options: Option<FusionCacheOptions>, )

Directly sets a value in the cache.

Arguments

• key - The key under which to store the value
• value - The value to store
• options - The options to use for this specifc entry. If not provided, the default options will be used.

pub async fn evict(&mut self, key: TKey)

Removes a value from the cache.

Arguments

• key - The key to remove from the cache

Trait Implementations

impl<TKey: Clone + Hash + Eq + Send + Sync + Clone + Serialize + DeserializeOwned + 'static, TValue: Clone + Clone + Send + Sync + Serialize + DeserializeOwned + 'static> Clone for FusionCache<TKey, TValue>

fn clone(&self) -> FusionCache<TKey, TValue>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<TKey: Debug + Hash + Eq + Send + Sync + Clone + Serialize + DeserializeOwned + 'static, TValue: Debug + Clone + Send + Sync + Serialize + DeserializeOwned + 'static> Debug for FusionCache<TKey, TValue>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.