Struct Cache 

pub struct Cache(pub ReentrantMutex<RefCell<InnerCache>>);

A shareable InnerCache.

Examples

use url_cleaner_engine::glue::*;

// Note the immutability.
let cache = Cache::new(CachePath::Memory);

assert_eq!(cache.read(CacheEntryKeys { subject: "subject", key: "key" }).unwrap().map(|entry| entry.value), None);
cache.write(NewCacheEntry { subject: "subject", key: "key", value: None, duration: Default::default() }).unwrap();
assert_eq!(cache.read(CacheEntryKeys { subject: "subject", key: "key" }).unwrap().map(|entry| entry.value), Some(None));
cache.write(NewCacheEntry { subject: "subject", key: "key", value: Some("value"), duration: Default::default() }).unwrap();
assert_eq!(cache.read(CacheEntryKeys { subject: "subject", key: "key" }).unwrap().map(|entry| entry.value), Some(Some("value".into())));

Tuple Fields

0: ReentrantMutex<RefCell<InnerCache>>

Implementations

impl Cache

pub fn new(path: CachePath) -> Self

Create a new unconnected Self.

impl Cache

pub fn read( &self, keys: CacheEntryKeys<'_>, ) -> Result<Option<CacheEntryValues>, ReadFromCacheError>

Reads from the cache.

Errors

If the call to InnerCache::read returns an error, that error is returned.

pub fn write(&self, entry: NewCacheEntry<'_>) -> Result<(), WriteToCacheError>

Writes to the cache.

If an entry for the subject and key already exists, overwrites it.

Errors

If the call to InnerCache::write returns an error, that error is returned.

Trait Implementations

impl Debug for Cache

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

Formats the value using the given formatter.

impl Default for Cache

fn default() -> Cache

Returns the “default value” for a type.

impl From<CachePath> for Cache

fn from(value: CachePath) -> Self

Converts to this type from the input type.

impl From<InnerCache> for Cache

fn from(value: InnerCache) -> Self

Converts to this type from the input type.