Trait CacheBackend 

pub trait CacheBackend:
    Send
    + Sync
    + 'static {
    // Required methods
    fn get<T>(
        &self,
        key: &CacheKey,
    ) -> impl Future<Output = CacheResult<Option<T>>> + Send
       where T: DeserializeOwned;
    fn set<T>(
        &self,
        key: &CacheKey,
        value: &T,
        ttl: Option<Duration>,
    ) -> impl Future<Output = CacheResult<()>> + Send
       where T: Serialize + Sync;
    fn delete(
        &self,
        key: &CacheKey,
    ) -> impl Future<Output = CacheResult<bool>> + Send;
    fn exists(
        &self,
        key: &CacheKey,
    ) -> impl Future<Output = CacheResult<bool>> + Send;
    fn invalidate_pattern(
        &self,
        pattern: &KeyPattern,
    ) -> impl Future<Output = CacheResult<u64>> + Send;
    fn invalidate_tags(
        &self,
        tags: &[EntityTag],
    ) -> impl Future<Output = CacheResult<u64>> + Send;
    fn clear(&self) -> impl Future<Output = CacheResult<()>> + Send;
    fn len(&self) -> impl Future<Output = CacheResult<usize>> + Send;

    // Provided methods
    fn get_many<T>(
        &self,
        keys: &[CacheKey],
    ) -> impl Future<Output = CacheResult<Vec<Option<T>>>> + Send
       where T: DeserializeOwned + Send { ... }
    fn set_many<T>(
        &self,
        entries: &[(&CacheKey, &T)],
        ttl: Option<Duration>,
    ) -> impl Future<Output = CacheResult<()>> + Send
       where T: Serialize + Sync + Send { ... }
    fn delete_many(
        &self,
        keys: &[CacheKey],
    ) -> impl Future<Output = CacheResult<u64>> + Send { ... }
    fn is_empty(&self) -> impl Future<Output = CacheResult<bool>> + Send { ... }
    fn stats(&self) -> impl Future<Output = CacheResult<BackendStats>> + Send { ... }
}

The core trait for cache backends.

This trait defines the interface that all cache backends must implement. It supports both synchronous and asynchronous operations.

Required Methods

fn get<T>( &self, key: &CacheKey, ) -> impl Future<Output = CacheResult<Option<T>>> + Send

where T: DeserializeOwned,

Get a value from the cache.

fn set<T>( &self, key: &CacheKey, value: &T, ttl: Option<Duration>, ) -> impl Future<Output = CacheResult<()>> + Send

where T: Serialize + Sync,

Set a value in the cache.

fn delete( &self, key: &CacheKey, ) -> impl Future<Output = CacheResult<bool>> + Send

Delete a value from the cache.

fn exists( &self, key: &CacheKey, ) -> impl Future<Output = CacheResult<bool>> + Send

Check if a key exists.

fn invalidate_pattern( &self, pattern: &KeyPattern, ) -> impl Future<Output = CacheResult<u64>> + Send

Invalidate entries matching a pattern.

fn invalidate_tags( &self, tags: &[EntityTag], ) -> impl Future<Output = CacheResult<u64>> + Send

Invalidate entries by tags.

fn clear(&self) -> impl Future<Output = CacheResult<()>> + Send

Clear all entries.

fn len(&self) -> impl Future<Output = CacheResult<usize>> + Send

Get the approximate number of entries.

Provided Methods

fn get_many<T>( &self, keys: &[CacheKey], ) -> impl Future<Output = CacheResult<Vec<Option<T>>>> + Send

where T: DeserializeOwned + Send,

Get multiple values at once.

Default implementation fetches sequentially. Override for batch optimization.

fn set_many<T>( &self, entries: &[(&CacheKey, &T)], ttl: Option<Duration>, ) -> impl Future<Output = CacheResult<()>> + Send

where T: Serialize + Sync + Send,

Set multiple values at once.

Default implementation sets sequentially. Override for batch optimization.

fn delete_many( &self, keys: &[CacheKey], ) -> impl Future<Output = CacheResult<u64>> + Send

Delete multiple keys at once.

Default implementation deletes sequentially. Override for batch optimization.

fn is_empty(&self) -> impl Future<Output = CacheResult<bool>> + Send

Check if the cache is empty.

fn stats(&self) -> impl Future<Output = CacheResult<BackendStats>> + Send

Get cache statistics if available.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl CacheBackend for MemoryCache

impl CacheBackend for RedisCache

impl<L1, L2> CacheBackend for TieredCache<L1, L2>

where L1: CacheBackend, L2: CacheBackend,