Struct Quill 

pub struct Quill {
    pub glue_template: String,
    pub metadata: HashMap<String, Value>,
    pub base_path: PathBuf,
    pub name: String,
    pub glue_file: String,
    pub files: HashMap<PathBuf, FileEntry>,
}

A quill template bundle. See module docs for examples.

Fields

glue_template: String

The template content

metadata: HashMap<String, Value>

Quill-specific metadata

base_path: PathBuf

Base path for resolving relative paths

name: String

Name of the quill

glue_file: String

Glue template file name

files: HashMap<PathBuf, FileEntry>

In-memory file system

Implementations

impl Quill

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

where P: AsRef<Path>,

Create a Quill from a directory path

pub fn toml_to_yaml_value( toml_val: &Value, ) -> Result<Value, Box<dyn Error + Send + Sync>>

Convert TOML value to YAML value

pub fn assets_path(&self) -> PathBuf

Get the path to the assets directory

pub fn packages_path(&self) -> PathBuf

Get the path to the packages directory

pub fn glue_path(&self) -> PathBuf

Get the path to the glue file

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

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

pub fn validate(&self) -> Result<(), Box<dyn Error + Send + Sync>>

Validate the quill structure

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 get_file_entry<P>(&self, path: P) -> Option<&FileEntry>

where P: AsRef<Path>,

Get file entry by path (includes metadata)

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

where P: AsRef<Path>,

Check if a file exists in memory

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_subdirectories<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 simple 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.