Struct VecCache

pub struct VecCache<'f, O> { /* private fields */ }

A cache for a function which uses a Vec.

This cache is optimized for functions which must be calculated in order, so that there can be no gaps in the cache, and use usize as an argument.

If the function does not start at zero, or require every previous value to be calculated for the next one, consider using a HashCache instead.

Implementations

impl<'f, O> VecCache<'f, O>

pub fn new<F>(f: F) -> Self

where F: Fn(&usize) -> O + 'f + Send + Sync,

Create a cache for the provided function. If the function stores references, the cache can only live as long as those references.

pub fn recursive<F>(f: F) -> Self

where F: Fn(&mut Self, &usize) -> O + 'f + Send + Sync,

Create a cache for the provided recursive function. If the function stores references, the cache can only live as long as those references.

pub fn clear(&mut self)

Clears the cache. removing all values. Keeps the allocated memory for reuse.

pub fn len(&self) -> usize

Returns the number of elements in the cache.

pub fn reserve(&mut self, additional: usize)

Reserves capacity for at least additional more elements to be inserted in the cache. The collection may reserve more space to avoid frequent reallocations.

Trait Implementations

impl<'f, O> FnCache<usize, O> for VecCache<'f, O>

fn get(&mut self, input: usize) -> &O

Retrieve a value stored in the cache. If the value does not yet exist in the cache, the function is called, and the result is added to the cache before returning it.

impl<'f, O> FnCacheMany<usize, O> for VecCache<'f, O>

fn get_many<const N: usize>(&mut self, inputs: [usize; N]) -> [&O; N]

Retrieve multiple values stored in the cache. If any of the values do not yet exist, the function is called, and the result is added to the cache before returning them.