Struct DirBackend 

pub struct DirBackend { /* private fields */ }

Every script as plain files under one directory the host chooses:

<root>/<name>/head.json               the head (compare-and-set on every write)
<root>/<name>/versions/<hex>.json     one immutable version, named by its sha256
<root>/<name>/runs/<id>.json          one run record

One host process per directory, the rule ikigai-store states for RocksDB: writes are serialized by a lock in this process, and a second process writing the same directory would race it. People editing files by hand are expected and survivable; see the module documentation.

Implementations

impl DirBackend

pub fn open(root: impl Into<PathBuf>) -> Result<DirBackend>

Open (creating it if needed) the directory root.

pub fn root(&self) -> &Path

The directory.

Trait Implementations

impl Backend for DirBackend

fn head(&self, name: &str) -> Result<Option<Head>>

The head of name, or None when no such script exists.

fn swap_head( &self, name: &str, expected: Option<&Head>, new: &Head, ) -> Result<()>

Replace the head of name with new, if it is still expected (None: if no head exists yet). Otherwise a typed Conflict: someone got there first.

fn put_version(&self, name: &str, version: &Version) -> Result<()>

Store a version under name. Idempotent: a version is its content.

fn version(&self, name: &str, digest: &str) -> Result<Option<Version>>

The version digest of name, or None. An implementation verifies the content against the digest and refuses a mismatch.

fn names(&self) -> Result<Vec<String>>

Every script name that has a head, sorted.

fn start_run(&self, name: &str, run: &Run) -> Result<u64>

Record a run that is starting, under a fresh id (the id field is ignored), and return the id.

fn finish_run(&self, name: &str, run: &Run) -> Result<()>

Replace the record of a run already started.

fn run(&self, name: &str, id: u64) -> Result<Option<Run>>

Run id of name, or None.

fn last_run(&self, name: &str) -> Result<Option<Run>>

The run of name with the highest id, or None.