Struct FileStore 

pub struct FileStore { /* private fields */ }

A store in one file, replaced whole on every save.

A save writes a temporary file beside it, flushes it to disk and renames it over the old one, so a crash leaves either the old store or the new, never a mix. On Unix the file is readable by its owner only.

Several processes can share it: lock takes a lock on a second file beside it, .<name>.lock, which stays there.

Implementations

impl FileStore

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

A store at path. Nothing is read or written yet.

pub fn path(&self) -> &Path

The file’s path.

pub fn load(&self) -> Result<Holder, Error>

Reads the saved holder, or a new empty one if the file does not exist yet.

pub fn lock_file(&self) -> Result<FileLock>

Waits until no other process holds the store’s lock, then takes it, until the returned lock is dropped. lock does this and reads the file; a store that wraps a FileStore, such as one that encrypts it, can lock it this way and read it itself.

Trait Implementations

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.

impl Debug for FileStore

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

Formats the value using the given formatter.

impl Store for FileStore

fn save(&self, json: &str) -> Result<()>

Replaces what was saved with json. Returns only once the data would survive a crash: the purse hands out keys and transfers only after this succeeds.

fn lock(&self) -> Result<Option<Locked>>

Locks the store against other processes and reads what is saved in it, for a store more than one process writes. A purse calls it before every change: it makes the change to what was read here, saves, and only then drops the lock, so it never saves over a change another process made since it last looked.