Struct CacheControl 

pub struct CacheControl {
    pub cacheability: Cacheability,
    pub max_age: Option<u32>,
    pub s_max_age: Option<u32>,
    pub no_cache: bool,
    pub must_revalidate: bool,
    pub proxy_revalidate: bool,
    pub no_transform: bool,
    pub immutable: bool,
    pub stale_while_revalidate: Option<u32>,
    pub stale_if_error: Option<u32>,
}

Available on crate feature cache only.

The directives of a Cache-Control response header.

Every directive is a public field, so an uncommon combination can be built with the struct update syntax.

use rocket_cache_response::CacheControl;

let cache_control = CacheControl {
    s_max_age: Some(86400),
    ..CacheControl::public(60)
};

assert_eq!("public, max-age=60, s-maxage=86400", cache_control.to_string());

Fields

cacheability: Cacheability

Which caches are allowed to store the response.

max_age: Option<u32>

max-age: for how many seconds the response stays fresh.

s_max_age: Option<u32>

s-maxage: replaces max_age for shared caches only.

no_cache: bool

no-cache: a stored response must be revalidated with the origin server before every reuse.

must_revalidate: bool

must-revalidate: a stale response must not be reused without a successful revalidation.

proxy_revalidate: bool

proxy-revalidate: the same as must_revalidate, but it applies to shared caches only.

no_transform: bool

no-transform: caches and proxies must not modify the payload.

immutable: bool

immutable: the body never changes, so the browser should not revalidate it even on a reload.

stale_while_revalidate: Option<u32>

stale-while-revalidate: for how many seconds a stale response may still be served while it is revalidated in the background.

stale_if_error: Option<u32>

stale-if-error: for how many seconds a stale response may still be served after the origin server fails.

Implementations

impl CacheControl

pub const fn new() -> CacheControl

Set no directive at all, which results in an empty header value.

pub const fn public(max_age: u32) -> CacheControl

public, max-age=<max_age>: every cache, shared ones included, may reuse the response for max_age seconds.

pub const fn private(max_age: u32) -> CacheControl

private, max-age=<max_age>: only the browser that made the request may reuse the response, for max_age seconds.

pub const fn no_cache() -> CacheControl

no-cache: a cache may store the response, but it must ask the origin server whether the stored copy is still good before every reuse.

pub const fn no_store() -> CacheControl

no-store: no cache may store the response at all.

pub const fn immutable() -> CacheControl

public, max-age=31536000, immutable: the response never changes, so it should be reused for a year without any revalidation.

pub fn to_header_value(&self) -> Cow<'static, str>

Format the directives into a Cache-Control header value.

Trait Implementations

impl Clone for CacheControl

fn clone(&self) -> CacheControl

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CacheControl

impl Debug for CacheControl

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

Formats the value using the given formatter.

impl Default for CacheControl

fn default() -> CacheControl

Returns the “default value” for a type.

impl Display for CacheControl

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

Formats the value using the given formatter.

impl Eq for CacheControl

impl PartialEq for CacheControl

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CacheControl