Struct RecordStore 

pub struct RecordStore { /* private fields */ }

A directory of frontmatter record files.

Implementations

impl RecordStore

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

Bind the store to dir; the directory is not touched until a write.

pub fn dir(&self) -> &Path

The directory backing this store.

pub fn exists(&self) -> bool

Whether the directory exists. Reading does not create it.

pub fn list<T: DeserializeOwned + HasName>(&self) -> Result<Vec<RecordFile<T>>>

Every parseable record in the store, sorted by filename.

A missing directory is an empty store, not an error, and files whose frontmatter is unparseable or carries no name are skipped.

pub fn list_checked<T: DeserializeOwned + HasName>( &self, ) -> Result<(Vec<RecordFile<T>>, Vec<String>)>

Like RecordStore::list, additionally returning the filenames that were skipped — unparseable files and files whose frontmatter name is missing or blank. Callers that must report a broken file use this.

pub fn get<T: DeserializeOwned + HasName>( &self, name: &str, ) -> Result<RecordFile<T>>

Look a record up by its frontmatter name.

pub fn write<T: Serialize + HasName>( &self, filename: &str, value: &T, body: Option<&str>, ) -> Result<PathBuf>

Write a new record file, refusing to overwrite an existing one.

Creates the store directory on demand — the lazy rule: only a write makes a directory exist.

pub fn overwrite<T: Serialize + HasName>( &self, filename: &str, value: &T, body: Option<&str>, ) -> Result<PathBuf>

Write a record file, replacing any existing file of the same name.

pub fn rename_file( &self, old_filename: &str, new_filename: &str, ) -> Result<PathBuf>

Rename a record file in place. The caller is responsible for keeping the frontmatter name in step (see RecordStore::overwrite).

pub fn delete_file(&self, filename: &str) -> Result<()>

Remove a record file.

pub fn body_of(&self, filename: &str) -> Option<String>

The body of an existing record file, when it exists and parses. Used by callers that rewrite frontmatter to keep a hand-written body intact.

Trait Implementations

impl Clone for RecordStore

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 RecordStore

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

Formats the value using the given formatter.

impl Eq for RecordStore

impl PartialEq for RecordStore

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for RecordStore