Struct AsyncRedisCache

pub struct AsyncRedisCache<K, V> { /* private fields */ }

Available on crate feature async and crate feature redis_store and (crate features redis_async_std or redis_tokio) only.

Cache store backed by redis

Values have a ttl applied and enforced by redis. Uses a redis::aio::MultiplexedConnection or redis::aio::ConnectionManager under the hood depending if feature redis_connection_manager is used or not.

Implementations

impl<K, V> AsyncRedisCache<K, V>

where K: Display Send Sync, V: Serialize DeserializeOwned Send Sync,

pub fn new<S: AsRef<str>>( prefix: S, seconds: u64, ) -> AsyncRedisCacheBuilder<K, V>

Initialize an AsyncRedisCacheBuilder

pub fn connection_string(&self) -> String

Return the redis connection string used

Trait Implementations

impl<K, V> IOCachedAsync<K, V> for AsyncRedisCache<K, V>

where K: Display Send Sync, V: Serialize DeserializeOwned Send Sync,

fn cache_get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 K, ) -> Pin<Box<dyn Future<Output = Result<Option<V>, Self::Error>> Send 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature async only.

Get a cached value

fn cache_set<'life0, 'async_trait>( &'life0 self, key: K, val: V, ) -> Pin<Box<dyn Future<Output = Result<Option<V>, Self::Error>> Send 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Available on crate feature async only.

Set a cached value

fn cache_remove<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 K, ) -> Pin<Box<dyn Future<Output = Result<Option<V>, Self::Error>> Send 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Available on crate feature async only.

Remove a cached value

fn cache_set_refresh(&mut self, refresh: bool) -> bool

Available on crate feature async only.

Set the flag to control whether cache hits refresh the ttl of cached values, returns the old flag value

fn cache_lifespan(&self) -> Option<u64>

Available on crate feature async only.

Return the lifespan of cached values (time to eviction)

fn cache_set_lifespan(&mut self, seconds: u64) -> Option<u64>

Available on crate feature async only.

Set the lifespan of cached values, returns the old value

type Error = RedisCacheError

Available on crate feature async only.

fn cache_unset_lifespan(&mut self) -> Option<u64>

Available on crate feature async only.

Remove the lifespan for cached values, returns the old value.