Struct dyn_cache::sync::SendCache

pub struct SendCache { /* fields omitted */ }

Holds arbitrary query results which are namespaced by arbitrary scope types. Usually used through SharedSendCache::cache_with and SharedSendCache::gc.

Query types

Note: the types referenced in this documentation are only visible on individual methods, as SendCache is not itself a generic type.

Storage is sharded by the type of the query. The type of a query has three parts:

The query scope is the value which indexes the storage for a particular query type, it has the bound Scope: 'static + Eq + Hash + Send.

Each Scope corresponds to at most a single Input: 'static + Send and a single Output: 'static + Send value at any given time.

Reading stored values

See SendCache::get which accepts borrowed forms of Scope and Input: Key and Arg respectively. Arg must satisfy PartialEq<Input> to determine whether to return a stored output.

Garbage Collection

Each time SendCache::gc is called it removes any values which haven’t been referenced since the prior call.

After each GC, all values still in the cache are marked garbage. They are marked live again when inserted with SendCache::store or read with SendCache::get.

Implementations

impl SendCache

pub fn get<'k, Key, Scope, Arg, Input, Output>(
    &self,
    key: &'k Key,
    arg: &Arg
) -> Result<&Output, CacheMiss<'k, Key, Scope, Input, Output>> where
    Key: Eq + Hash + ToOwned<Owned = Scope> + ?Sized,
    Scope: 'static + Borrow<Key> + Eq + Hash,
    Arg: PartialEq<Input> + ToOwned<Owned = Input> + ?Sized,
    Input: 'static + Borrow<Arg>,
    Output: 'static, 

Return a reference to a query’s stored output if a result is stored and arg equals the previously-stored Input. If a reference is returned, the stored input/output is marked as a root and will not be GC’d the next call.

If no reference is found, a CacheMiss is returned. Call CacheMiss::init to get a CacheEntry to pass to SendCache::store.

pub fn store<Key, Scope, Input, Output>(
    &mut self,
    entry: CacheEntry<'_, Key, Scope, Input, Output>
) where
    Key: Eq + Hash + ToOwned<Owned = Scope> + ?Sized,
    Scope: 'static + Borrow<Key> + Eq + Hash + Send,
    Input: 'static + Send,
    Output: 'static + Send, 

Stores a fresh CacheEntry whose input/output will not be GC’d at the next call. Call SendCache::get to get a CacheMiss and CacheMiss::init to get a CacheEntry.

pub fn gc(&mut self)

Drop any values which have not been marked alive since the last call to this method.

Trait Implementations

impl Debug for SendCache

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

Formats the value using the given formatter.

impl Default for SendCache

fn default() -> SendCache

Returns the “default value” for a type.

impl From<SendCache> for SharedSendCache

fn from(inner: SendCache) -> Self

Performs the conversion.

impl RefUnwindSafe for SendCache

impl UnwindSafe for SendCache