Struct foyer::Store

pub struct Store<K, V, S = RandomState>
where
    K: StorageKey,
    V: StorageValue,
    S: HashBuilder + Debug,
{ /* private fields */ }

The disk cache engine that serves as the storage backend of foyer.

Implementations

impl<K, V, S> Store<K, V, S>

where K: StorageKey, V: StorageValue, S: HashBuilder + Debug,

pub async fn close(&self) -> Result<(), Error>

Close the disk cache gracefully.

close will wait for all ongoing flush and reclaim tasks to finish.

pub fn pick(&self, key: &K) -> bool

Return if the given key can be picked by the admission picker.

pub fn enqueue(&self, entry: CacheEntry<K, V, S>, force: bool)

Push a in-memory cache entry to the disk cache write queue.

pub async fn load<Q>(&self, key: &Q) -> Result<Option<(K, V)>, Error>

where K: Borrow<Q>, Q: Hash + Eq + Send + Sync + 'static + ?Sized,

Load a cache entry from the disk cache.

pub fn delete<'a, Q>(&'a self, key: &'a Q)

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Delete the cache entry with the given key from the disk cache.

pub fn may_contains<Q>(&self, key: &Q) -> bool

where K: Borrow<Q>, Q: Hash + Eq + ?Sized,

Check if the disk cache contains a cached entry with the given key.

contains may return a false-positive result if there is a hash collision with the given key.

pub async fn destroy(&self) -> Result<(), Error>

Delete all cached entries of the disk cache.

pub fn stats(&self) -> Arc<DeviceStats>

Get the statistics information of the disk cache.

pub fn runtimes(&self) -> &Runtime

👎Deprecated since 0.11.5: The function will be renamed to “runtime()”, use it instead.

Get the runtime handles.

pub fn runtime(&self) -> &Runtime

Get the runtime.

Trait Implementations

impl<K, V, S> Clone for Store<K, V, S>

where K: StorageKey, V: StorageValue, S: HashBuilder + Debug,

fn clone(&self) -> Store<K, V, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<K, V, S> Debug for Store<K, V, S>

where K: StorageKey, V: StorageValue, S: HashBuilder + Debug,

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

Formats the value using the given formatter.