Struct Caching

pub struct Caching { /* private fields */ }

Available on crate feature fs only.

Controls if caching information should be sent.

The Caching struct contains an Etag which stores a random tag which indentifies a specific file. The Etag gets generated when the struct gets created.

Example

use fire::{get, Request};
use fire::fs::Caching;
use fire::into::IntoResponse;
use std::cell::LazyCell;


const INDEX_CACHE: LazyCell<Caching> = LazyCell::new(|| {
	Caching::default()
});

#[get("/")]
fn index(req: &mut Request) -> Response {
	let cache = INDEX_CACHE.clone();
	if cache.if_none_match(req.header()) {
		return cache.into_response()
	}

	let mut resp = Response::html("<h1>Hello, World!</h1>");
	cache.complete_header(&mut resp.header);

	resp
}

Implementations

impl Caching

pub fn new(max_age: Duration) -> Self

pub fn default() -> Self

pub fn if_none_match(&self, header: &RequestHeader) -> bool

pub fn complete_header(self, header: &mut ResponseHeader)

Trait Implementations

impl Clone for Caching

fn clone(&self) -> Caching

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Caching

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

Formats the value using the given formatter.

impl IntoResponse for Caching

fn into_response(self) -> Response

impl PartialEq for Caching

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Eq for Caching

impl StructuralPartialEq for Caching