Struct CacheKey 

pub struct CacheKey<'a>(/* private fields */);

A logical cache key.

v0 treats keys as application-provided strings. Query adapters may later derive these keys from SQL text and typed arguments.

Example

use hydracache_core::CacheKey;

let key = CacheKey::new("users:42");
assert_eq!(key.as_str(), "users:42");

Implementations

impl<'a> CacheKey<'a>

pub fn new(value: impl Into<Cow<'a, str>>) -> Self

Create a new cache key.

pub fn builder() -> CacheKeyBuilder

Start building an owned cache key from escaped segments.

Example

use hydracache_core::CacheKey;

let key = CacheKey::builder()
    .segment("tenant:7")
    .segment("users")
    .segment(42)
    .build();

assert_eq!(key.as_str(), "tenant%3A7:users:42");

pub fn as_str(&self) -> &str

Return the string representation of the key.

pub fn into_owned(self) -> CacheKey<'static>

Convert this key into an owned key.

Trait Implementations

impl<'a> Clone for CacheKey<'a>

fn clone(&self) -> CacheKey<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CacheKey<'a>

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<'a> Eq for CacheKey<'a>

impl<'a> From<&'a str> for CacheKey<'a>

fn from(value: &'a str) -> Self

Converts to this type from the input type.

impl From<String> for CacheKey<'static>

fn from(value: String) -> Self

Converts to this type from the input type.

impl<'a> Hash for CacheKey<'a>

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<'a> PartialEq for CacheKey<'a>

fn eq(&self, other: &CacheKey<'a>) -> 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<'a> StructuralPartialEq for CacheKey<'a>