Skip to main content

CacheLayer

Struct CacheLayer 

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

A Tower layer that shares one local cache and invalidation lifecycle across every service it creates.

The wrapped service must implement ReleaseReadiness. Put this cache directly above that backend, then put tracing, metrics, timeout, and other middleware outside the cache. If custom middleware sits inside the cache, it must propagate the readiness-release contract to its own inner service.

Implementations§

Source§

impl CacheLayer

Source

pub fn new(config: CacheConfig) -> Self

Create a layer without server invalidations.

§Staleness warning

This constructor cannot guarantee cache coherence. Entries may remain stale until ttl expires. Prefer a tracked cached client or with_invalidation_stream.

Source

pub fn without_invalidation(config: CacheConfig) -> Self

Explicitly create a layer without an invalidation source.

Source

pub fn without_invalidation_with_recorder( config: CacheConfig, recorder: Arc<dyn MetricsRecorder>, ) -> Self

Create an invalidation-free layer with a cache metrics recorder.

Source

pub fn with_invalidation_stream<T>(config: CacheConfig, push_stream: T) -> Self
where T: Stream<Item = Result<Frame, ProtocolError>> + Send + 'static,

Create a layer that owns push_stream until the final layer/service clone is dropped. Stream termination clears and disables the cache.

§Panics

Panics when called outside an active Tokio runtime because ownership of the stream is maintained by a spawned task.

Source

pub fn with_invalidation_stream_and_recorder<T>( config: CacheConfig, push_stream: T, recorder: Arc<dyn MetricsRecorder>, ) -> Self
where T: Stream<Item = Result<Frame, ProtocolError>> + Send + 'static,

Create a recorder-enabled layer that owns its invalidation stream.

This is the production counterpart to without_invalidation_with_recorder: cache events are forwarded to recorder, and stream termination fails the cache closed.

§Panics

Panics when called outside an active Tokio runtime because ownership of the stream is maintained by a spawned task.

Source

pub fn cache(&self) -> &Arc<RwLock<CacheState>> ⓘ

Get the shared cache state used by services built from this layer.

Trait Implementations§

Source§

impl Clone for CacheLayer

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<S: ReleaseReadiness> Layer<S> for CacheLayer

Source§

type Service = CacheService<S>

The wrapped service
Source§

fn layer(&self, inner: S) -> Self::Service

Wrap the given service with the middleware, returning a new service that has been decorated with the middleware.

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> 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> 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 = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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