Skip to main content

CacheService

Struct CacheService 

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

Tower Service that caches Frame responses for cacheable read commands.

The local response cache supports GET, HGET, HGETALL, LRANGE, SMEMBERS, ZRANGE, and TYPE. Other commands pass through to the inner service; known mutations synchronously invalidate affected entries.

Clones share cache state and the owned invalidation lifecycle. Cacheable misses use per-key epochs so a response racing an invalidation is never inserted. Non-cacheable commands are classified and locally invalidated both before and after dispatch.

The inner service must implement ReleaseReadiness because a cache hit returns without calling it after Tower readiness has already been acquired.

Implementations§

Source§

impl<S> CacheService<S>

Source

pub fn new(inner: S, config: CacheConfig) -> Self

Wrap inner without server invalidations.

§Staleness warning

This compatibility constructor cannot guarantee cache coherence. Entries may remain stale until their TTL. Prefer a tracked cached client, CacheLayer::with_invalidation_stream, or with_invalidation_stream.

Source

pub fn without_invalidation(inner: S, config: CacheConfig) -> Self

Explicitly wrap inner without an invalidation source.

Source

pub fn with_cache(inner: S, cache: Arc<RwLock<CacheState>>) -> Self

Create with existing shared cache state and no invalidation source.

The caller is responsible for driving invalidations and failing the cache closed if that source ends. Prefer with_invalidation_stream, or pass this cache to spawn_invalidation_task and retain its task handle.

Source

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

Wrap an inner service and own its invalidation stream across clones.

§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>( inner: S, config: CacheConfig, push_stream: T, recorder: Arc<dyn MetricsRecorder>, ) -> Self
where T: Stream<Item = Result<Frame, ProtocolError>> + Send + 'static,

Wrap an inner service with an owned invalidation stream and cache-event recorder.

§Panics

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

Source§

impl<S> CacheService<S>

Source

pub fn inner(&self) -> &S

Get the wrapped service.

Source

pub fn inner_mut(&mut self) -> &mut S

Mutably access the wrapped service.

Source

pub fn into_inner(self) -> S

Consume this middleware and return the wrapped service.

Dropping the service also drops this clone’s invalidation lease.

Source

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

Get the shared cache state.

Source

pub async fn cache_size(&self) -> usize

Get the current number of entries.

Source

pub async fn clear_cache(&self)

Clear all local entries.

Source

pub async fn cache_statistics(&self) -> CacheStatistics

Return aggregate cache statistics.

Source

pub async fn is_caching_healthy(&self) -> bool

Whether cache use is enabled, no mutation is in flight, and any managed data worker remains healthy.

Source§

impl CacheService<AutoPipelineService>

Source

pub fn queue_depth(&self) -> usize

Return the number of requests currently queued in the worker.

Source

pub async fn call_pipeline( &mut self, frames: Vec<Frame>, ) -> Result<Vec<Frame>, RedisError>

Submit an explicit batch atomically and conservatively clear the cache before and after dispatch.

Source

pub async fn shutdown(self)

Stop tracking before shutting down the final auto-pipeline worker.

Trait Implementations§

Source§

impl<S: Clone> Clone for CacheService<S>

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> Service<Frame> for CacheService<S>
where S: Service<Frame, Response = Frame, Error = RedisError> + ReleaseReadiness, S::Future: Send + 'static,

Source§

type Response = Frame

Responses given by the service.
Source§

type Error = RedisError

Errors produced by the service.
Source§

type Future = Pin<Box<dyn Future<Output = Result<Frame, RedisError>> + Send>>

The future response value.
Source§

