Struct http_cache::CacheOptions

pub struct CacheOptions {
    pub shared: bool,
    pub cache_heuristic: f32,
    pub immutable_min_time_to_live: Duration,
    pub ignore_cargo_cult: bool,
}

Options struct provided by http-cache-semantics. Configuration options which control behavior of the cache. Use with CachePolicy::new_options().

Fields

shared: bool

If true (default), then the response is evaluated from a perspective of a shared cache (i.e. private is not cacheable and s-maxage is respected). If shared is false, then the response is evaluated from a perspective of a single-user cache (i.e. private is cacheable and s-maxage is ignored). shared: true is required for proxies and multi-user caches.

cache_heuristic: f32

cache_heuristic is a fraction of response’s age that is used as a fallback cache duration. The default is 0.1 (10%), e.g. if a file hasn’t been modified for 100 days, it’ll be cached for 100*0.1 = 10 days.

immutable_min_time_to_live: Duration

immutable_min_time_to_live is a duration to assume as the default time to cache responses with Cache-Control: immutable. Note that per RFC these can become stale, so max-age still overrides the default.

ignore_cargo_cult: bool

If ignore_cargo_cult is true, common anti-cache directives will be completely ignored if the non-standard pre-check and post-check directives are present. These two useless directives are most commonly found in bad StackOverflow answers and PHP’s “session limiter” defaults.

Trait Implementations

impl Clone for CacheOptions

fn clone(&self) -> CacheOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CacheOptions

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

Formats the value using the given formatter.

impl Default for CacheOptions

fn default() -> CacheOptions

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CacheOptions

fn deserialize<__D>(
    __deserializer: __D
) -> Result<CacheOptions, <__D as Deserializer<'de>>::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CacheOptions

fn serialize<__S>(
    &self,
    __serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for CacheOptions