Struct Cache

pub struct Cache(pub Mutex<InnerCache>);

A Mutexed InnerCache.

Examples

use url_cleaner_engine::glue::*;

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

assert_eq!(cache.read("category", "key").unwrap(), None);
cache.write("category", "key", None).unwrap();
assert_eq!(cache.read("category", "key").unwrap(), Some(None));
cache.write("category", "key", Some("value")).unwrap();
assert_eq!(cache.read("category", "key").unwrap(), Some(Some("value".into())));

Tuple Fields

0: Mutex<InnerCache>

Implementations

impl Cache

pub fn new(path: CachePath) -> Self

Create a new unconnected Self.

impl Cache

pub fn read( &self, category: &str, key: &str, ) -> Result<Option<Option<String>>, ReadFromCacheError>

Reads from the cache.

Errors

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

pub fn write( &self, category: &str, key: &str, value: Option<&str>, ) -> Result<(), WriteToCacheError>

Writes to the cache.

If an entry for the category 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.