Struct Cache 

pub struct Cache<E: Storage + Metrics, V: CodecShared> { /* private fields */ }

Implementation of Cache storage.

Implementations

impl<E: Storage + Metrics, V: CodecShared> Cache<E, V>

pub async fn init(context: E, cfg: Config<V::Cfg>) -> Result<Self, Error>

Initialize a new Cache instance.

The in-memory index for Cache is populated during this call by replaying the journal.

pub async fn get(&self, index: u64) -> Result<Option<V>, Error>

Retrieve an item from the Cache.

pub fn next_gap(&self, index: u64) -> (Option<u64>, Option<u64>)

Retrieve the next gap in the Cache.

pub fn first(&self) -> Option<u64>

Returns the first index in the Cache.

pub fn missing_items(&self, start: u64, max: usize) -> Vec<u64>

Returns up to max missing items starting from start.

This method iterates through gaps between existing ranges, collecting missing indices until either max items are found or there are no more gaps to fill.

pub fn has(&self, index: u64) -> bool

Check if an item exists in the Cache.

pub async fn prune(&mut self, min: u64) -> Result<(), Error>

Prune Cache to the provided min.

If this is called with a min lower than the last pruned, nothing will happen.

pub async fn put(&mut self, index: u64, value: V) -> Result<(), Error>

Store an item in the Cache.

If the index already exists, put does nothing and returns.

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

Sync all pending writes.

pub async fn put_sync(&mut self, index: u64, value: V) -> Result<(), Error>

Stores an item in the Cache and syncs it, plus any other pending writes, to disk.

If the index already exists, the cache is just synced.

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

Remove all persistent data created by this Cache.

Trait Implementations

impl<E: Storage + Metrics, V: CodecShared> Gettable for Cache<E, V>

type Key = u64

type Value = V

type Error = Error

async fn get(&self, key: &Self::Key) -> Result<Option<Self::Value>, Self::Error>

Get the value of a key.