Struct QuillSource 

pub struct QuillSource { /* private fields */ }

A quill source bundle — pure data parsed from an authored quill directory.

A QuillSource is the file-bundle, config, and metadata; it has no rendering ability. The engine composes a QuillSource with a resolved backend into a renderable Quill (see quillmark::Quill).

Implementations

impl QuillSource

pub fn from_tree(root: FileTreeNode) -> Result<Self, Vec<Diagnostic>>

Create a QuillSource from a tree structure.

This is the authoritative method for creating a QuillSource from an in-memory file tree. Filesystem walking belongs upstream (see quillmark::Quillmark::quill_from_path).

Arguments

• root - The root node of the file tree

Errors

Returns a non-empty Vec<Diagnostic> describing every problem found. When Quill.yaml itself contains multiple errors they are all reported together; subsequent failures (missing plate, malformed example) surface as single-element vectors.

impl QuillSource

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

Get file contents by path (relative to quill root)

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

Check if a file exists in memory

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

Check if a directory exists in memory

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

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

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

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

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

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

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

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

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

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

impl QuillSource

pub fn name(&self) -> &str

The quill’s declared name.

pub fn backend_id(&self) -> &str

The backend identifier declared in Quill.yaml (e.g. "typst").

pub fn metadata(&self) -> &HashMap<String, QuillValue>

Quill-specific metadata parsed from Quill.yaml.

pub fn plate(&self) -> Option<&str>

The plate template content, if the quill declares one.

pub fn example(&self) -> Option<&str>

The example Markdown content, if the quill ships one.

pub fn config(&self) -> &QuillConfig

The parsed schema configuration.

pub fn files(&self) -> &FileTreeNode

The in-memory file tree for this quill.

Trait Implementations

impl Clone for QuillSource

fn clone(&self) -> QuillSource

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for QuillSource

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

Formats the value using the given formatter.