Struct Cache 

#[non_exhaustive]
pub struct Cache<S, I>
where
    S: CacheStore,
{
    pub store: S,
    pub issuer: I,
    pub skipper: Box<dyn Skipper>,
    /* private fields */
}

Cache middleware.

Example

use std::time::Duration;

use salvo_cache::{Cache, MokaStore, RequestIssuer};
use salvo_core::Router;

let cache = Cache::new(
    MokaStore::builder()
        .time_to_live(Duration::from_secs(60))
        .build(),
    RequestIssuer::default(),
);
let router = Router::new().hoop(cache);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

store: S

Cache store.

issuer: I

Cache issuer.

skipper: Box<dyn Skipper>

Skipper.

Implementations

impl<S, I> Cache<S, I>

where S: CacheStore,

pub fn new(store: S, issuer: I) -> Self

Create a new Cache.

pub fn skipper(self, skipper: impl Skipper) -> Self

Sets skipper and returns a new Cache.

pub fn cache_private(self, cache_private: bool) -> Self

Allow caching requests or responses that contain private-user cache signals.

By default, requests with Authorization or Cookie, and responses with Set-Cookie, Vary, or Cache-Control: private, are not cached. Enabling this lifts those privacy restrictions. Cache-Control: no-store/no-cache responses are never cached regardless of this setting.

pub fn max_in_flight(self, max_in_flight: usize) -> Self

Sets the maximum number of distinct cache keys tracked for concurrent miss coalescing.

When this limit is reached, misses for new keys bypass coalescing and execute normally. Existing in-flight keys can still be followed. Set to 0 to disable miss coalescing.

Trait Implementations

impl<S, I> Debug for Cache<S, I>

where S: CacheStore + Debug, I: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<S, I> Handler for Cache<S, I>

where S: CacheStore<Key = I::Key>, I: CacheIssuer, I::Key: Clone,

fn handle<'life0, 'life1, 'life2, 'life3, 'life4, 'async_trait>( &'life0 self, req: &'life1 mut Request, depot: &'life2 mut Depot, res: &'life3 mut Response, ctrl: &'life4 mut FlowCtrl, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, 'life4: 'async_trait,

Handles one HTTP request.

fn arc(self) -> ArcHandler

where Self: Sized,

Wrap to ArcHandler.

fn hooped(self) -> HoopedHandler

where Self: Sized,

Wraps this handler in a HoopedHandler.

fn hoop<H>(self, hoop: H) -> HoopedHandler

where H: Handler, Self: Sized,

Hoop this handler with middleware.

fn hoop_when<H, F>(self, hoop: H, filter: F) -> HoopedHandler

where Self: Sized, H: Handler, F: Fn(&Request, &Depot) -> bool + Send + Sync + 'static,

Hoop this handler with middleware.