Trait datafusion_execution::cache::CacheAccessor

pub trait CacheAccessor<K, V>: Send + Sync {
    type Extra: Clone;

    // Required methods
    fn get(&self, k: &K) -> Option<V>;
    fn get_with_extra(&self, k: &K, e: &Self::Extra) -> Option<V>;
    fn put(&self, key: &K, value: V) -> Option<V>;
    fn put_with_extra(&self, key: &K, value: V, e: &Self::Extra) -> Option<V>;
    fn remove(&mut self, k: &K) -> Option<V>;
    fn contains_key(&self, k: &K) -> bool;
    fn len(&self) -> usize;
    fn clear(&self);
    fn name(&self) -> String;

    // Provided method
    fn is_empty(&self) -> bool { ... }
}

The cache accessor, users usually working on this interface while manipulating caches. This interface does not get mut references and thus has to handle its own locking via internal mutability. It can be accessed via multiple concurrent queries during planning and execution.

Required Associated Types

type Extra: Clone

Required Methods

fn get(&self, k: &K) -> Option<V>

Get value from cache.

fn get_with_extra(&self, k: &K, e: &Self::Extra) -> Option<V>

Get value from cache.

fn put(&self, key: &K, value: V) -> Option<V>

Put value into cache. Returns the old value associated with the key if there was one.

fn put_with_extra(&self, key: &K, value: V, e: &Self::Extra) -> Option<V>

Put value into cache. Returns the old value associated with the key if there was one.

fn remove(&mut self, k: &K) -> Option<V>

Remove an entry from the cache, returning value if they existed in the map.

fn contains_key(&self, k: &K) -> bool

Check if the cache contains a specific key.

fn len(&self) -> usize

Fetch the total number of cache entries.

fn clear(&self)

Remove all entries from the cache.

fn name(&self) -> String

Return the cache name.

Provided Methods

fn is_empty(&self) -> bool

Check if the Cache collection is empty or not.

Trait Implementations

impl Debug for dyn CacheAccessor<Path, Arc<Statistics>, Extra = ObjectMeta>

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

Formats the value using the given formatter.

impl Debug for dyn CacheAccessor<Path, Arc<Vec<ObjectMeta>>, Extra = ObjectMeta>

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

Formats the value using the given formatter.

Implementors

impl CacheAccessor<Path, Arc<Vec<ObjectMeta>>> for DefaultListFilesCache

type Extra = ObjectMeta

impl CacheAccessor<Path, Arc<Statistics>> for DefaultFileStatisticsCache

type Extra = ObjectMeta