Enum http_types::cache::CacheDirective

#[non_exhaustive]
pub enum CacheDirective {
    Immutable,
    MaxAge(Duration),
    MaxStale(Option<Duration>),
    MinFresh(Duration),
    MustRevalidate,
    NoCache,
    NoStore,
    NoTransform,
    OnlyIfCached,
    Private,
    ProxyRevalidate,
    Public,
    SMaxAge(Duration),
    StaleIfError(Duration),
    StaleWhileRevalidate(Duration),
}

An HTTP Cache-Control directive.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Immutable

The response body will not change over time.

MaxAge(Duration)

The maximum amount of time a resource is considered fresh.

MaxStale(Option<Duration>)

Indicates the client will accept a stale response.

MinFresh(Duration)

A response that will still be fresh for at least the specified duration.

MustRevalidate

Once a response is stale, a fresh response must be retrieved.

NoCache

The response may be cached, but must always be revalidated before being used.

NoStore

The response may not be cached.

NoTransform

An intermediate cache or proxy should not edit the response body, Content-Encoding, Content-Range, or Content-Type.

OnlyIfCached

Do not use the network for a response.

Private

The response may be stored only by a browser’s cache, even if the response is normally non-cacheable.

ProxyRevalidate

Like must-revalidate, but only for shared caches (e.g., proxies).

Public

The response may be stored by any cache, even if the response is normally non-cacheable.

SMaxAge(Duration)

Overrides max-age or the Expires header, but only for shared caches.

StaleIfError(Duration)

The client will accept a stale response if retrieving a fresh one fails.

StaleWhileRevalidate(Duration)

Indicates the client will accept a stale response, while asynchronously checking in the background for a fresh one.

Implementations

impl CacheDirective

pub fn valid_in_req(&self) -> bool

Check whether this directive is valid in an HTTP request.

pub fn valid_in_res(&self) -> bool

Check whether this directive is valid in an HTTP response.

Trait Implementations

impl Clone for CacheDirective

fn clone(&self) -> CacheDirective

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CacheDirective

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

Formats the value using the given formatter.

impl From<CacheDirective> for HeaderValue

fn from(directive: CacheDirective) -> Self

Converts to this type from the input type.

impl PartialEq<CacheDirective> for CacheDirective

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for CacheDirective

impl StructuralEq for CacheDirective

impl StructuralPartialEq for CacheDirective