Struct Cache

pub struct Cache {
    connection_manager: Arc<OnceCell<ConnectionManager>>,
    initial_connection_successful: Arc<AtomicBool>,
}

Wrapper for accessing a redis cache. Operations are non-blocking and fail gracefully when Redis is unavailable.

Fields

connection_manager: Arc<OnceCell<ConnectionManager>>

initial_connection_successful: Arc<AtomicBool>

Implementations

impl Cache

pub fn new(redis_url: &str) -> Result<Cache, UtilError>

Creates a new Redis cache instance.

This will succeed even if Redis is unavailable. Cache operations will be no-ops if Redis cannot be connected to. Will retry connecting in the background if initial connection fails.

pub async fn get_or_set<V, F, Fut, K>( &self, key: K, expires_in: Duration, f: F, ) -> Result<V, UtilError>

where V: DeserializeOwned + Serialize, F: FnOnce() -> Fut, Fut: Future<Output = Result<V, UtilError>>, K: ToRedisArgs + Send + Sync + Clone + Debug,

Retrieves a value from cache, or executes the provided function to generate and cache the value.

First checks if the key exists in the cache. If it does, returns the cached value. If not, executes the provided async function, caches its result, and returns it. Operations are non-blocking - if Redis is unavailable, the function is executed immediately.

pub async fn cache_json<V, K>( &self, key: K, value: &V, expires_in: Duration, ) -> bool

where V: Serialize, K: ToRedisArgs + Send + Sync,

Stores the given value in the redis cache as JSON. If Redis is unavailable, this function silently does nothing. This is a non-blocking operation.

pub async fn get_json<V, K>(&self, key: K) -> Option<V>

where V: DeserializeOwned, K: ToRedisArgs + Send + Sync,

Retrieves and deserializes a value from cache. If Redis is unavailable, returns None. This is a non-blocking operation.

pub async fn invalidate<K>(&self, key: K) -> bool

where K: ToRedisArgs + Send + Sync,

Delete a key from the cache. Returns true if the key was deleted, false otherwise. This is a non-blocking operation.

pub fn initial_connection_successful(&self) -> bool

Returns whether the initial connection was successful

Trait Implementations

impl Clone for Cache

fn clone(&self) -> Cache

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cache

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

Formats the value using the given formatter.