Struct QuillConfig 

#[non_exhaustive]
pub struct QuillConfig {
    pub name: String,
    pub description: String,
    pub main: CardSchema,
    pub card_kinds: Vec<CardSchema>,
    pub backend: String,
    pub version: String,
    pub author: String,
    pub backend_config: HashMap<String, QuillValue>,
}

Top-level configuration for a Quillmark project

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.

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 card’s schema.

main: CardSchema

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

card_kinds: Vec<CardSchema>

Named, composable card-kind schemas (parsed from the Quill.yaml card_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

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 the canonical annotated Markdown blueprint for this quill: the authoring surface handed to LLMs and humans, with Unendorsed cells carrying the !must_fill marker. See module docs for the annotation grammar; the function is total over any valid QuillConfig.

The “filled-out” twin of the blueprint is seeding (Quill::seed_document), a committed Document rather than an annotated string. See prose/canon/BLUEPRINT.md.

The result is guaranteed schema-valid and parseable (every key present, every value type-correct). It is not guaranteed to render: that is the quill authoring contract on plate.typ; see prose/canon/BLUEPRINT.md §Guarantees.

impl QuillConfig

The document→data compile is a pure config read: coercion, validation, normalization, and zero-fill consult only the parsed schemas, never the quill’s file tree. Living on QuillConfig lets a consumer that only compiles data (e.g. a live session’s apply) retain the config alone rather than the whole quill with its font/package bytes.

pub fn compile_data(&self, doc: &Document) -> Result<Value, RenderError>

Applies coercion, validation, normalization, and zero-filled render: every absent schema field is resolved to its authored value, else its schema default, else its type-empty zero value, in this plate-JSON projection only, never in the persisted document. A merely incomplete document compiles fine; only a malformed one (a value that won’t coerce/validate) errors. A !must_fill placeholder never gates render: it surfaces as a non-fatal warning from validate. See prose/canon/SCHEMAS.md.

pub fn compile_checked(&self, doc: &Document) -> Result<Value, RenderError>

compile_data behind the $quill pairing check: the render door’s whole preamble, in the one place that owns it. Every door that turns a document into plate data for this schema goes through here (Quillmark::open for a session’s first compile, LiveSession::update for each edit), so the pairing cannot be checked at one and skipped at the other.

compile_data stays available unchecked for a caller that wants the plate alone (the CLI’s --output-data), where no render follows and the pairing is the caller’s to assert.

pub fn dry_run(&self, doc: &Document) -> Result<(), RenderError>

Validate without backend compilation.

impl QuillConfig

pub fn new( name: String, backend: String, version: String, main: CardSchema, ) -> QuillConfig

The four fields Quill.yaml requires. description, author, card_kinds, and backend_config start empty.

This bypasses Self::from_yaml_with_warnings and its validation, so a config built here can hold shapes the parser refuses. Loading a quill goes through that path; this one is for a caller assembling a schema in memory.

impl QuillConfig

pub fn card_kind(&self, name: &str) -> Option<&CardSchema>

Returns a named card-kind schema by name.

pub fn schema(&self) -> Value

Full schema including ui hints.

Describes the user-fillable fields of the main card and each named card kind. The quill reference (constructed as name@version from quill metadata) and card-kind discriminators are document-level metadata, not fields, so they do not appear here.

Key order is the ordering contract: fields, nested properties, and card kinds all emit in declaration order (preserve_order end-to-end), so a consumer walking the maps in key order renders the authored layout.

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

Coerce typed payload fields (IndexMap of user fields only).

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

Coerce typed fields for a single card (IndexMap of user fields only).

Returns the input unchanged when the card kind 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_with_warnings( yaml_content: &str, ) -> Result<(QuillConfig, 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, YamlError>

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<(), Error>

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<QuillConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for QuillConfig

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for QuillConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for QuillConfig