Trait CacheBackend

Source

pub trait CacheBackend:
    Send
    + Sync
    + Clone {
    // Required methods
    async fn get(&self, key: &str) -> Result<Option<Vec<u8>>>;
    async fn set(
        &self,
        key: &str,
        value: Vec<u8>,
        ttl: Option<Duration>,
    ) -> Result<()>;
    async fn delete(&self, key: &str) -> Result<()>;

    // Provided methods
    async fn exists(&self, key: &str) -> Result<bool> { ... }
    async fn mget(&self, keys: &[&str]) -> Result<Vec<Option<Vec<u8>>>> { ... }
    async fn mdelete(&self, keys: &[&str]) -> Result<()> { ... }
    async fn health_check(&self) -> Result<bool> { ... }
    async fn clear_all(&self) -> Result<()> { ... }
}

Expand description

Trait for cache backend implementations.

Abstracts storage operations, allowing swappable backends. Implementations: InMemory (default), Redis, Memcached, RocksDB, Database, S3, etc.

IMPORTANT: All methods use &self instead of &mut self to allow concurrent access. Backend implementations should use interior mutability (RwLock, Mutex, or external storage).

ASYNC: All methods are async and must be awaited.

Required Methods§

Source

async fn get(&self, key: &str) -> Result<Option<Vec<u8>>>

Retrieve value from cache by key.

§Returns

Ok(Some(bytes)) - Value found in cache
Ok(None) - Cache miss (key not found)

§Errors

Returns Err if backend error occurs (connection lost, etc.)

Source

async fn set( &self, key: &str, value: Vec<u8>, ttl: Option<Duration>, ) -> Result<()>

Store value in cache with optional TTL.