Skip to main content

LanceCache

Struct LanceCache 

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

Typed cache wrapper that handles key construction and type safety.

Internally delegates to a CacheBackend. The default backend is MokaCacheBackend; pass a custom backend via LanceCache::with_backend.

Implementations§

Source§

impl LanceCache

Source

pub fn with_capacity(capacity: usize) -> Self

Source

pub fn with_backend(backend: Arc<dyn CacheBackend>) -> Self

Create a cache backed by a custom CacheBackend.

Source

pub fn no_cache() -> Self

Source

pub fn with_backend_and_prefix( backend: Arc<dyn CacheBackend>, prefix: String, ) -> Self

Create a cache with the given backend and an exact prefix string. Unlike with_key_prefix, this sets the prefix verbatim (no trailing slash added).

Source

pub fn with_key_prefix(&self, prefix: &str) -> Self

Appends a prefix to the cache key.

Source

pub async fn invalidate_prefix(&self, prefix: &str)

Invalidate all entries whose prefix starts with the given string.

Source

pub async fn size(&self) -> usize

Source

pub fn approx_size(&self) -> usize

Source

pub async fn size_bytes(&self) -> usize

Source

pub async fn keys(&self) -> Option<CacheKeyIterator<'_>>

Return an iterator over keys currently stored under this cache’s prefix.

Returns None when the backend does not support key inventory. The iterator is intended for diagnostics and may be weakly consistent with concurrent cache mutations.

§Examples
let cache = LanceCache::with_capacity(1024);
cache.insert_with_key(&MyKey, Arc::new(vec![1, 2, 3])).await;

let mut keys = cache.keys().await.expect("Moka supports key inventory");
assert_eq!(keys.next().unwrap().key(), "my-key");
Source

pub async fn stats(&self) -> CacheStats

Source

pub async fn clear(&self)

Source

pub async fn insert_with_key<K>( &self, cache_key: &K, metadata: Arc<K::ValueType>, )
where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Source

pub async fn get_with_key<K>(&self, cache_key: &K) -> Option<Arc<K::ValueType>>
where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Source

pub async fn get_or_insert_with_key<K, F, Fut>( &self, cache_key: K, loader: F, ) -> Result<Arc<K::ValueType>>
where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static, F: FnOnce() -> Fut + Send, Fut: Future<Output = Result<K::ValueType>> + Send,

Source

pub async fn insert_unsized_with_key<K>( &self, cache_key: &K, metadata: Arc<K::ValueType>, )
where K: UnsizedCacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Source

pub async fn get_unsized_with_key<K>( &self, cache_key: &K, ) -> Option<Arc<K::ValueType>>
where K: UnsizedCacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Trait Implementations§

Source§

impl Clone for LanceCache

Source§

fn clone(&self) -> LanceCache

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for LanceCache

Source§

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

Formats the value using the given formatter. Read more
Source§

impl DeepSizeOf for LanceCache

Auto Trait Implementations§

Blanket Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
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> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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