Struct CoreSchema 

pub struct CoreSchema {
    pub line_limit: i64,
    pub lifecycle: Vec<LifecycleDimension>,
    pub frontmatter: Vec<(String, FrontmatterConstraint)>,
    pub frontmatter_open: bool,
    pub prohibited_patterns: Vec<Prohibition>,
    pub formats: FormatRegistry,
    pub guidance: Option<String>,
    pub examples: Vec<Example>,
    pub line: usize,
    pub key_lines: BTreeMap<String, usize>,
}

The part of a lowered schema that every format shares: grammar schema, the keys of the core grammar.

Fields

line_limit: i64

line-limit; zero or less declares no limit.

lifecycle: Vec<LifecycleDimension>

lifecycle.

frontmatter: Vec<(String, FrontmatterConstraint)>

frontmatter, in schema order.

frontmatter_open: bool

frontmatter-open.

prohibited_patterns: Vec<Prohibition>

prohibited-patterns: what no line of the body may match.

formats: FormatRegistry

The registry as this schema sees it.

guidance: Option<String>

guidance: what the schema says that no example can.

examples: Vec<Example>

examples.

line: usize

The line of the schema where it is written.

key_lines: BTreeMap<String, usize>

The line of each key of the schema, by the key.

Implementations

impl CoreSchema

pub fn demand_nothing() -> CoreSchema

A schema that demands nothing.

pub fn states(&self, frontmatter: Option<&Spanned>) -> States

A document’s lifecycle states, one per dimension its frontmatter carries.

pub fn type_const(&self) -> Option<&str>

The type const, where the type key declares one.

pub fn constraint(&self, key: &str) -> Option<&FrontmatterConstraint>

The constraint the schema declares on the frontmatter key.

pub fn id_template(&self) -> Option<&IdTemplate>

The id template, if frontmatter.id.template is declared.

pub fn dimension(&self, key: &str) -> Option<&LifecycleDimension>

The lifecycle dimension with key.

Trait Implementations

impl Clone for CoreSchema

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CoreSchema

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

Formats the value using the given formatter.