Struct Contract 

pub struct Contract {
    pub frontmatter: Option<FrontmatterSpec>,
    pub body: Option<SectionSeq>,
    pub rules: Vec<Box<dyn DocRule>>,
    pub description: Option<String>,
}

A compiled contract for one markdown class: frontmatter schema, body grammar, and doc-scoped rules.

Fields

frontmatter: Option<FrontmatterSpec>

validated by the frontmatter plane (frontmatter/* findings)

body: Option<SectionSeq>

the heading grammar of the document body

rules: Vec<Box<dyn DocRule>>

cross-plane rules over the whole projected tree

description: Option<String>

the contract root’s description:, the Finding.hint of a finding with no nearer description in scope

Implementations

impl Contract

pub fn new() -> Self

An empty contract: no frontmatter schema, no body grammar and no rules.

pub fn body(self, body: SectionSeq) -> Self

Set the body grammar.

pub fn doc_rule(self, rule: Box<dyn DocRule>) -> Self

Attach a doc-scoped rule.

pub fn frontmatter(self, spec: FrontmatterSpec) -> Self

Set the frontmatter schema.

Trait Implementations

impl Default for Contract

fn default() -> Self

Returns the “default value” for a type.