Struct KindSpec 

pub struct KindSpec {
    pub format: Format,
    pub front_matter: FrontMatterRule,
    pub without_front_matter: Option<String>,
    pub schema: Option<String>,
    pub identity: Vec<String>,
    pub title: Option<String>,
    pub description: Option<String>,
    pub schema_version: Option<SchemaVersion>,
    pub members: Option<String>,
}

One entry of kinds.yaml.

Fields

format: Format

How the file is read.

front_matter: FrontMatterRule

For markdown, whether front matter must, may, or must not be present.

without_front_matter: Option<String>

For a markdown kind with optional or required front matter: the kind a file that carries none is read as instead (the rules tree’s own README is a document).

schema: Option<String>

The document schema the file must satisfy, by identity (majordomus.rule/v1, which is schemas/majordomus/rule/rule.v1.*); absent means no contract.

identity: Vec<String>

The metadata fields joined with @ that make the identity; empty means the path.

title: Option<String>

The field holding the title, or @heading for the first level-one heading.

description: Option<String>

The field holding the one-line description.

schema_version: Option<SchemaVersion>

A field that must carry one of the supported values.

members: Option<String>

For a yaml kind: the file’s list that holds the objects, one object per item (claims for docs/CLAIMS.yaml). Identity, title and description are then read from each item; schema_version still applies to the file.

Trait Implementations

impl Clone for KindSpec

fn clone(&self) -> KindSpec

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for KindSpec

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for KindSpec

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for KindSpec

impl PartialEq for KindSpec

fn eq(&self, other: &KindSpec) -> 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 KindSpec