Struct Store 

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

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

Implementations

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

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

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

Close the disk cache gracefully.

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

pub fn filter(&self, hash: u64, estimated_size: usize) -> StorageFilterResult

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

pub fn enqueue(&self, piece: Piece<K, V, P>, force: bool)

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

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

where Q: Hash + Equivalent<K> + ?Sized,

Load a cache entry from the disk cache.

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

where Q: Hash + Equivalent<K> + ?Sized,

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

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

where Q: Hash + Equivalent<K> + ?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<()>

Delete all cached entries of the disk cache.

pub fn device(&self) -> &Arc<dyn Device>

Get the device of the disk cache.

pub fn statistics(&self) -> &Arc<Statistics>

Get the statistics information of the disk cache.

pub fn throttle(&self) -> &Throttle

Get the io throttle of the disk cache.

pub fn spawner(&self) -> &Spawner

Get the spawner.

pub async fn wait(&self)

Wait for the ongoing flush and reclaim tasks to finish.

pub fn entry_estimated_size(&self, key: &K, value: &V) -> usize

Return the estimated serialized size of the entry.

pub fn is_enabled(&self) -> bool

If the disk cache is enabled.

Trait Implementations

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

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

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

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

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

Formats the value using the given formatter.