Struct Template

pub struct Template {
    pub id: TemplateId,
    pub name: String,
    pub content: String,
    pub schema: Schema,
    pub description: Option<String>,
    pub created_at: OffsetDateTime,
    pub updated_at: OffsetDateTime,
}

A template for PDF generation

Fields

id: TemplateId

Unique identifier

name: String

Human-readable name

content: String

Typst markdown content

schema: Schema

Associated schema

description: Option<String>

Optional description

created_at: OffsetDateTime

Creation timestamp

updated_at: OffsetDateTime

Last update timestamp

Implementations

impl Template

pub fn new( id: impl Into<TemplateId>, name: impl Into<String>, content: impl Into<String>, schema: Schema, ) -> Self

Create a new template

pub fn builder(id: impl Into<TemplateId>) -> TemplateBuilder

Create a new template builder

pub fn with_description(self, description: impl Into<String>) -> Self

Set the description

pub fn validate_data(&self, data: &Value) -> Result<()>

Validate data against the template’s schema

pub fn render(&self, data: &Value) -> Result<RenderResult>

Render the template with data to a PDF

pub fn render_with_options( &self, data: &Value, options: RenderOptions, ) -> Result<RenderResult>

Render the template with data and options to a PDF

pub fn render_with_cache( &self, data: &Value, world_cache: Option<&mut TypstWorld>, ) -> Result<RenderResult>

Render the template with data using a cached world

pub fn render_with_cache_and_options( &self, data: &Value, world_cache: Option<&mut TypstWorld>, options: RenderOptions, ) -> Result<RenderResult>

Render the template with data, options, and cached world

pub fn from_file_content( id: impl Into<TemplateId>, content: &str, ) -> Result<Self>

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

Parse a template from a file

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Template

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Template

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Template

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TemplateCache for Template

fn with_cache(self) -> CachedTemplate

Convert this template into a cached template for better performance