Struct Schema 

#[non_exhaustive]
pub struct Schema {
    pub version: SchemaVersion,
    pub options: Options,
    pub frontmatter: FrontmatterPolicy,
    pub outline: Vec<SectionRule>,
    pub constraints: Vec<Constraint>,
    pub outline_provenance: OutlineProvenance,
}

A parsed Outlint schema.

Obtain this value from load_schema or load_schema_with_resources. Although its normalized fields are public for inspection, constructing them directly can bypass loader-established invariants such as valid references and compiled matchers.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

version: SchemaVersion

The schema language version used by this document.

options: Options

Document parsing and matching options, with defaults already applied.

frontmatter: FrontmatterPolicy

The normalized frontmatter presence and value-validation policy.

outline: Vec<SectionRule>

Rules for the document’s h1 headers, in first-match order.

This is the canonical form of the schema’s top level. The title: + sections: sugar desugars into a single synthesized rule here — its matcher is the title matcher (or any-text when no title is declared), its cardinality is exactly one, and its child rules are the top-level sections list. Schema::outline_provenance records which spelling produced the list; public ScopePaths keep addressing what the source spelled, so for sugar schemas the empty scope names the synthesized rule’s child scope rather than this list.

constraints: Vec<Constraint>

Presence and ordering constraints attached to the outline (h1) scope.

Only the general outline: form can declare these. A sugar schema’s top-level constraints attach to the synthesized rule’s child scope (its constraints field) — the scope the sections list describes — so this list is empty for every sugar schema.

outline_provenance: OutlineProvenance

How the source document declared its h1 level.

Trait Implementations

impl Clone for Schema

fn clone(&self) -> Schema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Schema

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

Formats the value using the given formatter.

impl Eq for Schema

impl PartialEq for Schema

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Schema