Struct kismet_cache::plain::Cache

pub struct Cache { /* fields omitted */ }

A “plain” cache is a single directory of files. Given a capacity of k files, we will trigger a second chance maintance roughly every k / 3 (k / 6 in the long run, given the way PeriodicTrigger is implemented) insertions.

Implementations

impl Cache

pub fn new(base_dir: PathBuf, capacity: usize) -> Cache

Returns a new cache for approximately capacity files in base_dir.

pub fn get(&self, name: &str) -> Result<Option<File>>

Returns a read-only file for name in the cache directory if it exists, or None if there is no such file. Fails with ErrorKind::InvalidInput if name is invalid (empty, or starts with a dot or a forward or back slash).

Implicitly “touches” the cached file name if it exists.

pub fn temp_dir(&self) -> Result<Cow<'_, Path>>

Returns a temporary directory suitable for temporary files that will be published to the cache directory.

pub fn set(&self, name: &str, value: &Path) -> Result<()>

Inserts or overwrites the file at value as name in the cache directory. Fails with ErrorKind::InvalidInput if name is invalid (empty, or starts with a dot or a forward or back slash).

Always consumes the file at value on success; may consume it on error.

pub fn put(&self, name: &str, value: &Path) -> Result<()>

Inserts the file at value as name in the cache directory if there is no such cached entry already, or touches the cached file if it already exists. Fails with ErrorKind::InvalidInput if name is invalid (empty, or starts with a dot or a forward or back slash).

Always consumes the file at value on success; may consume it on error.

pub fn touch(&self, name: &str) -> Result<bool>

Marks the cached file name as newly used, if it exists. Fails with ErrorKind::InvalidInput if name is invalid (empty, or starts with a dot or a forward or back slash).

Returns whether name exists.

Trait Implementations

impl Clone for Cache

fn clone(&self) -> Cache

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Cache

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

Formats the value using the given formatter.