Struct Project 

pub struct Project {
    pub root: PathBuf,
    pub base: PathBuf,
    pub pcfg: ProjectConfig,
}

Fields

root: PathBuf

base: PathBuf

pcfg: ProjectConfig

The universal engine config (<root>/opys.toml), the sole source of truth for document types, statuses, fields, sections, and rules.

Implementations

impl Project

pub fn open(root: &str) -> Result<Project>

Open the project by searching upward from root (default the cwd) for opys.toml. The directory holding it is the project root; the inventory base is <root>/<config.base> (default opys).

pub fn doc_path(&self, id: &str, status: &str) -> PathBuf

The canonical on-disk path for a document with the given id and status, per the configured layout (see ProjectConfig::doc_relpath).

pub fn max_doc_id(&self, docs: &[Doc]) -> u64

Highest numeric id part across a document set, their relation maps, and the retired ledger — the basis for the single global, monotonically increasing id sequence shared by every type.

pub fn next_id_for(&self, prefix: &str, docs: &[Doc]) -> String

Next id for a type prefix: one past the global max, padded to pcfg.pad.

pub fn retired_ids(&self) -> HashSet<String>

IDs that have been retired and may never be reused.

pub fn find<'a>(&self, docs: &'a [Doc], id: &str) -> Result<&'a Doc>

Find a document by ID, or a not-found error.