Struct CacheKeyBuilder 

pub struct CacheKeyBuilder { /* private fields */ }

Builder for cache keys made of escaped :-separated segments.

segment escapes : and %, which keeps a single logical segment from being confused with multiple key segments.

Example

use hydracache_core::CacheKeyBuilder;

let key = CacheKeyBuilder::new()
    .segment("tenant")
    .segment(7)
    .entity("user", 42)
    .build_string();

assert_eq!(key, "tenant:7:user:42");

Implementations

impl CacheKeyBuilder

pub fn new() -> Self

Create an empty key builder.

pub fn from_segment(segment: impl ToString) -> Self

Create a key builder with one initial segment.

pub fn segment(self, segment: impl ToString) -> Self

Append one escaped key segment.

pub fn segments<I, S>(self, segments: I) -> Self

where I: IntoIterator<Item = S>, S: ToString,

Append multiple escaped key segments.

pub fn entity(self, kind: impl ToString, id: impl ToString) -> Self

Append an escaped entity kind and id pair.

pub fn tenant(self, id: impl ToString) -> Self

Append a tenant:{id} prefix.

pub fn is_empty(&self) -> bool

Return whether no segments have been added.

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

Build an owned CacheKey.

pub fn build_string(self) -> String

Build an owned key string.

Trait Implementations

impl Clone for CacheKeyBuilder

fn clone(&self) -> CacheKeyBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CacheKeyBuilder

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

Formats the value using the given formatter.

impl Default for CacheKeyBuilder

fn default() -> CacheKeyBuilder

Returns the “default value” for a type.

impl Eq for CacheKeyBuilder

impl PartialEq for CacheKeyBuilder

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