Struct LocalDocs 

pub struct LocalDocs { /* private fields */ }

The doc store of one project, at a directory the caller chose.

Implementations

impl LocalDocs

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

pub fn dir(&self) -> &Path

pub fn entries(&self) -> Result<Vec<Entry>, LocalError>

Every entry, in journal order; empty when the store was never written.

Errors

An unreadable or oversized journal, or a line that is not an entry.

pub fn space(&self) -> Result<DocSpace, LocalError>

The pages as of now.

Errors

As Self::entries.

pub fn pages(&self) -> Result<Vec<Page>, LocalError>

The live pages as Page values, by slug: what a vault takes on link (crate::write::create_page). Section bodies keep their storage form (hive: links name local page ids).

Errors

As Self::entries.

pub fn commit<E: From<LocalError>>( &self, author: &Author, at: &str, action: &str, plan: impl FnOnce(&DocSpace) -> Result<Vec<EventSpec>, E>, ) -> Result<Committed, E>

Runs plan against the current pages under the store’s lock and appends its events as one revision by author at at.

Errors

plan’s own error; a full journal or too many events; I/O.

Trait Implementations

impl Clone for LocalDocs

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 LocalDocs

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

Formats the value using the given formatter.