Struct KeyPointerCache

pub struct KeyPointerCache<const PAGE_COUNT: usize, KEY: Key, const KEYS: usize> { /* private fields */ }

An object that caches the location of the newest item with a given key. This cache also caches pages states and page pointers.

This cache has to be kept around and passed to every api call to the same memory region until the cache gets discarded.

Valid usecase:
Create cache 1 -> use 1 -> use 1 -> create cache 2 -> use 2 -> use 2

Invalid usecase:
Create cache 1 -> use 1 -> create cache 2 -> use 2 -> ❌ use 1 ❌

Make sure the page count is correct. If the number is lower than the actual amount, the code will panic at some point.

The number of key slots can be lower than the total amount of possible keys used, but this will lower the chance of a cache hit. The keys are cached in a fifo and any time its location is updated in cache it’s added to the front.

Implementations

impl<const PAGE_COUNT: usize, KEY: Key, const KEYS: usize> KeyPointerCache<PAGE_COUNT, KEY, KEYS>

pub const fn new() -> Self

Construct a new instance

Trait Implementations

impl<const PAGE_COUNT: usize, KEY: Debug + Key, const KEYS: usize> Debug for KeyPointerCache<PAGE_COUNT, KEY, KEYS>

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

Formats the value using the given formatter.

impl<const PAGE_COUNT: usize, KEY: Key, const KEYS: usize> Default for KeyPointerCache<PAGE_COUNT, KEY, KEYS>

fn default() -> Self

Returns the “default value” for a type.

impl<const PAGE_COUNT: usize, KEY: Key, const KEYS: usize> CacheImpl for KeyPointerCache<PAGE_COUNT, KEY, KEYS>

impl<const PAGE_COUNT: usize, KEY: Key, const KEYS: usize> KeyCacheImpl<KEY> for KeyPointerCache<PAGE_COUNT, KEY, KEYS>