Trait pingora_cache::key::CacheHashKey

pub trait CacheHashKey {
    // Required methods
    fn primary_bin(&self) -> HashBinary;
    fn variance_bin(&self) -> Option<HashBinary>;
    fn user_tag(&self) -> &str;

    // Provided methods
    fn combined_bin(&self) -> HashBinary { ... }
    fn primary(&self) -> String { ... }
    fn variance(&self) -> Option<String> { ... }
    fn combined(&self) -> String { ... }
}

The trait for cache key

Required Methods

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.

None if no variance.

fn user_tag(&self) -> &str

An extra tag for identifying users

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

Provided Methods

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()

Implementors

impl CacheHashKey for CacheKey

impl CacheHashKey for CompactCacheKey