Struct CacheKey 

pub struct CacheKey {
    pub method: Method,
    pub path: ByteStr,
    pub query: String,
    pub vary_values: Vec<(String, String)>,
    pub body_hash: Option<u64>,
}

Cache key for HTTP responses.

Fields

method: Method

HTTP method

path: ByteStr

Request path

query: String

Canonicalized query string: the decoded pairs sorted by name, each key and value length-prefixed as {len}:{bytes}.

Not a re-rendered query string — the pairs arrive percent-decoded, so a value may itself contain & or =. Joined naively, ?a=1%26b%3D2 (one param whose value is 1&b=2) and ?a=1&b=2 (two params) both render a=1&b=2 and would share a cache entry, letting one request be served the other’s body. The length prefix fixes where each field ends regardless of the bytes inside it, so distinct pair sets always differ here.

vary_values: Vec<(String, String)>

Vary header values that affect caching

body_hash: Option<u64>

Hash of the request body, for methods where the body identifies the resource being queried (QUERY, draft-ietf-httpbis-safe-method-w-body). None for methods whose body does not participate in the cache key.

Implementations

impl CacheKey

pub fn from_request(request: &HttpRequest) -> Self

Generate a cache key from a request.

pub fn from_request_with_vary( request: &HttpRequest, vary_headers: &[&str], ) -> Self

Generate a cache key from a request with Vary headers.

pub fn to_string_key(&self) -> String

Convert to a string representation suitable for use as a cache key.

Trait Implementations

impl Clone for CacheKey

fn clone(&self) -> CacheKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheKey

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

Formats the value using the given formatter.

impl Display for CacheKey

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

Formats the value using the given formatter.

impl Eq for CacheKey

impl Hash for CacheKey

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CacheKey

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for CacheKey