Struct Packer 

pub struct Packer { /* private fields */ }

Packs a Typst project directory into a Pack.

The packer performs a discovery compile of the project and records every file Typst actually reads: sources, images, data files, and package files. Only those files end up in the pack. Files that a compile with different inputs or a different date would read (e.g. behind conditional imports) are not discovered; add them explicitly with include.

Implementations

impl Packer

pub fn new(root: impl Into<PathBuf>, entrypoint: impl Into<PathBuf>) -> Self

Creates a packer for the project in root with the given entrypoint (absolute, or relative to root).

pub fn vendor_packages(self, vendor: bool) -> Self

Whether to store the files of all observed package dependencies inside the pack. Defaults to true; when disabled, dependencies are recorded as external and must be resolvable when the pack is compiled.

pub fn embed_fonts(self, embed: bool) -> Self

Whether to embed the fonts used by the document. Defaults to false.

Note that font licenses differ; make sure you may redistribute the fonts you embed.

pub fn include_default_fonts(self, include: bool) -> Self

Whether font embedding also stores fonts that are identical to Typst’s embedded default fonts. Defaults to false since compiling a pack has those fonts available anyway.

pub fn include(self, path: impl Into<PathBuf>) -> Self

Adds a file or directory (absolute, or relative to the project root) to the pack in addition to the discovered files. Paths must be inside the project root.

pub fn font_path(self, path: impl Into<PathBuf>) -> Self

Adds a directory to scan for fonts during the discovery compile.

pub fn system_fonts(self, system: bool) -> Self

Whether the discovery compile may use system fonts. Defaults to true.

pub fn inputs(self, inputs: Dict) -> Self

Values made available to document code as sys.inputs during the discovery compile.

pub fn package_path(self, path: impl Into<PathBuf>) -> Self

Overrides the directory in which locally installed packages are searched (namespace/name/version layout).

pub fn package_cache_path(self, path: impl Into<PathBuf>) -> Self

Overrides the directory in which downloaded packages are cached.

pub fn offline(self, offline: bool) -> Self

Disallows network access during the discovery compile. Defaults to false.

When enabled, package dependencies must already exist in the local package directories; anything that would need to be downloaded fails the compile as not found.

pub fn metadata(self, metadata: Metadata) -> Self

Sets descriptive metadata recorded in the pack manifest.

pub fn pack(self) -> Result<PackOutcome, PackerError>

Runs the discovery compile and assembles the pack.