Struct Schema 

pub struct Schema {
    pub opts: SchemaOpts,
    pub frontmatter: Vec<FieldSchema>,
    pub body: Vec<Node>,
}

A parsed schema: per-schema options, the frontmatter field schemas, and the body node tree.

Fields

opts: SchemaOpts

frontmatter: Vec<FieldSchema>

body: Vec<Node>

Implementations

impl Schema

pub fn edit( &self, md: &str, target: &str, new_value: &str, ) -> Result<String, EditError>

Replace the content of the node at target (a .-separated alias path, e.g. "plan.cases.2") with new_value and return the modified markdown.

target mirrors the key path of Schema::extract’s output; a trailing numeric segment (.2) picks the N-th element of a list. Only leaf string nodes (list items and prose paragraphs) are editable; for list items the bullet/marker and any checkbox prefix are preserved.

Returns EditError::TargetNotFound if the path does not resolve, or EditError::IndexOutOfRange if a numeric index exceeds the list.

impl Schema

pub fn scaffold(&self) -> String

Emit a conforming starter document: required frontmatter keys with typed placeholders, headings, and one placeholder item per required list. Optional nodes (?/*/min-0) are omitted.

pub fn render(&self, data: &Value) -> Result<String, RenderError>

Render a conforming markdown document from data — the inverse of Schema::extract. data is a JSON object keyed by the capture aliases declared in the schema.

Returns RenderError::MissingField if a required field is absent from data, or RenderError::WrongType if a value has an incompatible JSON type.

impl Schema

pub fn validate(&self, markdown: &str) -> Vec<Problem>

Validate a markdown document’s body against the schema. An empty result means it conforms. (Frontmatter typing: future phase.)

pub fn extract(&self, markdown: &str) -> Result<Value, Vec<Problem>>

Parse a conforming document into the typed data object, keyed by the schema’s capture aliases. Returns the validation problems if it does not conform. (Frontmatter capture: future phase — body only for now.)

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 PartialEq for Schema

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