CacheConfig in redis::caching - Rust
Description: Configuration for client side caching.

Skip to main content

## CacheConfig

# Struct CacheConfig

Source

    pub struct CacheConfig { /* private fields */ }

Available on crate feature `cache-aio` only.
Expand description

Configuration for client side caching.

## Implementations§

Source§

### impl CacheConfig

Source

#### pub fn new() -> Self

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

Source

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

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

Source

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

Sets maximum key count for the cache.

Source

#### 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§

Source§

### impl Clone for CacheConfig

Source§

#### fn clone(&self) -> CacheConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for CacheConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl Default for CacheConfig

Source§

#### fn default() -> Self

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

Source§

### impl Copy for CacheConfig

## Auto Trait Implementations§

§

### impl Freeze for CacheConfig

§

### impl RefUnwindSafe for CacheConfig

§

### impl Send for CacheConfig

§

### impl Sync for CacheConfig

§

### impl Unpin for CacheConfig

§

### impl UnwindSafe for CacheConfig

## Blanket Implementations§

Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

§

### impl<T> Instrument for T

§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [`Span`], returning an `Instrumented` wrapper. Read more
§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

§

### impl<T> PolicyExt for T
where T: ?Sized,

§

#### fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] only if `self` and `other` return `Action::Follow`. Read more
§

#### fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new `Policy` that returns [`Action::Follow`] if either `self` or `other` returns `Action::Follow`. Read more
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

#### fn vzip(self) -> V

§

### impl<T> WithSubscriber for T

§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a [`WithDispatch`] wrapper. Read more
§

### impl<T> ErasedDestructor for T
where T: 'static,

§

### impl<T> MaybeSendSync for T