fn poll_ready(&mut self, cx: &mut Context<'_>) -> Poll<Result<(), Self::Error>>

Returns Poll::Ready(Ok(())) when the service is able to process requests. Read more
Source§

fn call(&mut self, request: Frame) -> Self::Future

Process the request and return the response asynchronously. Read more

Auto Trait Implementations§

§

impl<S> !RefUnwindSafe for CacheService<S>

§

impl<S> !UnwindSafe for CacheService<S>

§

impl<S> Freeze for CacheService<S>
where S: Freeze, Option<fn(&mut S, Frame) -> Pin<Box<dyn Future<Output = Result<Frame, RedisError>> + Send>>>: Freeze,

§

impl<S> Send for CacheService<S>
where S: Send, Option<fn(&mut S, Frame) -> Pin<Box<dyn Future<Output = Result<Frame, RedisError>> + Send>>>: Send,

§

impl<S> Sync for CacheService<S>
where S: Sync, Option<fn(&mut S, Frame) -> Pin<Box<dyn Future<Output = Result<Frame, RedisError>> + Send>>>: Sync,

§

impl<S> Unpin for CacheService<S>
where S: Unpin, Option<fn(&mut S, Frame) -> Pin<Box<dyn Future<Output = Result<Frame, RedisError>> + Send>>>: Unpin,

§

impl<S> UnsafeUnpin for CacheService<S>

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, Request> ServiceExt<Request> for T
where T: Service<Request> + ?Sized,

Source§

fn ready(&mut self) -> Ready<'_, Self, Request> ⓘ
where Self: Sized,

Yields a mutable reference to the service when it is ready to accept a request.
Source§

fn ready_oneshot(self) -> ReadyOneshot<Self, Request> ⓘ
where Self: Sized,

Yields the service when it is ready to accept a request.
Source§

fn oneshot(self, req: Request) -> Oneshot<Self, Request> ⓘ
where Self: Sized,

Consume this Service, calling it with the provided request once it is ready.
Source§

fn call_all<S>(self, reqs: S) -> CallAll<Self, S>
where Self: Sized, S: Stream<Item = Request>,

Process all requests from the given Stream, and produce a Stream of their responses. Read more
Source§

fn and_then<F>(self, f: F) -> AndThen<Self, F>
where Self: Sized, F: Clone,

Executes a new future after this service’s future resolves. This does not alter the behaviour of the poll_ready method. Read more
Source§

fn map_response<F, Response>(self, f: F) -> MapResponse<Self, F>
where Self: Sized, F: FnOnce(Self::Response) -> Response + Clone,

Maps this service’s response value to a different value. This does not alter the behaviour of the poll_ready method. Read more
Source§

fn map_err<F, Error>(self, f: F) -> MapErr<Self, F>
where Self: Sized, F: FnOnce(Self::Error) -> Error + Clone,

Maps this service’s error value to a different value. This does not alter the behaviour of the poll_ready method. Read more
Source§

fn map_result<F, Response, Error>(self, f: F) -> MapResult<Self, F>
where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Result<Response, Error> + Clone,

Maps this service’s result type (Result<Self::Response, Self::Error>) to a different value, regardless of whether the future succeeds or fails. Read more
Source§

fn map_request<F, NewRequest>(self, f: F) -> MapRequest<Self, F>
where Self: Sized, F: FnMut(NewRequest) -> Request,

Composes a function in front of the service. Read more
Source§

fn then<F, Response, Error, Fut>(self, f: F) -> Then<Self, F>
where Self: Sized, Error: From<Self::Error>, F: FnOnce(Result<Self::Response, Self::Error>) -> Fut + Clone, Fut: Future<Output = Result<Response, Error>>,

Composes an asynchronous function after this service. Read more
Source§

fn map_future<F, Fut, Response, Error>(self, f: F) -> MapFuture<Self, F>
where Self: Sized, F: FnMut(Self::Future) -> Fut, Error: From<Self::Error>, Fut: Future<Output = Result<Response, Error>>,

Composes a function that transforms futures produced by the service. Read more
Source§

fn boxed(self) -> BoxService<Request, Self::Response, Self::Error>
where Self: Sized + Send + 'static, Self::Future: Send + 'static,

Convert the service into a Service + Send trait object. Read more
Source§

fn boxed_clone(self) -> BoxCloneService<Request, Self::Response, Self::Error>
where Self: Sized + Clone + Send + 'static, Self::Future: Send + 'static,

Convert the service into a Service + Clone + Send trait object. Read more
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