Enum CacheOverride 

pub enum CacheOverride {
    None,
    Pass,
    Override {
        ttl: Option<u32>,
        stale_while_revalidate: Option<u32>,
        stale_if_error: Option<u32>,
        pci: bool,
        surrogate_key: Option<HeaderValue>,
        lookup_timeout_ms: Option<u32>,
    },
}

Optional override for response caching behavior. These options mostly apply during host caching, but guest caching also respects them.

Variants

None

Do not override the behavior specified in the origin response’s cache control headers.

Pass

Do not cache the response to this request, regardless of the origin response’s headers.

Override

Override particular cache control settings.

The origin response’s cache control headers will be used for ttl (max_age), stale_while_revalidate, and stale_if_error if None. Note that stale_if_error is only supported via the guest caching API.

Fields

ttl: Option<u32>

TTL in seconds

stale_while_revalidate: Option<u32>

Stale while revalidate period in seconds

stale_if_error: Option<u32>

Stale if error period in seconds

pci: bool

Whether this response will contain sensitive data (e.g. PCI or HIPAA) that must not be stored in persistent storage.

surrogate_key: Option<HeaderValue>

Surrogate keys (space-separated) to store the cached response under.

lookup_timeout_ms: Option<u32>

Lookup timeout: how long to wait for the cache lookup to complete

Implementations

impl CacheOverride

pub const fn none() -> Self

Create a CacheOverride that overrides no fields.

pub const fn pass() -> Self

Create a CacheOverride forcing a cache bypass.

pub fn is_pass(&self) -> bool

Returns true if this override will cause the request to bypass the cache

pub const fn ttl(ttl: u32) -> Self

Create a CacheOverride that overrides (only) the TTL

pub const fn stale_while_revalidate(swr: u32) -> Self

Create a CacheOverride that overrides (only) the stale-while-revalidate period

pub const fn stale_if_error(sie: u32) -> Self

Create a CacheOverride that overrides (only) the stale-if-error period

pub const fn pci(pci: bool) -> Self

Create a CacheOverride that overrides (only) the sensitive data bit; if set, prevents the response from being stored in persistent storage

pub const fn surrogate_key(sk: HeaderValue) -> Self

Create a CacheOverride that overrides (only) the surrogate keys

pub const fn lookup_timeout(timeout_ms: u32) -> Self

Create a CacheOverride that overrides (only) the cache lookup timeout. Timeout given in milliseconds.

pub fn set_none(&mut self)

Updates the CacheOverride to override no fields

pub fn set_pass(&mut self, pass: bool)

Updates the CacheOverride provide the given Pass behavior; if pass is false, clears all overrides and reverts to the default behavior

pub fn get_ttl(&self) -> Option<u32>

Get the TTL configured on this override

pub fn set_ttl(&mut self, new_ttl: u32)

Set the TTL configured on this override

pub fn get_stale_while_revalidate(&self) -> Option<u32>

Get the SWR period configured on this override

pub fn set_stale_while_revalidate(&mut self, new_swr: u32)

Set the SWR period configured on this override

pub fn get_stale_if_error(&self) -> Option<u32>

Get the SIE period configured on this override

pub fn set_stale_if_error(&mut self, new_sie: u32)

Set the SIE period configured on this override

pub fn get_pci(&self) -> Option<bool>

Get the sensitive-data override setting

pub fn set_pci(&mut self, new_pci: bool)

Set the sensitive-data override setting

pub fn get_surrogate_key(&self) -> Option<&HeaderValue>

Get the surrogate keys configured on this override

pub fn set_surrogate_key(&mut self, new_surrogate_key: HeaderValue)

Set the surrogate keys configured on this override

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

Get the lookup timeout period configured on this override

pub fn set_lookup_timeout(&mut self, timeout: Duration)

Set the cache lookup timeout configured on this override; value rounded to milliseconds.

pub const fn default() -> Self

Return a default set of overrides (no overrides)

Trait Implementations

impl Clone for CacheOverride

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheOverride

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

Formats the value using the given formatter.

impl Default for CacheOverride

fn default() -> Self

Returns the “default value” for a type.