Struct CacheKey 

pub struct CacheKey(/* private fields */);

A cache key.

Implementations

impl CacheKey

pub fn new(value: impl Into<String>) -> CacheKey

Creates a new string-backed primitive.

pub fn as_str(&self) -> &str

Returns the stored string value.

impl CacheKey

pub fn builder() -> CacheKeyBuilder

Creates a cache key builder.

Examples found in repository

examples/basic_usage.rs (line 14)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let collection = CollectionName::new("customers");
    let document_id = DocumentId::new("customer_123");
    let patch = PatchSet::new(vec![PatchOperation::set(
        DocumentPath::new("profile.display_name"),
        "Joshua Whalen",
    )]);

    let key = CacheKey::builder()
        .namespace(CacheNamespace::new("reviews"))
        .segment("google-business-profile")
        .segment("location")
        .segment("fort-wayne")
        .segment("summary")
        .build();

    let record = VectorRecord::new(
        VectorId::new("review_789_embedding"),
        Embedding::new(vec![0.012, -0.032, 0.481]),
    )
    .with_dimension(VectorDimension::new(3))?
    .with_similarity_metric(SimilarityMetric::Cosine);

    assert_eq!(collection.as_str(), "customers");
    assert_eq!(document_id.as_str(), "customer_123");
    assert_eq!(patch.operations().len(), 1);
    assert_eq!(
        key.to_string(),
        "reviews:google-business-profile:location:fort-wayne:summary"
    );
    assert_eq!(record.dimension(), Some(VectorDimension::new(3)));

    Ok(())
}

Trait Implementations

impl AsRef<str> for CacheKey

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

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

Formats the value using the given formatter.

impl Default for CacheKey

fn default() -> CacheKey

Returns the “default value” for a type.

impl Display for CacheKey

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

Formats the value using the given formatter.

impl From<&str> for CacheKey

fn from(value: &str) -> CacheKey

Converts to this type from the input type.

impl From<String> for CacheKey

fn from(value: String) -> CacheKey

Converts to this type from the input type.

impl Hash for CacheKey

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

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 Ord for CacheKey

fn cmp(&self, other: &CacheKey) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CacheKey

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

fn partial_cmp(&self, other: &CacheKey) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for CacheKey

impl StructuralPartialEq for CacheKey