Struct Pack 

pub struct Pack { /* private fields */ }

A portable pack of a Typst project.

A pack holds project files (sources, images, and data files), optionally package files and fonts. Every project path has contained bytes. Its archive form is a Zip file with a typst-pack.toml manifest, conventionally named *.typk.

Implementations

impl Pack

pub fn builder(entrypoint: impl Into<String>) -> PackBuilder

Starts building a pack from in-memory data.

entrypoint is the root-relative path of the main file, e.g. main.typ.

Building directly does not run Dependency Discovery: the pack contains exactly the files added here and declares no package or font requirements. Use create when the library should discover requirements from values the caller already holds.

use typst_pack::Pack;
use typst_pack::pack_archive::encode;

let pack = Pack::builder("main.typ")
    .file("main.typ", b"= Report\n".to_vec())?
    .file("data/figures.csv", b"quarter,revenue\nQ1,120\n".to_vec())?
    .build()?;

assert_eq!(pack.entrypoint(), "main.typ");

let archive = encode(&pack)?;
assert!(!archive.as_slice().is_empty());

pub fn identity(&self) -> CanonicalIdentity

Derives the Pack’s identity-bearing semantic projection.

pub fn entrypoint(&self) -> &str

The root-relative path of the entrypoint file.

pub fn metadata(&self) -> Option<&PackMetadata>

Optional descriptive metadata, excluded from Pack Identity.

pub fn files(&self) -> impl Iterator<Item = (&str, &[u8])>

The project files, keyed by root-relative path.

pub fn file(&self, path: &str) -> Option<&[u8]>

Looks up a project file by root-relative path.

pub fn packages( &self, ) -> impl Iterator<Item = (&PackageSpec, impl Iterator<Item = (&str, &[u8])>)>

The vendored packages and their files.

pub fn package_file(&self, spec: &PackageSpec, path: &str) -> Option<&[u8]>

Looks up a vendored package file.

pub fn has_package(&self, spec: &PackageSpec) -> bool

Whether the pack vendors the given package.

pub fn package_requirements(&self) -> &[PackageRequirement]

The Pack’s exact Package Requirements in canonical specification order.

pub fn fonts(&self) -> &[PackFont]

The fonts embedded in the pack.

pub fn font_catalog(&self) -> &[PackFontCatalogFace]

The exact Pack Font Catalog faces exposed to official Typst, in stable order.

pub fn font_requirements(&self) -> &[FontRequirement]

The exact Font Containers required by this Pack.

Trait Implementations

impl Clone for Pack

fn clone(&self) -> Pack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Pack

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

Formats the value using the given formatter.