Struct Quill 

pub struct Quill {
    pub metadata: HashMap<String, QuillValue>,
    pub name: String,
    pub backend: String,
    pub glue: Option<String>,
    pub example: Option<String>,
    pub schema: QuillValue,
    pub field_schemas: HashMap<String, FieldSchema>,
    pub files: FileTreeNode,
}

A quill template bundle.

Fields

metadata: HashMap<String, QuillValue>

Quill-specific metadata

name: String

Name of the quill

backend: String

Backend identifier (e.g., “typst”)

glue: Option<String>

Glue template content (optional)

example: Option<String>

Markdown template content (optional)

schema: QuillValue

Field JSON schema

field_schemas: HashMap<String, FieldSchema>

Field schemas for default value application

files: FileTreeNode

In-memory file system (tree structure)

Implementations

impl Quill

pub fn from_path<P>(path: P) -> Result<Quill, Box<dyn Error + Sync + Send>>

where P: AsRef<Path>,

Create a Quill from a directory path

pub fn from_tree( root: FileTreeNode, _default_name: Option<String>, ) -> Result<Quill, Box<dyn Error + Sync + Send>>

Create a Quill from a tree structure

This is the authoritative method for creating a Quill from an in-memory file tree.

Arguments

• root - The root node of the file tree
• _default_name - Unused parameter kept for API compatibility (name always from Quill.toml)

Errors

Returns an error if:

• Quill.toml is not found in the file tree
• Quill.toml is not valid UTF-8 or TOML
• The glue file specified in Quill.toml is not found or not valid UTF-8
• Validation fails

pub fn from_json(json_str: &str) -> Result<Quill, Box<dyn Error + Sync + Send>>

Create a Quill from a JSON representation

Parses a JSON string into an in-memory file tree and validates it. The precise JSON contract is documented in designs/QUILL_DESIGN.md. The JSON format MUST have a root object with a files key. The optional metadata key provides additional metadata that overrides defaults.

pub fn typst_packages(&self) -> Vec<String>

Get the list of typst packages to download, if specified in Quill.toml

pub fn get_file<P>(&self, path: P) -> Option<&[u8]>

where P: AsRef<Path>,

Get file contents by path (relative to quill root)

pub fn file_exists<P>(&self, path: P) -> bool

where P: AsRef<Path>,

Check if a file exists in memory

pub fn dir_exists<P>(&self, path: P) -> bool

where P: AsRef<Path>,

Check if a directory exists in memory

pub fn list_files<P>(&self, path: P) -> Vec<String>

where P: AsRef<Path>,

List files in a directory (non-recursive, returns file names only)

pub fn list_subdirectories<P>(&self, path: P) -> Vec<String>

where P: AsRef<Path>,

List subdirectories in a directory (non-recursive, returns directory names only)

pub fn list_directory<P>(&self, dir_path: P) -> Vec<PathBuf>

where P: AsRef<Path>,

List all files in a directory (returns paths relative to quill root)

pub fn list_directories<P>(&self, dir_path: P) -> Vec<PathBuf>

where P: AsRef<Path>,

List all directories in a directory (returns paths relative to quill root)

pub fn find_files<P>(&self, pattern: P) -> Vec<PathBuf>

where P: AsRef<Path>,

Get all files matching a pattern (supports glob-style wildcards)

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

Formats the value using the given formatter.

impl<'a> From<&'a Quill> for QuillRef<'a>

fn from(quill: &'a Quill) -> Self

Converts to this type from the input type.