Struct CacheControl 

pub struct CacheControl { /* private fields */ }

Available on crate feature http only.

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 rama_http_headers::CacheControl;

let cc = CacheControl::new();

Implementations

impl CacheControl

pub fn new() -> CacheControl

Construct a new empty CacheControl header.

pub fn immutable_one_year() -> CacheControl

public, immutable, max-age=31536000 — for content-hashed / versioned URLs (e.g. /theme.css?v=<git-sha>).

The URL changes whenever the content changes, so the cached response is safe to keep for a year; immutable additionally stops the browser from revalidating on reload. Reach for this only on content-hashed URLs — on a stable URL whose body can change in place, use Self::no_cache or Self::short_shared_revalidate instead.

pub fn no_cache() -> CacheControl

no-cache — the response is cacheable but must be revalidated with the origin before reuse.

The right default for service-worker scripts, HTML, or anything whose URL is stable but whose body may change in place.

pub fn short_shared_revalidate(max_age_seconds: u32) -> CacheControl

public, max-age=<secs>, must-revalidate — a short shared cache for non-fingerprinted but rarely-changing files (robots.txt, sitemap.xml, security.txt).

Lets a CDN absorb crawler bursts without making content updates invisible for long.

pub fn has_no_cache(self) -> bool

Check if the no-cache directive is set.

pub fn has_no_store(self) -> bool

Check if the no-store directive is set.

pub fn has_no_transform(self) -> bool

Check if the no-transform directive is set.

pub fn has_only_if_cached(self) -> bool

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

pub fn has_public(self) -> bool

Check if the public directive is set.

pub fn has_private(self) -> bool

Check if the private directive is set.

pub fn has_immutable(self) -> bool

Check if the immutable directive is set.

pub fn has_must_revalidate(&self) -> bool

Check if the must-revalidate directive is set.

pub fn has_must_understand(self) -> bool

Check if the must-understand 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) -> CacheControl

Set the no-cache directive.

pub fn set_no_cache(&mut self) -> &mut CacheControl

Set the no-cache directive.

pub fn with_no_store(self) -> CacheControl

Set the no-store directive.

pub fn set_no_store(&mut self) -> &mut CacheControl

Set the no-store directive.

pub fn with_no_transform(self) -> CacheControl

Set the no-transform directive.

pub fn set_no_transform(&mut self) -> &mut CacheControl

Set the no-transform directive.

pub fn with_only_if_cached(self) -> CacheControl

Set the only-if-cached directive.

pub fn set_only_if_cached(&mut self) -> &mut CacheControl

Set the only-if-cached directive.

pub fn with_private(self) -> CacheControl

Set the private directive.

pub fn set_private(&mut self) -> &mut CacheControl

Set the private directive.

pub fn with_public(self) -> CacheControl

Set the public directive.

pub fn set_public(&mut self) -> &mut CacheControl

Set the public directive.

pub fn with_immutable(self) -> CacheControl

Set the immutable directive.

pub fn set_immutable(&mut self) -> &mut CacheControl

Set the immutable directive.

pub fn with_must_revalidate(self) -> CacheControl

Set the must-revalidate directive.

pub fn set_must_revalidate(&mut self) -> &mut CacheControl

Set the must-revalidate directive.

pub fn with_must_understand(self) -> CacheControl

Set the must-understand directive.

pub fn set_must_understand(&mut self) -> &mut CacheControl

Set the must-understand directive.

pub fn with_max_age_duration_rounded(self, dur: Duration) -> CacheControl

Set the max-age directive.

pub fn set_max_age_duration_rounded( &mut self, dur: Duration, ) -> &mut CacheControl

Set the max-age directive.

pub fn with_max_age_seconds(self, seconds: u64) -> CacheControl

Set the max-age directive.

pub fn set_max_age_seconds(&mut self, seconds: u64) -> &mut CacheControl

Set the max-age directive.

pub fn try_with_max_age_duration( self, dur: Duration, ) -> Result<CacheControl, Box<dyn Error + Sync + Send>>

Try to set the max-age directive.

pub fn try_set_max_age_duration( &mut self, dur: Duration, ) -> Result<&mut CacheControl, Box<dyn Error + Sync + Send>>

Try to set the max-age directive.

pub fn with_max_stale_duration_rounded(self, dur: Duration) -> CacheControl

Set the max-stale directive.

pub fn set_max_stale_duration_rounded( &mut self, dur: Duration, ) -> &mut CacheControl

Set the max-stale directive.

pub fn with_max_stale_seconds(self, seconds: u64) -> CacheControl

Set the max-stale directive.

pub fn set_max_stale_seconds(&mut self, seconds: u64) -> &mut CacheControl

Set the max-stale directive.

pub fn try_with_max_stale_duration( self, dur: Duration, ) -> Result<CacheControl, Box<dyn Error + Sync + Send>>

Try to set the max-stale directive.

pub fn try_set_max_stale_duration( &mut self, dur: Duration, ) -> Result<&mut CacheControl, Box<dyn Error + Sync + Send>>

Try to set the max-stale directive.

pub fn with_min_fresh_duration_rounded(self, dur: Duration) -> CacheControl

Set the min-fresh directive.

pub fn set_min_fresh_duration_rounded( &mut self, dur: Duration, ) -> &mut CacheControl

Set the min-fresh directive.

pub fn with_min_fresh_seconds(self, seconds: u64) -> CacheControl

Set the min-fresh directive.

pub fn set_min_fresh_seconds(&mut self, seconds: u64) -> &mut CacheControl

Set the min-fresh directive.

pub fn try_with_min_fresh_duration( self, dur: Duration, ) -> Result<CacheControl, Box<dyn Error + Sync + Send>>

Try to set the min-fresh directive.

pub fn try_set_min_fresh_duration( &mut self, dur: Duration, ) -> Result<&mut CacheControl, Box<dyn Error + Sync + Send>>

Try to set the min-fresh directive.

pub fn with_s_max_age_duration_rounded(self, dur: Duration) -> CacheControl

Set the s-maxage directive.

pub fn set_s_max_age_duration_rounded( &mut self, dur: Duration, ) -> &mut CacheControl

Set the s-maxage directive.

pub fn with_s_max_age_seconds(self, seconds: u64) -> CacheControl

Set the s-maxage directive.

pub fn set_s_max_age_seconds(&mut self, seconds: u64) -> &mut CacheControl

Set the s-maxage directive.

pub fn try_with_s_max_age_duration( self, dur: Duration, ) -> Result<CacheControl, Box<dyn Error + Sync + Send>>

Try to set the s-maxage directive.

pub fn try_set_s_max_age_duration( &mut self, dur: Duration, ) -> Result<&mut CacheControl, Box<dyn Error + Sync + Send>>

Try to set the s-maxage directive.

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 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 HeaderDecode for CacheControl

fn decode<'i, I>(values: &mut I) -> Result<CacheControl, Error>

where I: Iterator<Item = &'i HeaderValue>,

Decode this type from an iterator of HeaderValues.

impl HeaderEncode for CacheControl

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

where E: Extend<HeaderValue>,

Encode this type to a HeaderValue, and add it to a container which has HeaderValue type as each element.

fn encode_to_value(&self) -> Option<HeaderValue>

Encode this header to HeaderValue.

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

impl TypedHeader for CacheControl

fn name() -> &'static HeaderName

The name of this header.