Skip to main content

CacheService

Struct CacheService 

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

Outcome-aware Cache segment (Caching EIP).

Wraps a named CacheRepository and an on-miss sub-pipeline (OutcomeSegment). On each exchange:

  1. Evaluate key_expr. None → not cacheable; forward directly to the on-miss sub-pipeline (no lookup, no write-back).
  2. repository.get(&key):
    • Err(e)Failed(e) (contract C1).
    • Ok(Some(entry)) → HIT: reconstruct Body from the entry, set it on the exchange, return Completed (skip on-miss).
    • Ok(None) → MISS: proceed to step 3.
  3. Run the on-miss sub-pipeline.
    • Stopped(ex) / Failed(e) → propagate as-is (NO write-back).
    • Completed(ex) → proceed to write-back.
  4. Write-back the resulting body (when it fits max_entry_bytes):
    • materialized variants (Bytes/Text/Json/Xml) → serialize, store.
    • Stream → materialize via Body::into_bytes (consumes the body, replaces it with Body::Bytes); StreamLimitExceeded propagates.
    • Empty / oversized body → pass through uncached, return Completed.

Implementations§

Source§

impl CacheService

Source

pub fn new( repository: Arc<dyn CacheRepository>, key_expr: MessageIdExpression, ttl: Option<Duration>, max_entry_bytes: usize, on_miss: OutcomeSegment, rt: Arc<dyn RuntimeObservability>, ) -> Self

Build a new cache segment.

repository_name is derived from repository.name() so OTel tags stay in sync with the resolved backend.

Source

pub fn repository_name(&self) -> &str

The configured repository name (for OTel tagging).

Trait Implementations§

Source§

impl Clone for CacheService

Source§

fn clone(&self) -> Self

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

impl OutcomePipeline for CacheService

Source§

fn clone_box(&self) -> Box<dyn OutcomePipeline>

Clone the segment into a new boxed instance. Required because Box<dyn OutcomePipeline> cannot directly derive Clone.
Source§

fn run<'a>( &'a mut self, exchange: Exchange, ) -> Pin<Box<dyn Future<Output = PipelineOutcome> + Send + 'a>>

Execute the segment against exchange, returning a PipelineOutcome. 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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

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> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

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

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

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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: 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
Source§

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

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