Struct FileStore 

pub struct FileStore { /* private fields */ }

A cache stored on disk. Cloning shares one directory and one lock table.

Implementations

impl FileStore

pub fn new(directory: impl Into<PathBuf>) -> Result<Self>

Create a store rooted at directory, creating the directory if needed.

pub fn with_prefix( directory: impl Into<PathBuf>, prefix: impl Into<String>, ) -> Result<Self>

pub fn directory(&self) -> &Path

pub fn path_for(&self, key: &str) -> PathBuf

The file backing a key. Public so a test can prove where a hostile key actually lands.

Trait Implementations

impl Cache for FileStore

fn driver(&self) -> &'static str

The driver’s name, used in cache.hit / cache.miss events and in error messages. Telescope shows it as the store column.

fn get<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<Option<Json>>>

Fetch a value, or None when it is missing or expired.

fn put<'a>( &'a self, key: &'a str, value: Json, ttl: Duration, ) -> BoxFuture<'a, Result<()>>

Store a value that expires after ttl.

fn forever<'a>(&'a self, key: &'a str, value: Json) -> BoxFuture<'a, Result<()>>

Store a value with no expiry. It still goes away on Cache::flush.

fn forget<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<bool>>

Remove a key. Returns whether something was actually there.

fn flush(&self) -> BoxFuture<'_, Result<()>>

Remove everything this store owns.

fn increment<'a>(&'a self, key: &'a str, by: i64) -> BoxFuture<'a, Result<i64>>

Add by to a counter, creating it at zero first. Returns the new value.

fn increment_within<'a>( &'a self, key: &'a str, by: i64, ttl: Duration, ) -> BoxFuture<'a, Result<i64>>

Increment a counter, giving it ttl only when this call created it.

fn ttl<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<Option<Duration>>>

How long until a key expires: None when it is missing or immortal.

fn has<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<bool>>

Whether a live (unexpired) value exists.

fn decrement<'a>(&'a self, key: &'a str, by: i64) -> BoxFuture<'a, Result<i64>>

Subtract by from a counter. Returns the new value.

fn pull<'a>(&'a self, key: &'a str) -> BoxFuture<'a, Result<Option<Json>>>

Read a value and remove it in one call — Laravel’s Cache::pull.

impl Clone for FileStore

fn clone(&self) -> FileStore

Returns a duplicate of the value.

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

Performs copy-assignment from source.