Struct CacheConfig 

#[non_exhaustive]
pub struct CacheConfig {
    pub default_ttl: Duration,
    pub key_strategy: CacheKeyStrategy,
    pub cacheable_methods: Vec<String>,
    pub cacheable_status_codes: Vec<u16>,
    pub exclude_paths: Vec<String>,
    pub max_entries: Option<usize>,
}

Available on (crate features standard or middleware) and native only.

Cache configuration

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.

default_ttl: Duration

Default TTL

key_strategy: CacheKeyStrategy

Cache key generation strategy

cacheable_methods: Vec<String>

Cacheable methods

cacheable_status_codes: Vec<u16>

Cacheable status codes

exclude_paths: Vec<String>

Paths to exclude

max_entries: Option<usize>

Maximum cache size

Implementations

impl CacheConfig

pub fn new(default_ttl: Duration, key_strategy: CacheKeyStrategy) -> CacheConfig

Create a new configuration

Examples

use std::time::Duration;
use reinhardt_middleware::cache::{CacheConfig, CacheKeyStrategy};

let config = CacheConfig::new(Duration::from_secs(300), CacheKeyStrategy::UrlOnly);
assert_eq!(config.default_ttl, Duration::from_secs(300));

pub fn with_cacheable_methods(self, methods: Vec<String>) -> CacheConfig

Set cacheable methods

Examples

use std::time::Duration;
use reinhardt_middleware::cache::{CacheConfig, CacheKeyStrategy};

let config = CacheConfig::new(Duration::from_secs(300), CacheKeyStrategy::UrlOnly)
    .with_cacheable_methods(vec!["GET".to_string()]);

pub fn with_excluded_paths(self, paths: Vec<String>) -> CacheConfig

Add paths to exclude

Examples

use std::time::Duration;
use reinhardt_middleware::cache::{CacheConfig, CacheKeyStrategy};

let config = CacheConfig::new(Duration::from_secs(300), CacheKeyStrategy::UrlOnly)
    .with_excluded_paths(vec!["/admin".to_string()]);

pub fn with_max_entries(self, max_entries: usize) -> CacheConfig

Set maximum number of entries

Examples

use std::time::Duration;
use reinhardt_middleware::cache::{CacheConfig, CacheKeyStrategy};

let config = CacheConfig::new(Duration::from_secs(300), CacheKeyStrategy::UrlOnly)
    .with_max_entries(5000);

Trait Implementations

impl Clone for CacheConfig

fn clone(&self) -> CacheConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheConfig

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

Formats the value using the given formatter.

impl Default for CacheConfig

fn default() -> CacheConfig

Returns the “default value” for a type.