Struct CacheConfig 

pub struct CacheConfig { /* private fields */ }

Available on crate feature cache-aio only.

Configuration for client side caching.

Implementations

impl CacheConfig

pub fn new() -> Self

Creates new CacheConfig with default values (10_000 LRU size and 30 minutes of client ttl)

pub fn set_mode(self, mode: CacheMode) -> Self

Sets how client side caching should work, default is CacheMode::All.

pub fn set_size(self, size: NonZeroUsize) -> Self

Sets maximum key count for the cache.

pub fn set_default_client_ttl(self, ttl: Duration) -> Self

Sets the default client side time to live (TTL) for cached values, this value will be used when a TTL isn’t explicitly passed with crate::Cmd::set_cache_config/crate::Pipeline::set_cache_config. Client side caching mechanism will compare client side TTL with server side TTL and pick minimum to retain in the cache. Client side TTL is the maximum time for a key to stay in cache. Server side TTL is the maximum time for a key to stay in server, it’s requested using PTTL command for each key.

Examples

let client = redis::Client::open("redis://127.0.0.1/?protocol=resp3").unwrap();
// Set default client side time to live as 60 seconds instead of 30 minutes default.
let cache_config = CacheConfig::new().set_default_client_ttl(Duration::from_secs(60));
let async_config = AsyncConnectionConfig::new().set_cache_config(cache_config);
let mut connection = client.get_multiplexed_async_connection_with_config(&async_config).await.unwrap();
// Command below will use client side time to live of 60 seconds from cache configuration.
let key_1: Option<String> = redis::cmd("GET").arg("KEY_1").query_async(&mut connection).await.unwrap();
// Command below will have client side time to live of 5 seconds;
let command_cache_config = CommandCacheConfig::new().set_client_side_ttl(Duration::from_secs(5));
let key_2: Option<String> = redis::cmd("GET").arg("KEY_2").set_cache_config(command_cache_config).query_async(&mut connection).await.unwrap();

Trait Implementations

impl Clone for CacheConfig

fn clone(&self) -> CacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheConfig

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

Formats the value using the given formatter.

impl Default for CacheConfig

fn default() -> Self

Creates new CacheConfig with default values (10_000 LRU size and 30 minutes of client ttl)

impl Copy for CacheConfig