Struct CacheControl 

pub struct CacheControl {
    pub directives: DirectiveMap,
    pub allow_float_seconds: bool,
}

Parsed Cache-Control directives

Fields

directives: DirectiveMap

The parsed directives

allow_float_seconds: bool

When set, delta-seconds directives (max-age, s-maxage, stale-while-revalidate, stale-if-error) accept fractional values and round them down to the nearest non-negative integer.

Defaults to false, matching RFC 9111 strict integer parsing. Enable via CacheControl::with_float_seconds (or by assigning the field directly) for contexts that need to interoperate with upstreams that emit fractional ttls.

Implementations

impl CacheControl

pub fn with_float_seconds(self) -> Self

Builder setter: enable fractional delta-seconds parsing.

See CacheControl::allow_float_seconds for semantics. Returns self so it can be chained onto a parser call, e.g. CacheControl::from_resp_headers(&resp).map(|cc| cc.with_float_seconds()).

pub fn from_headers_named( header_name: &str, headers: &HeaderMap, ) -> Option<Self>

Parse from the given header name in headers

pub fn from_req_headers_named( header_name: &str, req_header: &ReqHeader, ) -> Option<Self>

Parse from the given header name in the ReqHeader

pub fn from_req_headers(req_header: &ReqHeader) -> Option<Self>

Parse Cache-Control header name from the ReqHeader

pub fn from_resp_headers_named( header_name: &str, resp_header: &RespHeader, ) -> Option<Self>

Parse from the given header name in the RespHeader

pub fn from_resp_headers(resp_header: &RespHeader) -> Option<Self>

Parse Cache-Control header name from the RespHeader

pub fn has_key(&self, key: &str) -> bool

Whether the given directive is in the cache control.

Accepts a string for convenience; known directive names are matched without allocation. Prefer has_directive when you already have a DirectiveKey.

Note: key must already be lowercase (e.g. "max-age", not "Max-Age"). Directive names are stored in wire-format lowercase; a mixed-case input will silently miss.

pub fn has_directive(&self, key: &DirectiveKey) -> bool

Whether the given DirectiveKey is in the cache control.

pub fn public(&self) -> bool

Whether the public directive is in the cache control.

pub fn private(&self) -> bool

Whether the standalone private exists in the cache control

pub fn private_field_names(&self) -> Option<ListValueIter<'_>>

Get the values of private=

pub fn no_cache(&self) -> bool

Whether the standalone no-cache exists in the cache control

pub fn no_cache_field_names(&self) -> Option<ListValueIter<'_>>

Get the values of no-cache=

pub fn no_store(&self) -> bool

Whether no-store exists.

pub fn max_age(&self) -> Result<Option<u32>>

Return the max-age seconds

pub fn s_maxage(&self) -> Result<Option<u32>>

Return the s-maxage seconds

pub fn stale_while_revalidate(&self) -> Result<Option<u32>>

Return the stale-while-revalidate seconds

pub fn stale_if_error(&self) -> Result<Option<u32>>

Return the stale-if-error seconds

pub fn must_revalidate(&self) -> bool

Whether must-revalidate exists.

pub fn proxy_revalidate(&self) -> bool

Whether proxy-revalidate exists.

pub fn only_if_cached(&self) -> bool

Whether only-if-cached exists.

Trait Implementations

impl Debug for CacheControl

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

Formats the value using the given formatter.

impl InterpretCacheControl for CacheControl

fn is_cacheable(&self) -> Cacheable

Does cache-control specify this response is cacheable?

fn allow_caching_authorized_req(&self) -> bool

Does this cache-control allow caching a response to a request with the Authorization header?

fn fresh_duration(&self) -> Option<Duration>

Returns freshness ttl specified in cache-control

fn serve_stale_while_revalidate_duration(&self) -> Option<Duration>

Returns stale-while-revalidate ttl,

fn serve_stale_if_error_duration(&self) -> Option<Duration>

Returns stale-if-error ttl,

fn strip_private_headers(&self, resp_header: &mut ResponseHeader)

Strip header names listed in private or no-cache directives from a response, usually prior to storing that response in cache.