Struct CacheHandle 

pub struct CacheHandle<'a> {
    pub cache: &'a Cache,
    pub config: CacheHandleConfig,
}

A wrapper around a Cache for optional security features provided by CacheHandleConfig.

Unlike Cache, which is intended to be shared between Jobs, CacheHandles are intended to be made on a per-Job basis using the CacheHandleConfig appropriate for each particular Job.

For example, a CLI program writing results to a file doesn’t need to enable cache delay/unthreading, but a userscript should.

Examples

use url_cleaner_engine::glue::*;
use std::time::Duration;

let cache = CacheHandle {
    cache: &Default::default(),
    config: Default::default()
};

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())));

Fields

cache: &'a Cache

The Cache.

config: CacheHandleConfig

The CacheHandleConfig.

Implementations

impl CacheHandle<'_>

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.

Panics

If, somehow, rand::rngs::OsRng doesn’t work, this panics when Self::config’s CacheHandleConfig::delay is true.

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<'a> Clone for CacheHandle<'a>

fn clone(&self) -> CacheHandle<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for CacheHandle<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for CacheHandle<'a>