Struct headers::common::cache_control::CacheControl

pub struct CacheControl {
    flags: Flags,
    max_age: Option<Seconds>,
    max_stale: Option<Seconds>,
    min_fresh: Option<Seconds>,
    s_max_age: Option<Seconds>,
}

Cache-Control header, defined in RFC7234 with extensions in RFC8246

The Cache-Control header field is used to specify directives for caches along the request/response chain. Such cache directives are unidirectional in that the presence of a directive in a request does not imply that the same directive is to be given in the response.

ABNF

Cache-Control   = 1#cache-directive
cache-directive = token [ "=" ( token / quoted-string ) ]

Example values

• no-cache
• private, community="UCI"
• max-age=30

Example

use headers::CacheControl;

let cc = CacheControl::new();

Fields

flags: Flags

max_age: Option<Seconds>

max_stale: Option<Seconds>

min_fresh: Option<Seconds>

s_max_age: Option<Seconds>

Implementations

impl CacheControl

pub fn new() -> Self

Construct a new empty CacheControl header.

pub fn no_cache(&self) -> bool

Check if the no-cache directive is set.

pub fn no_store(&self) -> bool

Check if the no-store directive is set.

pub fn no_transform(&self) -> bool

Check if the no-transform directive is set.

pub fn only_if_cached(&self) -> bool

Check if the only-if-cached directive is set.

pub fn public(&self) -> bool

Check if the public directive is set.

pub fn private(&self) -> bool

Check if the private directive is set.

pub fn immutable(&self) -> bool

Check if the immutable directive is set.

pub fn max_age(&self) -> Option<Duration>

Get the value of the max-age directive if set.

pub fn max_stale(&self) -> Option<Duration>

Get the value of the max-stale directive if set.

pub fn min_fresh(&self) -> Option<Duration>

Get the value of the min-fresh directive if set.

pub fn s_max_age(&self) -> Option<Duration>

Get the value of the s-maxage directive if set.

pub fn with_no_cache(self) -> Self

Set the no-cache directive.

pub fn with_no_store(self) -> Self

Set the no-store directive.

pub fn with_no_transform(self) -> Self

Set the no-transform directive.

pub fn with_only_if_cached(self) -> Self

Set the only-if-cached directive.

pub fn with_private(self) -> Self

Set the private directive.

pub fn with_public(self) -> Self

Set the public directive.

pub fn with_immutable(self) -> Self

Set the immutable directive.

pub fn with_max_age(self, duration: Duration) -> Self

Set the max-age directive.

pub fn with_max_stale(self, duration: Duration) -> Self

Set the max-stale directive.

pub fn with_min_fresh(self, duration: Duration) -> Self

Set the min-fresh directive.

pub fn with_s_max_age(self, duration: Duration) -> Self

Set the s-maxage directive.

Trait Implementations

impl Clone for CacheControl

fn clone(&self) -> CacheControl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CacheControl

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

Formats the value using the given formatter.

impl Header for CacheControl

fn name() -> &'static HeaderName

The name of this header.

fn decode<'i, I: Iterator<Item = &'i HeaderValue>>( values: &mut I, ) -> Result<Self, Error>

Decode this type from an iterator of HeaderValues.

fn encode<E: Extend<HeaderValue>>(&self, values: &mut E)

Encode this type to a HeaderMap.

impl PartialEq for CacheControl

fn eq(&self, other: &CacheControl) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CacheControl