CacheManager

Struct CacheManager 

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

Cache manager for handling both Redis and in-memory caching.

Provides a unified interface for caching operations with automatic fallback from Redis to in-memory storage on failures.

§Thread Safety

All operations are thread-safe and can be used concurrently.

§Example

let config = CacheConfig {
    enabled: true,
    backend: CacheBackend::Redis { url: "redis://localhost:6379".to_string() },
    ttl: Duration::from_secs(3600),
    max_size: 1000,
};

let cache_manager = CacheManager::new(config).await?;

Implementations§

Source§

impl CacheManager

Source

pub async fn new(config: CacheConfig) -> Result<Self, GatewayError>

Create a new cache manager with the specified configuration.

Initializes the cache manager with either Redis or in-memory backend based on the configuration. Falls back to in-memory if Redis is unavailable.

§Arguments
  • config - Cache configuration including backend and settings
§Returns

Returns a new CacheManager instance.

§Errors

Returns an error if the cache manager cannot be initialized.

Source

pub async fn get(&self, key: &str) -> Option<Value>

Retrieve a value from the cache.

Attempts to retrieve a value from Redis first, then falls back to in-memory storage. Returns None if the key doesn’t exist or has expired.

§Arguments
  • key - The cache key to retrieve
§Returns

Returns the cached value if found and not expired, None otherwise.

Source

pub async fn set(&self, key: &str, value: Value, custom_ttl: Option<Duration>)

Cache a value in the cache.

Attempts to cache a value using Redis first, then falls back to in-memory storage.

§Arguments
  • key - The cache key to set
  • value - The value to cache as a JSON value
  • custom_ttl - Optional custom TTL for this entry, overrides config
§Example
let key = CacheKeyBuilder::chat_completion_key("gpt-4", &messages_hash);
cache_manager.set(&key, response_data, None).await;
Source

pub async fn invalidate(&self, key: &str)

Invalidate a single cache entry.

Attempts to invalidate a cache entry using Redis first, then falls back to in-memory storage.

§Arguments
  • key - The cache key to invalidate
§Example
let key = CacheKeyBuilder::chat_completion_key("gpt-4", &messages_hash);
cache_manager.invalidate(&key).await;
Source

pub async fn clear(&self)

Clear the entire cache.

Attempts to clear the cache using Redis first, then falls back to in-memory storage.

§Example
cache_manager.clear().await;
Source

pub async fn stats(&self) -> CacheStats

Get current cache statistics.

Returns statistics about the cache, including total entries, expired entries, and memory usage.

§Returns

Returns a CacheStats struct containing the statistics.

Source

pub fn has_redis(&self) -> bool

Returns true if Redis backend is available

Source

pub async fn incr_with_expiry( &self, key: &str, expiry_secs: usize, ) -> Result<i64, GatewayError>

Atomically increment a key with an expiry. If the key is new, expiry is set.

Source

pub async fn incr_by_with_expiry( &self, key: &str, by: i64, expiry_secs: usize, ) -> Result<i64, GatewayError>

Atomically increment a key by a specific amount with an expiry. If the key is new, expiry is set.

Trait Implementations§

Source§

impl Debug for CacheManager

Source§

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

Formats the value using the given formatter. 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> 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> PolicyExt for T
where T: ?Sized,

Source§

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

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

Source§

type Output = T

Should always be Self
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,