Struct CacheKey 

pub struct CacheKey {
    pub user_tag: String,
    pub extensions: Extensions,
    /* private fields */
}

General purpose cache key.

The primary hash is computed over the exact bytes supplied to CacheKey::new. Callers that combine multiple logical components, such as a namespace and URL, must encode their boundaries unambiguously before constructing the key.

Migration

The former namespace argument has been removed. Concatenating the old namespace and primary bytes preserves the legacy hash, but also preserves its ambiguous component boundaries. Switching to an unambiguous encoding changes hashes for keys with a non-empty namespace, so callers should expect a cold cache.

Fields

user_tag: String

An extra tag for identifying users

For example, if the storage backend implements per user quota, this tag can be used.

extensions: Extensions

Grab-bag for user-defined extensions. These will not be persisted to disk.

Implementations

impl CacheKey

pub fn set_variance_key(&mut self, key: HashBinary)

Set the value of the variance hash

pub fn get_variance_key(&self) -> Option<&HashBinary>

Get the value of the variance hash

pub fn remove_variance_key(&mut self)

Removes the variance from this cache key

pub fn set_primary_bin_override(&mut self, key: HashBinary)

Override the primary key hash

pub fn primary_key_str(&self) -> Option<&str>

Try to get primary key as UTF-8 str, if valid

impl CacheKey

pub fn new<B, S>(primary: B, user_tag: S) -> Self

where B: Into<Vec<u8>>, S: Into<String>,

Create a new CacheKey from the given primary key and user_tag.

Only the primary key will be hashed to produce the primary cache hash. If the primary contains multiple logical components, callers must frame them unambiguously, for example by length-prefixing each component.

pub fn primary_key(&self) -> &[u8]

Return the primary key of this key

pub fn to_compact(&self) -> CompactCacheKey

Convert this key to CompactCacheKey.

Trait Implementations

impl CacheHashKey for CacheKey

fn primary_bin(&self) -> HashBinary

Return the hash of the cache key

fn variance_bin(&self) -> Option<HashBinary>

Return the variance hash of the cache key.

fn user_tag(&self) -> &str

An extra tag for identifying users

fn combined_bin(&self) -> HashBinary

Return the hash including both primary and variance keys

fn primary(&self) -> String

The hex string of Self::primary_bin()

fn variance(&self) -> Option<String>

The hex string of Self::variance_bin()

fn combined(&self) -> String

The hex string of Self::combined_bin()

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.