Struct http_cache_semantics::CachePolicyOptions

pub struct CachePolicyOptions {
    pub shared: bool,
    pub cache_heuristic: f32,
    pub immutable_min_time_to_live: Duration,
    pub ignore_cargo_cult: bool,
    pub trust_server_date: bool,
    pub response_time: SystemTime,
}

Holds configuration options which control the behavior of the cache and are independent of any specific request or response.

Fields

shared: bool

If shared is 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 recommended for HTTP clients.

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.

trust_server_date: bool

If trust_server_date is false, then server's Date header won't be used as the base for max-age. This is against the RFC, but it's useful if you want to cache responses with very short max-age, but your local clock is not exactly in sync with the server's.

response_time: SystemTime

When the response has been received. SystemTime::now.

Trait Implementations

impl Clone for CachePolicyOptions

fn clone(&self) -> CachePolicyOptions

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for CachePolicyOptions

impl Debug for CachePolicyOptions

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

Formats the value using the given formatter.

impl Default for CachePolicyOptions

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for CachePolicyOptions

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

Deserialize this value from the given Serde deserializer.

impl Serialize for CachePolicyOptions

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

Serialize this value into the given Serde serializer.