Enum trillium_caching_headers::CacheControlDirective

#[non_exhaustive]
pub enum CacheControlDirective {
    Immutable,
    MaxAge(Duration),
    MaxFresh(Duration),
    MaxStale(Option<Duration>),
    MustRevalidate,
    NoCache,
    NoStore,
    NoTransform,
    OnlyIfCached,
    Private,
    ProxyRevalidate,
    Public,
    SMaxage(Duration),
    StaleIfError(Duration),
    StaleWhileRevalidate(Duration),
    UnknownDirective(String),
}

An enum representation of the Cache-Control directives.

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

immutable

MaxAge(Duration)

max-age

MaxFresh(Duration)

max-fresh

MaxStale(Option<Duration>)

max-stale

MustRevalidate

must-revalidate

NoCache

no-cache

NoStore

no-store

NoTransform

no-transform

OnlyIfCached

only-if-cached

Private

private

ProxyRevalidate

proxy-revalidate

Public

public

SMaxage(Duration)

s-maxage

StaleIfError(Duration)

stale-if-error

StaleWhileRevalidate(Duration)

stale-while-revalidate

UnknownDirective(String)

an enum variant that will contain any unrecognized directives

Trait Implementations

impl Clone for CacheControlDirective

fn clone(&self) -> CacheControlDirective

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CacheControlDirective

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

Formats the value using the given formatter.

impl From<CacheControlDirective> for CacheControlHeader

fn from(directive: CacheControlDirective) -> Self

Converts to this type from the input type.

impl From<CacheControlDirective> for HeaderValues

fn from(ccd: CacheControlDirective) -> HeaderValues

Converts to this type from the input type.

impl FromIterator<CacheControlDirective> for CacheControlHeader

fn from_iter<T: IntoIterator<Item = CacheControlDirective>>(iter: T) -> Self

Creates a value from an iterator.

impl Handler for CacheControlDirective

fn run<'life0, 'async_trait>( &'life0 self, conn: Conn ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Executes this handler, performing any modifications to the Conn that are desired.

fn init<'life0, 'life1, 'async_trait>( &'life0 mut self, _info: &'life1 mut Info ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Performs one-time async set up on a mutable borrow of the Handler before the server starts accepting requests. This allows a Handler to be defined in synchronous code but perform async setup such as establishing a database connection or fetching some state from an external source. This is optional, and chances are high that you do not need this.

fn before_send<'life0, 'async_trait>( &'life0 self, conn: Conn ) -> Pin<Box<dyn Future<Output = Conn> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Performs any final modifications to this conn after all handlers have been run. Although this is a slight deviation from the simple conn->conn->conn chain represented by most Handlers, it provides an easy way for libraries to effectively inject a second handler into a response chain. This is useful for loggers that need to record information both before and after other handlers have run, as well as database transaction handlers and similar library code.

fn has_upgrade(&self, _upgrade: &Upgrade<BoxedTransport>) -> bool

predicate function answering the question of whether this Handler would like to take ownership of the negotiated Upgrade. If this returns true, you must implement [Handler::upgrade]. The first handler that responds true to this will receive ownership of the [trillium::Upgrade][crate::Upgrade] in a subsequent call to [Handler::upgrade]

fn upgrade<'life0, 'async_trait>( &'life0 self, _upgrade: Upgrade<BoxedTransport> ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

This will only be called if the handler reponds true to [Handler::has_upgrade] and will only be called once for this upgrade. There is no return value, and this function takes exclusive ownership of the underlying transport once this is called. You can downcast the transport to whatever the source transport type is and perform any non-http protocol communication that has been negotiated. You probably don’t want this unless you’re implementing something like websockets. Please note that for many transports such as TcpStreams, dropping the transport (and therefore the Upgrade) will hang up / disconnect.

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

Customize the name of your handler. This is used in Debug implementations. The default is the type name of this handler.

impl PartialEq for CacheControlDirective

fn eq(&self, other: &CacheControlDirective) -> 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 CacheControlDirective

impl StructuralEq for CacheControlDirective

impl StructuralPartialEq for CacheControlDirective