Struct CacheControl 

pub struct CacheControl {
    pub directives: Vec<CacheDirective>,
}

Parsed or constructed Cache-Control header.

Examples

Parsing

use armature_core::response_cache::CacheControl;

let cc = CacheControl::parse("public, max-age=3600, must-revalidate");
assert!(cc.is_public());
assert_eq!(cc.get_max_age(), Some(3600));

Building

use armature_core::response_cache::CacheControl;
use std::time::Duration;

let cc = CacheControl::new()
    .private()
    .max_age(Duration::from_secs(300))
    .no_transform();

assert!(cc.is_private());

Fields

directives: Vec<CacheDirective>

All directives in this Cache-Control header

Implementations

impl CacheControl

pub fn new() -> Self

Create a new empty Cache-Control.

pub fn parse(header: &str) -> Self

Parse a Cache-Control header value.

pub fn to_header_value(&self) -> String

Convert to header value string.

pub fn public(self) -> Self

Add the public directive.

pub fn private(self) -> Self

Add the private directive.

pub fn no_store(self) -> Self

Add the no-store directive.

pub fn no_cache(self) -> Self

Add the no-cache directive.

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

Add the max-age directive.

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

Add the s-maxage directive for shared caches.

pub fn must_revalidate(self) -> Self

Add the must-revalidate directive.

pub fn proxy_revalidate(self) -> Self

Add the proxy-revalidate directive.

pub fn no_transform(self) -> Self

Add the no-transform directive.

pub fn immutable(self) -> Self

Add the immutable directive.

pub fn directive(self, directive: CacheDirective) -> Self

Add a custom directive.

pub fn is_public(&self) -> bool

Check if public directive is present.

pub fn is_private(&self) -> bool

Check if private directive is present.

pub fn is_no_store(&self) -> bool

Check if no-store directive is present.

pub fn is_no_cache(&self) -> bool

Check if no-cache directive is present.

pub fn is_must_revalidate(&self) -> bool

Check if must-revalidate directive is present.

pub fn is_immutable(&self) -> bool

Check if immutable directive is present.

pub fn get_max_age(&self) -> Option<u64>

Get the max-age value in seconds.

pub fn get_s_maxage(&self) -> Option<u64>

Get the s-maxage value in seconds.

pub fn is_cacheable(&self) -> bool

Check if the response is cacheable.

pub fn freshness_lifetime(&self) -> Option<u64>

Get the freshness lifetime in seconds.

Returns s-maxage if present (for shared caches), otherwise max-age.

pub fn never() -> Self

Create a “no-store” Cache-Control (never cache).

pub fn public_max_age(duration: Duration) -> Self

Create a public cache with the given max-age.

pub fn private_max_age(duration: Duration) -> Self

Create a private cache with the given max-age.

pub fn immutable_asset(duration: Duration) -> Self

Create an immutable public cache (for versioned assets).

pub fn revalidate(duration: Duration) -> Self

Create a must-revalidate cache.

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

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

Formats the value using the given formatter.