Struct Share 

pub struct Share {
    pub origin: &'static str,
    /* private fields */
}

A located distribution directory.

Fields

origin: &'static str

How it was found, for diagnostics: --share, the environment, the repository, or the executable’s own installation.

Implementations

impl Share

pub fn locate(explicit: Option<&Path>, repo_root: &Path) -> Result<Self, Error>

Locate the share directory. In order: explicit (from --share), MAJORDOMUS_SHARE, <repository root>/share when it holds a kinds file (this repository supervising itself), and <directory of the executable>/../share (an installation laid out as bin/ beside share/). A candidate that exists but holds no kinds file is skipped only when it came from a convention; an explicit path that lacks one is an error.

pub fn dir(&self) -> &Path

The directory, canonical.

pub fn skeleton_scope(&self) -> PathBuf

The distribution’s default scope declaration, the file majordomus init seeds.

pub fn kinds_path(&self) -> PathBuf

<share>/kinds.yaml.

pub fn schemas_dir(&self) -> PathBuf

<share>/schemas.

pub fn allow_dir(&self) -> PathBuf

<share>/allow.

pub fn sections_dir(&self) -> PathBuf

<share>/sections.

pub fn generated_schemas_dir(&self) -> PathBuf

<share>/schemas/generated: the contracts of the generated documents, matched to a document by the const of its schema member.

pub fn providers_dir(&self) -> PathBuf

<share>/providers: the provider templates the tool ships, <provider>.tmpl each.

pub fn provider_templates(&self) -> Vec<String>

The providers the tool has a template for, by id (the file stem), sorted. A distribution without the directory has none; that is not an error, it is a distribution that ships no adapter.

pub fn providers_path(&self) -> PathBuf

<share>/providers.yaml.

pub fn providers(&self) -> Result<ProviderDeclarations, Error>

The provider declarations the distribution ships, joined with its templates: one ProviderDeclaration per id that has either, sorted by id. A distribution without the file declares nothing and every template is a provider named by its file; a file that does not parse is an error naming it, because a declaration half-read is worse than none.

Trait Implementations

impl Clone for Share

fn clone(&self) -> Share

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Share

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

Formats the value using the given formatter.

impl Eq for Share

impl PartialEq for Share

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Share