Skip to main content

CacheLayer

Struct CacheLayer 

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

An in-memory response cache middleware.

Construct with CacheLayer::memory and configure with the builder methods ttl and vary_by_header.

CacheLayer is cheaply Clone-able — clones share the same underlying store, which lets you keep a handle for cache stats and invalidation while the other clone is used as middleware.

Implementations§

Source§

impl CacheLayer

Source

pub fn memory(capacity: usize) -> Self

Create a new in-memory cache bounded to capacity entries.

Default TTL is 60 seconds. Adjust with .ttl().

Source

pub fn hits(&self) -> u64

Number of cache hits since the cache was created.

Source

pub fn misses(&self) -> u64

Number of cache misses since the cache was created.

Source

pub fn size(&self) -> usize

Current number of entries in the store (including potentially expired ones that haven’t been purged yet).

Source

pub fn clear(&self)

Remove all entries from the cache.

Source

pub fn ttl(self, secs: u64) -> Self

Set the time-to-live for cached entries.

Source

pub fn vary_by_header(self, name: &str) -> Self

Include a request header in the cache key so that different values of that header produce separate cache entries.

Header name matching is case-insensitive. Call multiple times to vary by more than one header.

use rust_web_server::cache::CacheLayer;

let layer = CacheLayer::memory(500)
    .vary_by_header("Accept")
    .vary_by_header("Accept-Language");

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

impl Middleware for CacheLayer

Source§

fn handle( &self, request: &Request, connection: &ConnectionInfo, next: &dyn Application, ) -> Result<Response, String>

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