Skip to main content

ContentAddressableCache

Struct ContentAddressableCache 

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

High-performance content-addressable cache.

Keyed by FNV-1a-derived CIDs; supports LRU, LFU, TTL-first, size-weighted, and tag-targeted eviction policies. Thread-safety must be provided by the caller.

Implementations§

Source§

impl ContentAddressableCache

Source

pub fn new(config: CacheConfig) -> Self

Create a new cache with the given configuration.

Source

pub fn insert( &mut self, data: Vec<u8>, ttl_us: Option<u64>, tags: Vec<String>, ) -> Result<String, CacheError>

Insert data into the cache.

Computes the CID automatically; applies ttl_us (or the configured default) and the given tags. Returns the derived CID on success.

Source

pub fn insert_with_cid( &mut self, cid: String, data: Vec<u8>, ttl_us: Option<u64>, tags: Vec<String>, ) -> Result<(), CacheError>

Insert data under a caller-supplied cid.

Verifies that the CID matches the data; returns CacheError::CidMismatch otherwise.

Source

pub fn get(&mut self, cid: &str) -> Result<&[u8], CacheError>

Retrieve the data payload for cid.

Updates LRU position and increments access_count. Returns CacheError::TtlExpired (and removes the entry) if the entry has expired.

Source

pub fn get_entry(&self, cid: &str) -> Result<&CacheEntry, CacheError>

Retrieve the full CacheEntry for cid (read-only, does NOT update LRU or access counts).

Source

pub fn contains(&self, cid: &str) -> bool

Return true when an entry for cid exists and has not expired. Does not update LRU position.

Source

pub fn remove(&mut self, cid: &str) -> Result<CacheEntry, CacheError>

Remove and return the entry for cid.

Source

pub fn remove_by_tag(&mut self, tag: &str) -> Vec<String>

Remove all entries bearing tag and return their CIDs.

Source

pub fn expire_ttl(&mut self) -> Vec<String>

Scan the cache and remove all TTL-expired entries.

Returns the CIDs that were removed.

Source

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

Evict entries per policy until needed_bytes additional bytes can be accommodated without exceeding max_bytes.

Returns the CIDs evicted.

Source

pub fn stats(&self) -> CacheStats

Return a snapshot of current cache statistics.

Source

pub fn clear(&mut self) -> usize

Remove all entries and return how many were cleared.

Source

pub fn cids(&self) -> Vec<String>

Return the CIDs of all currently-cached entries.

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