Struct FileStateStore 

pub struct FileStateStore { /* private fields */ }

File-backed StateStore. Each key maps to a JSON file at {root}/{safe_filename(key)}.json, written via atomic rename. The filename stem percent-encodes : as %3A so keys using the pipeline:rest:issues convention are valid on Windows.

Each put writes a temp file, fsyncs it, renames it over the final path, and (on Unix) fsyncs the parent directory — so once put returns the bookmark is durable across a crash or power loss, not merely sitting in the page cache.

The store creates its root directory on first use. All writes are serialized through a per-store mutex so two concurrent puts for the same key cannot race on the temp filename. Different processes pointing at the same directory rely on the filesystem’s atomic rename guarantee.

Implementations

impl FileStateStore

pub fn new(root: impl Into<PathBuf>) -> FileStateStore

Open or create a file-backed state store rooted at root.

pub fn with_encryption(self, encryption: CompiledEncryption) -> FileStateStore

Available on crate feature encryption only.

Seal bookmark files at rest with the given policy (#207). Reads accept both sealed and (legacy) plaintext files; every write seals.

pub fn root(&self) -> &Path

Returns the root directory this store writes into.

Trait Implementations

impl StateStore for FileStateStore

fn get<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Value>, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, FileStateStore: 'async_trait,

Return the value stored under key, or None if no entry exists.

fn put<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, key: &'life1 str, value: &'life2 Value, ) -> Pin<Box<dyn Future<Output = Result<(), FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, FileStateStore: 'async_trait,

Store value under key, replacing any previous entry.

fn delete<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<(), FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, FileStateStore: 'async_trait,

Remove the entry for key. A missing key is not an error.

fn check<'life0, 'life1, 'async_trait>( &'life0 self, _ctx: &'life1 CheckContext, ) -> Pin<Box<dyn Future<Output = Result<CheckReport, FaucetError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, FileStateStore: 'async_trait,

Run a fast, non-mutating preflight probe (used by faucet doctor).