Skip to main content

ServerCacheLayer

Struct ServerCacheLayer 

Source
pub struct ServerCacheLayer<M, K = DefaultKeyer>
where M: CacheManager, K: Keyer,
{ /* private fields */ }
Expand description

Tower layer for server-side HTTP response caching.

This layer should be placed AFTER routing to ensure request extensions (like path parameters) are preserved.

§Shared Cache Behavior

This implements a shared cache as defined in RFC 9111. Responses cached by this layer are served to all users making requests with matching cache keys. The cache automatically rejects responses with the private directive, but does not inspect Authorization headers or session cookies.

For authenticated or user-specific endpoints, either:

  • Set Cache-Control: private in responses (prevents caching)
  • Use a CustomKeyer that includes user/session identifiers in the cache key

Implementations§

Source§

impl<M> ServerCacheLayer<M, DefaultKeyer>
where M: CacheManager,

Source

pub fn new(manager: M) -> Self

Create a new cache layer with default options.

Source§

impl<M, K> ServerCacheLayer<M, K>
where M: CacheManager, K: Keyer,

Source

pub fn with_keyer(manager: M, keyer: K) -> Self

Create a cache layer with a custom keyer.

Source

pub fn with_options(self, options: ServerCacheOptions) -> Self

Set custom options.

Source

pub fn metrics(&self) -> &Arc<CacheMetrics>

Get a reference to the cache metrics.

Source

pub async fn invalidate( &self, cache_key: &str, ) -> Result<(), Box<dyn StdError + Send + Sync>>

Invalidate a specific cache entry by its key.

Source

pub async fn invalidate_request<B>( &self, req: &Request<B>, ) -> Result<(), Box<dyn StdError + Send + Sync>>

Invalidate cache entry for a specific request.

Uses the configured keyer to generate the cache key from the request.

Trait Implementations§

Source§

impl<M, K> Clone for ServerCacheLayer<M, K>
where M: CacheManager + Clone, K: Keyer + Clone,

Source§

fn clone(&self) -> ServerCacheLayer<M, K>

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl<S, M, K> Layer<S> for ServerCacheLayer<M, K>
where M: CacheManager + Clone, K: Keyer,

Source§

type Service = ServerCacheService<S, M, K>

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§

§

impl<M, K> Freeze for ServerCacheLayer<M, K>
where M: Freeze, K: Freeze,

§

impl<M, K> RefUnwindSafe for ServerCacheLayer<M, K>

§

impl<M, K> Send for ServerCacheLayer<M, K>

§

impl<M, K> Sync for ServerCacheLayer<M, K>

§

impl<M, K> Unpin for ServerCacheLayer<M, K>
where M: Unpin, K: Unpin,

§

impl<M, K> UnwindSafe for ServerCacheLayer<M, K>
where M: UnwindSafe, K: UnwindSafe,

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> 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, 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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.