Struct LocalCache 

pub struct LocalCache<T> { /* private fields */ }

A cache that can store only a single type.

It is internally reference counted, so cloning it is cheap.

Implementations

impl<T> LocalCache<T>

pub fn new() -> Self

Constructs a new cache with no entries.

pub fn is_cached(&self, path: impl AsRef<str>) -> bool

Checks if a value exists in the cache.

pub async fn is_cached_async(&self, path: impl AsRef<str>) -> bool

Checks if a value exists in the cache. Waiting is done asynchronously.

pub fn get(&self, path: impl AsRef<str>) -> Option<Arc<T>>

Obtains a value from the cache, if it exists.

pub async fn get_async(&self, path: impl AsRef<str>) -> Option<Arc<T>>

Obtains a value from the cache, if it exists. Waiting is done asynchronously.

pub fn get_or(&self, path: impl AsRef<str>, default: Arc<T>) -> Arc<T>

Obtains a value from the cache, or adds default if it does not exist.

pub async fn get_or_async( &self, path: impl AsRef<str>, default: Arc<T>, ) -> Arc<T>

Obtains a value from the cache, or adds default if it does not exist. Waiting is done asynchronously.

pub fn get_or_else<F: FnOnce() -> Arc<T>>( &self, path: impl AsRef<str>, f: F, ) -> Arc<T>

Obtains a value from the cache, or loads it from a closure if it does not exist.

pub async fn get_or_else_async<F: AsyncFnOnce() -> Arc<T>>( &self, path: impl AsRef<str>, f: F, ) -> Arc<T>

Similar to get_or_else, but for async closures.

Unlike the non-async variants, this not an atomic operation. Your closure may be run more than once, but only the first run will write to the cache.

pub fn get_or_else_try<F>(&self, path: impl AsRef<str>, f: F) -> Option<Arc<T>>

where F: FnOnce() -> Option<Arc<T>>,

Similar to get_or_else, but allows the closure to return None, in which case the value is not added to the cache and None is returned.

pub async fn get_or_else_try_async<F: AsyncFnOnce() -> Option<Arc<T>>>( &self, path: impl AsRef<str>, f: F, ) -> Option<Arc<T>>

Similar to get_or_else_async, but allows the closure to return None, in which case the value is not added to the cache and None is returned.

Unlike the non-async variants, this not an atomic operation. Your closure may be run more than once, but only the first run will write to the cache.

pub fn uncache(&self, path: impl AsRef<str>)

Removes a file from the cache, if it exists.

pub fn clear(&self)

Removes all entries from the cache.

Trait Implementations

impl<T: Clone> Clone for LocalCache<T>

fn clone(&self) -> LocalCache<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T> Default for LocalCache<T>

fn default() -> Self

Returns the “default value” for a type.