Skip to main content

CacheLayer

Struct CacheLayer 

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

A two-backend response cache: in-memory (default) or Redis (feature caching).

Use CacheLayer::new_memory for single-process deployments or testing. Use CacheLayer::new_redis (feature caching) when multiple pipeline instances need a shared cache.

§Eviction

The in-memory backend evicts the entry with the nearest expiry when the max_entries limit is reached (O(n) scan). For large caches consider a dedicated LRU crate.

Entries with ttl_secs == 0 are silently ignored by CacheLayer::set.

§Thread safety

CacheLayer is Clone + Send + Sync. All clones share the same Arc<MemoryCache>.

§Examples

use tokio_prompt_orchestrator::enhanced::CacheLayer;

let cache = CacheLayer::new_memory(1000);
cache.set("prompt:abc", "response text", 3600).await;

if let Some(hit) = cache.get("prompt:abc").await {
    println!("cache hit: {hit}");
}

Implementations§

Source§

impl CacheLayer

Source

pub fn new_memory(max_entries: usize) -> Self

Create an in-memory CacheLayer with a maximum entry count.

When max_entries is reached, the entry nearest to expiry is evicted before inserting the new value.

§Arguments
  • max_entries — Soft cap on the number of cached entries. Use 0 to disable the cap (entries accumulate until evicted by TTL checks on get).
§Examples
use tokio_prompt_orchestrator::enhanced::CacheLayer;

let cache = CacheLayer::new_memory(500);
Source

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

Get cached value if exists and not expired

§Panics

This function does not panic.

Source

pub async fn get_checked(&self, key: &str) -> Result<Option<String>, String>

Get a cached value, distinguishing cache misses from backend errors.

Returns:

  • Ok(Some(value)) — cache hit
  • Ok(None) — cache miss
  • Err(msg) — backend error (treat as miss but log it)
Source

pub async fn set( &self, key: impl Into<String>, value: impl Into<String>, ttl_secs: u64, )

Set cached value with TTL in seconds

§Panics

This function does not panic.

Source

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

Delete cached value

§Panics

This function does not panic.

Source

pub async fn clear(&self)

Clear all cached values

§Panics

This function does not panic.

Source

pub fn stats(&self) -> CacheStats

Get cache statistics

§Panics

This function does not panic.

Trait Implementations§

Source§

impl Clone for CacheLayer

Source§

fn clone(&self) -> CacheLayer

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · 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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> FutureExt for T

§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
§

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.

Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

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

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + 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: Sized + 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
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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

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