Struct CommonCacheKey

pub struct CommonCacheKey {
    pub method: Method,
    pub path: Option<ByteString>,
    pub query: Option<QueryMap>,
    pub scheme: Option<Scheme>,
    pub host: Option<ByteString>,
    pub port: Option<u16>,
    pub media_type: Option<MediaType>,
    pub languages: Option<BTreeSet<Language>>,
    pub extensions: Option<BTreeMap<Bytes, Bytes>>,
}

CacheKey implementation designed for common use cases.

Fields

method: Method

Method.

path: Option<ByteString>

Optional path.

query: Option<QueryMap>

Optional query (sorted by key).

scheme: Option<Scheme>

Optional scheme.

Not set by default but reserved for custom use.

host: Option<ByteString>

Optional host.

Not set by default but reserved for custom use.

port: Option<u16>

Optional port.

Not set by default but reserved for custom use.

media_type: Option<MediaType>

Optional media type.

Not set by default but reserved for custom use.

languages: Option<BTreeSet<Language>>

Optional languages (sorted).

Not set by default but reserved for custom use.

extensions: Option<BTreeMap<Bytes, Bytes>>

Optional extensions (sorted by key).

Not set by default but reserved for custom use.

Implementations

impl CommonCacheKey

pub fn new( method: Method, path: Option<ByteString>, query: Option<QueryMap>, scheme: Option<Scheme>, host: Option<ByteString>, port: Option<u16>, media_type: Option<MediaType>, languages: Option<BTreeSet<Language>>, extensions: Option<BTreeMap<Bytes, Bytes>>, ) -> Self

Constructor.

Trait Implementations

impl CacheKey for CommonCacheKey

fn for_request(method: &Method, uri: &Uri, _headers: &HeaderMap) -> Self

Create a cache key for a request.

impl CacheWeight for CommonCacheKey

fn cache_weight(&self) -> usize

Cache weight as a byte count.

impl Clone for CommonCacheKey

fn clone(&self) -> CommonCacheKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommonCacheKey

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

Formats the value using the given formatter.

impl Display for CommonCacheKey

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

Formats the value using the given formatter.

impl Hash for CommonCacheKey

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 CommonCacheKey

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

impl StructuralPartialEq for CommonCacheKey