Struct CacheBuilder 

pub struct CacheBuilder<K: KeyExtractor, B: Bypasser> { /* private fields */ }

Builds a cache using some overridable defaults

Implementations

impl<K: KeyExtractor> CacheBuilder<K, NoopBypasser>

pub fn new(key_extractor: K) -> Self

Create new CacheBuilder

impl<K: KeyExtractor, B: Bypasser> CacheBuilder<K, B>

pub fn new_with_bypasser(key_extractor: K, bypasser: B) -> Self

Create new CacheBuilder with a bypasser

pub const fn cache_size(self, v: u64) -> Self

Sets the cache size. Default 128MB.

pub const fn max_item_size(self, v: usize) -> Self

Sets the maximum entry size. Default 16MB.

pub const fn ttl(self, v: Duration) -> Self

Sets the default cache entry TTL. Default 10 sec.

pub const fn max_ttl(self, v: Duration) -> Self

Sets the maximum cache entry TTL that can be overriden by Cache-Control header. Default 1 day.

pub const fn lock_timeout(self, v: Duration) -> Self

Sets the cache lock timeout. Default 5 sec.

pub const fn body_timeout(self, v: Duration) -> Self

Sets the body reading timeout. Default 1 min.

pub const fn xfetch_beta(self, v: f64) -> Self

Sets the beta term of X-Fetch algorithm. Default 0.0

pub fn methods(self, v: &[Method]) -> Self

Sets cacheable methods. Defaults to only GET.

pub const fn obey_cache_control(self, v: bool) -> Self

Whether to obey Cache-Control headers in the response. Defaults to false.

pub fn registry(self, v: &Registry) -> Self

Sets the metrics registry to use.

pub fn build(self) -> Result<Cache<K, B>, CacheError>

Try to build the cache from this builder