Struct Cache 

pub struct Cache<S: CacheStorage> { /* private fields */ }

Server-side cache handler. Mount on a trillium handler chain together with a CacheStorage backend.

Implementations

impl<S: CacheStorage> Cache<S>

pub fn new(storage: S) -> Self

Construct a cache handler with default options (CacheOptions::default) and a 16 MiB body-size cap.

pub fn with_options(self, options: CacheOptions) -> Self

Replace the cache options.

pub fn shared(self) -> Self

Mark this cache as a shared cache (proxy/CDN). Equivalent to with_options with shared: true.

pub fn with_max_cacheable_size(self, max: u64) -> Self

Set the cap on response body bytes the cache will store. Responses larger than this pass through but are not stored. If the cap is exceeded mid-stream, the cache write is aborted and the remainder of the body passes through unmodified.

pub fn storage(&self) -> &S

Borrow the storage backend.

Trait Implementations

impl<S: CacheStorage> Clone for Cache<S>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<S: Debug + CacheStorage> Debug for Cache<S>

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

Formats the value using the given formatter.

impl<S: CacheStorage> Handler for Cache<S>

async fn run(&self, conn: Conn) -> Conn

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

async fn before_send(&self, conn: Conn) -> Conn

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(&mut self, info: &mut Info) -> impl Future<Output = ()> + Send

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) -> 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(&self, upgrade: Upgrade) -> impl Future<Output = ()> + Send

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.