Struct TemplateSchema 

pub struct TemplateSchema {
    pub name: String,
    pub display_name: String,
    pub description: String,
    pub version: String,
    pub authors: Vec<String>,
    pub category: TemplateCategory,
    pub metadata_schema: Value,
    pub required_files: Vec<String>,
    pub options: Vec<TemplateOption>,
}

A template definition combining visual styling and metadata schema.

Fields

name: String

Template identifier.

display_name: String

Human-readable display name.

description: String

Template description.

version: String

Version string.

authors: Vec<String>

Template author(s).

category: TemplateCategory

Target use case (article, book, report, etc.).

metadata_schema: Value

Metadata schema definition.

required_files: Vec<String>

Required files (main.typ, etc.).

options: Vec<TemplateOption>

Optional configuration options.

Implementations

impl TemplateSchema

pub fn from_directory(path: impl AsRef<Path>) -> Result<Self>

Load a template schema from a directory.

Expects a template.toml or template.json file.

Errors

Returns an error if the template cannot be loaded.

pub fn metadata_validator(&self) -> Result<Schema>

Get a validator for this template’s metadata schema.

Errors

Returns an error if the schema is invalid.

pub fn requires_file(&self, filename: &str) -> bool

Check if a file is required by this template.

Trait Implementations

impl Clone for TemplateSchema

fn clone(&self) -> TemplateSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TemplateSchema

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TemplateSchema

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TemplateSchema

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

where __S: Serializer,

Serialize this value into the given Serde serializer.