Struct rom_cache::cache::Cache

pub struct Cache<const G: usize, const L: usize> { /* private fields */ }

A cache storage structure.

• G: the number of cache groups
• L: the number of cache lines in each group

load a Cacheable into memory:

1. cache hit: update LRU
2. cache empty: load Cacheable into the cache
3. cache group full: evict the least recently used Cacheable
4. Cacheable::load() failed: IoError

The cache refreshes itself by the LRU algorithm.

If CacheMut is dereferenced, cache will be marked dirty, Cacheable::store() will be called when:

1. The Cache is dropped.
2. The CacheLine holding the dirty Cacheable is evicted.

Implementations

impl<const G: usize, const L: usize> Cache<G, L>

pub fn get<T: Cacheable + Default>(&self) -> CacheResult<CacheRef<'_, T>>

Retrieve a Cacheable from the cache. Use Default if Cacheable::load() failed. At most 63 CacheRefs for each Cacheable type can be retrieved at the same time.

• If the cache hit, return a CacheRef.
• CacheError::Busy: cache miss, the CacheLine chosen to evict is being used.
• CacheError::Locked: cache hit, but the CacheLine for T is being written.

pub fn get_mut<T: Cacheable + Default>(&self) -> CacheResult<CacheMut<'_, T>>

Retrieve a mut Cacheable from the cache.

• If the cache hit, return a CacheMut. Use Default if Cacheable::load() failed.
• CacheError::Busy: cache miss, the CacheLine chosen to evict is being used.
• CacheError::Locked: cache hit, but the CacheLine for T is being read or written.

Trait Implementations

impl<const G: usize, const L: usize> Clone for Cache<G, L>

fn clone(&self) -> Cache<G, L>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<const G: usize, const L: usize> Debug for Cache<G, L>

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

Formats the value using the given formatter.

impl<const G: usize, const L: usize> Default for Cache<G, L>

fn default() -> Cache<G, L>

Returns the “default value” for a type.