Struct trillium_caching_headers::Etag

pub struct Etag { /* fields omitted */ }

Etag and If-None-Match header handler

Trillium handler that provides an outbound etag header after other handlers have been run, and if the request includes an if-none-match header, compares these values and sends a 304 not modified status, omitting the response body.

Streamed bodies

Note that this handler does not currently provide an etag trailer for streamed bodies, but may do so in the future.

Strong vs weak comparison

Etags can be compared using a strong method or a weak method. By default, this handler allows weak comparison. To change this setting, construct your handler with Etag::new().strong(). See etag::EntityTag for further documentation.

Implementations

impl Etag

pub fn new() -> Self

constructs a new Etag handler

pub fn strong(self) -> Self

Configures this handler to use strong content-based etag comparison only. See etag::EntityTag for further documentation on the differences between strong and weak etag comparison.

Trait Implementations

impl Clone for Etag

fn clone(&self) -> Etag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Etag

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

Formats the value using the given formatter.

impl Default for Etag

fn default() -> Etag

Returns the “default value” for a type.

impl Handler for Etag

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

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

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 init<'life0, 'life1, 'async_trait>(
    &'life0 mut self,
    _info: &'life1 mut Info
) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait, Global>> 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 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 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, Global>> 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 Copy for Etag