Skip to main content

SemanticCacheManager

Struct SemanticCacheManager 

Source
pub struct SemanticCacheManager { /* private fields */ }
Expand description

A semantic-aware cache backed by cosine similarity search.

Entries are stored in a Vec<Slot> for simplicity and full linear-scan semantic search. For workloads requiring sub-linear semantic lookup, wrap this with an HNSW layer on top.

Implementations§

Source§

impl SemanticCacheManager

Source

pub fn new(config: ScmCacheConfig) -> Self

Create a new SemanticCacheManager with the given configuration.

Source

pub fn insert( &mut self, key: ScmCacheKey, result: Vec<u8>, ttl_us: Option<u64>, ) -> Result<u64, ScmCacheError>

Insert an entry into the cache.

Assigns a monotonically increasing entry_id and stores the entry. If the cache is over capacity after insertion, entries are evicted according to the configured ScmEvictionStrategy.

§Errors
Source

pub fn insert_at( &mut self, key: ScmCacheKey, result: Vec<u8>, ttl_us: Option<u64>, inserted_at: u64, ) -> Result<u64, ScmCacheError>

Insert with an explicit insertion timestamp (used in tests and production where you track time yourself).

Source

pub fn lookup( &mut self, query_text: &str, embedding: &[f64], current_ts: u64, ) -> Result<ScmCacheHit, ScmCacheError>

Look up a query in the cache.

  1. Scan all live entries; lazily expire any TTL-expired entries found.
  2. Check for an exact-text match (same FNV-1a hash and identical text).
  3. If no exact match, find the highest-similarity entry above the threshold.

Updates access_count and last_accessed on the winning entry.

§Errors

Returns ScmCacheError::DimensionMismatch when the provided embedding dimension differs from the inferred dimension.

Source

pub fn get_entry(&self, entry_id: u64) -> Result<&ScmCacheEntry, ScmCacheError>

Retrieve a reference to an entry by its ID.

§Errors

Returns ScmCacheError::EntryNotFound if no such ID exists.

Source

pub fn invalidate(&mut self, entry_id: u64) -> Result<(), ScmCacheError>

Remove the entry with the given ID.

§Errors

Returns ScmCacheError::EntryNotFound if no such ID exists.

Source

pub fn invalidate_similar( &mut self, embedding: &[f64], threshold: f64, ) -> Vec<u64>

Remove all entries whose embedding has cosine similarity > threshold with the given embedding. Returns the IDs of removed entries.

Source

pub fn expire_ttl(&mut self, current_ts: u64) -> Vec<u64>

Remove all TTL-expired entries as of current_ts. Returns the IDs removed.

Source

pub fn evict_to_fit(&mut self, needed_bytes: usize) -> Vec<u64>

Evict entries (per the configured strategy) until at least needed_bytes of space is available. Returns the IDs of evicted entries.

§Errors

Returns ScmCacheError::CacheAtCapacity if it is impossible to free enough space (e.g., all entries are locked or the budget is zero).

Source

pub fn semantic_neighbors( &self, embedding: &[f64], top_k: usize, ) -> Vec<(u64, f64)>

Return the top-k entries ranked by cosine similarity to embedding, without any threshold filtering.

Source

pub fn cluster_stats(&self) -> Vec<(f64, usize)>

Compute greedy cluster statistics.

Groups embeddings into clusters where every member is within config.cluster_radius (in cosine distance = 1 − similarity) of the cluster centroid. Returns a Vec of (centroid_similarity, cluster_size).

The “centroid” here is represented as the embedding of the first entry assigned to each cluster (greedy seeding). The returned f64 is the average pairwise cosine similarity within the cluster.

Source

pub fn stats(&self) -> ScmCacheStats

Return a snapshot of current cache statistics.

Trait Implementations§

Source§

impl Debug for SemanticCacheManager

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more