Struct Pack 

pub struct Pack { /* private fields */ }

A portable pack of a Typst project.

A pack holds everything needed to compile one Typst project: the project files (sources, images, data files), optionally the files of the packages the project imports, and optionally the fonts it uses. 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.

pub fn manifest(&self) -> &Manifest

The pack manifest.

pub fn entrypoint(&self) -> &str

The root-relative path of the entrypoint file.

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

The project files, keyed by root-relative path.

pub fn file(&self, path: &str) -> Option<&Bytes>

Looks up a project file by root-relative path.

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

The vendored packages and their files.

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

Looks up a vendored package file.

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

Whether the pack vendors the given package.

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

The fonts embedded in the pack.

pub fn read<R: Read + Seek>(reader: R) -> Result<Self, PackReadError>

Reads a pack from a seekable reader.

pub fn from_bytes(bytes: impl Into<Vec<u8>>) -> Result<Self, PackReadError>

Reads a pack from a byte buffer.

pub fn write<W: Write + Seek>(&self, writer: W) -> Result<(), PackWriteError>

Writes the pack archive to a seekable writer.

pub fn to_bytes(&self) -> Result<Vec<u8>, PackWriteError>

Serializes the pack archive to a byte buffer.

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.