Struct FileStore 

pub struct FileStore { /* private fields */ }

The spec/ tree under a directory.

Implementations

impl FileStore

pub fn open(root: &Path) -> Result<Self, StoreError>

The store of the tree under root, after finishing a committed save there that was interrupted, or discarding an uncommitted one.

Errors

An interrupted save that cannot be recovered.

pub fn read_files(&self) -> Result<Files, StoreError>

Every file of the tree, by its path under spec/.

Errors

A missing spec/ directory, a file that cannot be read, or a name that is not UTF-8.

pub fn write_files(&self, files: Files) -> Result<(), StoreError>

Writes the given files of the tree in one save and removes none.

Errors

A file that cannot be staged or put in place.

pub fn import(&self, files: Files, sidecar: &[u8]) -> Result<(), StoreError>

Writes an imported tree into an empty or missing spec/, and the sidecar beside it, in one save.

Errors

spec/ holds a file or directory already (RQ-134), in which case nothing is written; or a file cannot be written.

pub fn create(&self, files: Files) -> Result<(), StoreError>

Writes a new tree into a spec/ that does not exist yet, in one save.

Errors

spec/ exists already, in which case nothing is written; or a file cannot be written.

pub fn lock(&self) -> Result<Option<Lock>, StoreError>

The lock beside spec/, or none.

Errors

The lock is there but cannot be read, or is not a valid lock record.

pub fn publish(&self, files: Files, lock: &Lock) -> Result<(), StoreError>

Writes what a publish gives in one save: the files under spec/ it changes, and the lock beside spec/; all of them or none (AC-463).

Errors

A file cannot be staged or put in place.

Trait Implementations

impl Clone for FileStore

fn clone(&self) -> Self

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 DocumentStore for FileStore

fn save(&mut self, document: &Document) -> Result<Saved, StoreError>

Writes each file whose bytes change and removes each file the document no longer has, in one save; a file whose bytes would not change is left alone. A save of this store’s that failed part-way is finished first, so the tree it compares against is the one it left.

fn load(&self) -> Result<Document, StoreError>

The document the store holds.

fn roots(&self) -> Result<Roots, StoreError>

The roots of the document the store holds.