Struct QuillConfig 

pub struct QuillConfig {
    pub name: String,
    pub description: String,
    pub main: LeafSchema,
    pub leaf_kinds: Vec<LeafSchema>,
    pub backend: String,
    pub version: String,
    pub author: String,
    pub example_file: Option<String>,
    pub example_markdown: Option<String>,
    pub plate_file: Option<String>,
    pub backend_config: HashMap<String, QuillValue>,
}

Top-level configuration for a Quillmark project

Fields

name: String

Quill package name

description: String

Human-readable description of the quill itself (parsed from quill.description). Distinct from main.description, which describes the main leaf’s schema.

main: LeafSchema

The entry-point leaf schema (parsed from the Quill.yaml main: section).

leaf_kinds: Vec<LeafSchema>

Named, composable leaf-type schemas (parsed from the Quill.yaml leaf_kinds: section). Does not include main.

backend: String

Backend to use for rendering (e.g., “typst”, “html”)

version: String

Version of the Quillmark spec

author: String

Author of the project

example_file: Option<String>

Example data file for preview

example_markdown: Option<String>

Loaded markdown example content from Quill.example/Quill.example_file

plate_file: Option<String>

Plate file (template)

backend_config: HashMap<String, QuillValue>

Backend-specific configuration parsed from the top-level YAML section whose key matches backend (e.g. [typst], [html]).

Implementations

impl QuillConfig

pub fn blueprint(&self) -> String

Generate an annotated Markdown blueprint for this quill. See module docs for the annotation grammar; the function is total over any valid QuillConfig.

impl QuillConfig

pub fn leaf_kind(&self, name: &str) -> Option<&LeafSchema>

Returns a named leaf-type schema by name.

pub fn schema(&self) -> Value

Full schema including ui hints.

main.fields is prefixed with a required QUILL entry (const = name@version); each leaf_kinds[<name>].fields is prefixed with a required KIND entry (const = <name>). Identity (name, version, etc.) and the bundled example live elsewhere on the host’s metadata surface.

pub fn coerce_frontmatter( &self, frontmatter: &IndexMap<String, QuillValue>, ) -> Result<IndexMap<String, QuillValue>, CoercionError>

Coerce typed frontmatter fields (IndexMap, no LEAVES/BODY keys).

pub fn coerce_leaf( &self, leaf_tag: &str, fields: &IndexMap<String, QuillValue>, ) -> Result<IndexMap<String, QuillValue>, CoercionError>

Coerce typed fields for a single leaf (IndexMap, no KIND/BODY keys).

Returns the input unchanged when the leaf tag is unknown.

pub fn validate_document( &self, doc: &Document, ) -> Result<(), Vec<ValidationError>>

Validate a typed crate::document::Document against this configuration.

pub fn from_yaml( yaml_content: &str, ) -> Result<Self, Box<dyn StdError + Send + Sync>>

Parse QuillConfig from YAML content

pub fn from_yaml_with_warnings( yaml_content: &str, ) -> Result<(Self, Vec<Diagnostic>), Vec<Diagnostic>>

Parse QuillConfig from YAML content while collecting non-fatal warnings.

Returns Ok((config, warnings)) on success, or Err(errors) containing all parse/validation errors when the config is invalid. Errors are always collected exhaustively — callers see every problem, not just the first.

impl QuillConfig

pub fn schema_yaml(&self) -> Result<String, Error>

YAML encoding of QuillConfig::schema.

Trait Implementations

impl Clone for QuillConfig

fn clone(&self) -> QuillConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuillConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for QuillConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for QuillConfig

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QuillConfig