Struct Document 

pub struct Document { /* private fields */ }

A fully self-contained document ready for rendering.

Created by the document! macro with embedded templates, fonts, and packages. All resources are compressed with zstd and decompressed lazily at runtime.

Implementations

impl Document

pub fn with_inputs<T: Into<Dict>>(self, inputs: T) -> Self

Add input data to the document.

Define your data structs using the derive macros:

• Top-level struct: Use both IntoValue and IntoDict
• Nested structs: Use IntoValue only

In .typ files, access the data via sys.inputs:

#import sys: inputs
= #inputs.title

Example

use typst_bake::{IntoValue, IntoDict};

#[derive(IntoValue, IntoDict)]  // Top-level: both macros
struct Inputs {
    title: String,
    products: Vec<Product>,
}

#[derive(IntoValue)]  // Nested: IntoValue only
struct Product {
    name: String,
    price: f64,
}

let inputs = Inputs {
    title: "Catalog".to_string(),
    products: vec![
        Product { name: "Apple".to_string(), price: 1.50 },
    ],
};

let pdf = typst_bake::document!("main.typ")
    .with_inputs(inputs)
    .to_pdf()?;

pub fn add_file( self, path: impl Into<String>, data: impl Into<Vec<u8>>, ) -> Result<Self>

Add or replace a runtime file at the given path.

The file becomes available to Typst templates via #image("path"), #read("path"), etc. Runtime files take priority over embedded files with the same path.

Errors

Returns Error::InvalidFilePath if the path is empty, absolute, or contains .. segments.

Example

let pdf = typst_bake::document!("main.typ")
    .add_file("images/chart.png", chart_bytes)?
    .to_pdf()?;

pub fn has_file(&self, path: impl AsRef<str>) -> bool

Check if a file exists at the given path.

Checks both embedded (compile-time) and runtime files.

pub fn select_pages(&self, pages: impl IntoIterator<Item = usize>) -> Pages<'_>

Select specific pages for output, returning a Pages view.

Pages are 0-indexed. Duplicates are removed and pages are always output in document order regardless of input order.

Errors

Returns Error::InvalidPageSelection at render time if any index is out of range or the selection is empty.

Example

// Select specific pages
let pdf = typst_bake::document!("main.typ")
    .select_pages([0, 2, 4])
    .to_pdf()?;

// Works with ranges too
let svgs = typst_bake::document!("main.typ")
    .select_pages(0..3)
    .to_svg()?;

// Reuse with different selections
let doc = typst_bake::document!("main.typ");
let cover = doc.select_pages([0]).to_pdf()?;
let body = doc.select_pages(1..5).to_pdf()?;

pub fn page_count(&self) -> Result<usize>

Get the total number of pages in the compiled document.

Compiles the document if not already compiled. Returns the total page count regardless of select_pages.

Example

let doc = typst_bake::document!("main.typ").with_inputs(data);
let count = doc.page_count()?;
let thumbnail = doc.select_pages([0]).to_png(72.0)?;

pub fn stats(&self) -> &EmbedStats

Get compression statistics for embedded content.

pub fn to_pdf(&self) -> Result<Vec<u8>>

Available on crate feature pdf only.

Compile the document and generate PDF.

Returns

PDF data as bytes.

Errors

Returns an error if compilation or PDF generation fails.

pub fn to_svg(&self) -> Result<Vec<String>>

Available on crate feature svg only.

Compile the document and generate SVG for each page.

Returns

A vector of SVG strings, one per page.

Errors

Returns an error if compilation fails.

pub fn to_png(&self, dpi: f32) -> Result<Vec<Vec<u8>>>

Available on crate feature png only.

Compile the document and generate PNG for each page.

Arguments

• dpi - Resolution in dots per inch (e.g., 72 for 1:1, 144 for Retina, 300 for print)

Returns

A vector of PNG bytes, one per page.

Errors

Returns an error if compilation or PNG encoding fails.