RedisCache

Struct RedisCache 

Source
pub struct RedisCache { /* private fields */ }
Expand description

Redis cache implementation with connection pooling

This struct wraps a Redis ConnectionManager and provides cache operations with automatic key prefixing for namespace isolation.

§Connection Management

Uses ConnectionManager which provides:

  • Automatic reconnection on connection loss
  • Connection health checks
  • Async operation support
  • Internal connection pooling

§Key Prefixing

All keys are automatically prefixed to avoid collisions:

  • User provides: "user:123"
  • Stored as: "warpdrive:cache:user:123" (if prefix is "warpdrive:cache:")

Implementations§

Source§

impl RedisCache

Source

pub async fn from_url(url: &str, prefix: String) -> Result<Self>

Create a new Redis cache from connection URL

§Parameters
  • url: Redis connection URL (e.g., "redis://localhost:6379")
  • prefix: Key prefix for namespace isolation (e.g., "warpdrive:cache:")
§Errors

Returns an error if:

  • URL is invalid
  • Cannot connect to Redis server
  • Authentication fails
§Example
let cache = RedisCache::from_url(
    "redis://localhost:6379/0",
    "myapp:".to_string()
).await?;
Source

pub async fn batch_get(&self, keys: &[String]) -> Result<Vec<Option<Vec<u8>>>>

Batch get multiple keys

Retrieves multiple values in a single round trip using Redis pipelining. This is significantly more efficient than multiple individual GET operations.

§Returns

A vector of Option<Vec<u8>> corresponding to the input keys. None indicates the key was not found or expired.

§Example
let keys = vec!["user:1".to_string(), "user:2".to_string()];
let values = cache.batch_get(&keys).await?;

for (key, value) in keys.iter().zip(values.iter()) {
    match value {
        Some(data) => println!("{}: {} bytes", key, data.len()),
        None => println!("{}: not found", key),
    }
}
Source

pub async fn batch_delete(&self, keys: &[String]) -> Result<()>

Batch delete multiple keys

Deletes multiple keys in a single round trip using Redis DEL. Returns Ok(()) regardless of whether keys existed.

§Example
let keys = vec!["user:1".to_string(), "user:2".to_string()];
cache.batch_delete(&keys).await?;
Source

pub async fn clear_prefix(&self, pattern: &str) -> Result<usize>

Clear all keys matching a pattern

Deletes all keys matching the given pattern (after prefixing). Uses SCAN + DEL for safe iteration without blocking Redis.

§Warning

This operation scans the entire keyspace and can be slow on large datasets. Use sparingly and consider the impact on Redis performance.

§Parameters
  • pattern: Glob-style pattern (e.g., "user:*", "session:*")
§Returns

The number of keys deleted.

§Example
// Delete all user cache entries
let count = cache.clear_prefix("user:*").await?;
println!("Cleared {} user entries", count);
Source

pub fn connection(&self) -> ConnectionManager

Get connection manager for advanced operations

Provides access to the underlying ConnectionManager for operations not covered by the Cache trait (e.g., INCR, ZADD, etc.).

§Example
let mut conn = cache.connection();
let count: i64 = conn.incr("page_views", 1).await?;

Trait Implementations§

Source§

impl Cache for RedisCache

Source§

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Retrieve a value from cache by key Read more
Source§

fn set<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, value: &'life2 [u8], ttl_seconds: u64, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Store a value in cache with TTL Read more
Source§

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a value from cache Read more
Source§

fn exists<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Check if a key exists in cache Read more
Source§

impl Clone for RedisCache

Source§

fn clone(&self) -> RedisCache

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

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

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