Struct WeakLanceCache 

pub struct WeakLanceCache { /* private fields */ }

A weak reference to a LanceCache, used by indices to avoid circular references. When the original cache is dropped, operations on this will gracefully no-op.

Implementations

impl WeakLanceCache

pub fn from(cache: &LanceCache) -> Self

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

pub async fn get_resident_with_key<K>( &self, cache_key: &K, ) -> Option<Arc<K::ValueType>>

where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Read RAM only, avoiding whole-entry promotion for candidate range reads.

pub async fn peek_resident_with_key<K: CacheKey>(&self, cache_key: &K) -> bool

Report residency without counting as an access; a dropped cache holds nothing.

pub async fn peek_tier_with_key<K: CacheKey>(&self, cache_key: &K) -> CacheTier

Predict the serving tier without counting as an access; a dropped cache holds nothing.

pub fn plane_admission_gated(&self) -> bool

Whether lower layered planes gate RAM admission; a dropped cache keeps the default.

pub async fn get_without_promotion_with_key<K>( &self, cache_key: &K, ) -> Option<Arc<K::ValueType>>

where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Read a cached candidate plane without whole-entry RAM admission.

pub async fn get_rows_with_key<K>( &self, cache_key: &K, rows: &[u32], ) -> Option<Arc<K::ValueType>>

where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Read selected cached rows without promoting a whole plane.

pub fn capacity_bytes(&self) -> Option<usize>

Weighted capacity in bytes, if the cache is alive and its backend reports one.

pub async fn get_with_key<K>(&self, cache_key: &K) -> Option<Arc<K::ValueType>>

where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

pub async fn insert_with_key<K>( &self, cache_key: &K, value: Arc<K::ValueType>, ) -> bool

where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

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,

Get or insert an item, computing it if necessary.

Deduplication of concurrent loads is handled by the backend.

pub async fn get_or_insert_with_key_hit<K, F, Fut>( &self, cache_key: K, loader: F, ) -> Result<(Arc<K::ValueType>, bool)>

where K: CacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static, F: FnOnce() -> Fut + Send, Fut: Future<Output = Result<K::ValueType>> + Send,

Same as get_or_insert_with_key, but also returns a boolean indicating whether the loader was skipped for this call. See LanceCache::get_or_insert_with_key_hit for the coalesced-load caveat.

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,

pub async fn insert_unsized_with_key<K>( &self, cache_key: &K, value: Arc<K::ValueType>, )

where K: UnsizedCacheKey, K::ValueType: DeepSizeOf + Send + Sync + 'static,

Trait Implementations

impl Clone for WeakLanceCache

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WeakLanceCache

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

Formats the value using the given formatter.