Struct CacheLayer

pub struct CacheLayer<C, K> { /* private fields */ }

The main struct of the library. The layer providing caching to the wrapped service. It is generic over the cache used (C) and a Keyer (K) used to obtain the key for cached responses.

Implementations

impl<C, K> CacheLayer<C, K>

where C: Cached<K::Key, CachedResponse> + CloneCached<K::Key, CachedResponse>, K: Keyer, K::Key: Debug + Hash + Eq + Clone + Send + 'static,

pub fn with_cache_and_keyer(cache: C, keyer: K) -> Self

Create a new cache layer with a given cache and the default body size limit of 128 MB.

pub fn use_stale_on_failure(self) -> Self

Switch the layer’s settings to preserve the last successful response even when it’s evicted from the cache but the service failed to provide a new successful response (ie. eg. when the underlying service responds with 404 NOT FOUND, the cache will keep providing the last stale 200 OK response produced).

pub fn body_limit(self, new_limit: usize) -> Self

Change the maximum body size limit. If you want unlimited size, use usize::MAX.

pub fn allow_invalidation(self) -> Self

Allow manual cache invalidation by setting the X-Invalidate-Cache header in the request. This will allow the cache to be invalidated for the given key.

pub fn add_response_headers(self) -> Self

Allow the response headers to be included in the cached response.

impl<C> CacheLayer<C, BasicKeyer>

where C: Cached<BasicKey, CachedResponse> + CloneCached<BasicKey, CachedResponse>,

pub fn with(cache: C) -> Self

Create a new cache layer with a given cache and the default body size limit of 128 MB.

impl CacheLayer<TimedCache<BasicKey, CachedResponse>, BasicKey>

pub fn with_lifespan( ttl_sec: u64, ) -> CacheLayer<TimedCache<BasicKey, CachedResponse>, BasicKeyer>

Create a new cache layer with the desired TTL in seconds

impl<K> CacheLayer<TimedCache<K::Key, CachedResponse>, K>

where K: Keyer, K::Key: Debug + Hash + Eq + Clone + Send + 'static,

pub fn with_lifespan_and_keyer( ttl_sec: u64, keyer: K, ) -> CacheLayer<TimedCache<K::Key, CachedResponse>, K>

Create a new cache layer with the desired TTL in seconds

Trait Implementations

impl<C, K> Clone for CacheLayer<C, K>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S, C, K> Layer<S> for CacheLayer<C, K>

where K: Keyer, K::Key: Debug + Hash + Eq + Clone + Send + 'static,

type Service = CacheService<S, C, K>

The wrapped service

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.