Struct Quill 

pub struct Quill { /* private fields */ }

Renderable quill. Composes an Arc<QuillSource> with a resolved Backend. Constructed by the engine; immutable once created.

Implementations

impl Quill

pub fn source(&self) -> &QuillSource

The underlying quill source.

pub fn backend_id(&self) -> &str

The resolved backend identifier (e.g. "typst").

pub fn supported_formats(&self) -> &'static [OutputFormat]

Supported output formats for this quill’s backend.

pub fn name(&self) -> &str

The quill’s declared name.

pub fn render( &self, doc: &Document, opts: &RenderOptions, ) -> Result<RenderResult, RenderError>

Render a document to final artifacts.

Pass &RenderOptions::default() for backend defaults (first supported format, backend-chosen ppi, all pages).

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

Open an iterative render session for this document.

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

Compile a Document to JSON data suitable for the backend.

Applies coercion, validation, normalization, and schema defaults, then calls Document::to_plate_json to produce the wire format.

pub fn form(&self, doc: &Document) -> Form

The schema-aware form view of doc — the whole-document snapshot rendered through this quill’s schema.

For each schema-declared field on the main card and on every recognised card, the returned Form records the current value, the schema default, and a form::FormFieldSource label.

Snapshot semantics. The result is a read-only snapshot — re-call after editing doc.

Unknown card tags are dropped from Form::cards and surface as form::unknown_card_tag diagnostics. Validation errors are appended as form::validation_error diagnostics; the view itself is never altered or filtered by validation failures.

pub fn blank_main(&self) -> FormCard

A blank form for the main card — no document values supplied. Every declared field’s source is form::FormFieldSource::Default (when the schema declares a default) or form::FormFieldSource::Missing.

Useful as a starting state for a fresh document, or for previewing the main-card form without a document in hand.

pub fn blank_card(&self, card_type: &str) -> Option<FormCard>

A blank form for a card of the given type — no document values supplied. Returns None if card_type is not declared in the quill’s schema.

This is the “user is about to add a new card” view: the UI can render the form before the card is committed to the document.

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

Perform a dry-run validation without backend compilation.

Trait Implementations

impl Clone for Quill

fn clone(&self) -> Quill

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Quill

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

Formats the value using the given formatter.