Struct CompileOptions 

pub struct CompileOptions {
    pub files: HashMap<String, Vec<u8>>,
    pub packages: HashMap<PackageSpec, HashMap<String, Vec<u8>>>,
}

Options for configuring Typst compilation.

Use this to provide additional files (images, bibliographies, data files) and pre-loaded packages to the Typst compiler.

Example

use dioxus_typst::CompileOptions;

let options = CompileOptions::new()
    .with_file("data.csv", csv_bytes)
    .with_file("logo.png", image_bytes);

Fields

files: HashMap<String, Vec<u8>>

Files available to the Typst document, keyed by their virtual path.

packages: HashMap<PackageSpec, HashMap<String, Vec<u8>>>

Pre-loaded packages, keyed by their package specification.

Implementations

impl CompileOptions

pub fn new() -> Self

Creates a new empty CompileOptions.

pub fn with_file(self, path: impl Into<String>, content: Vec<u8>) -> Self

Adds a file to the compilation environment.

Example

use dioxus_typst::CompileOptions;

let options = CompileOptions::new()
    .with_file("figure.png", png_bytes)
    .with_file("data.csv", csv_bytes);

pub fn with_package( self, spec: PackageSpec, files: HashMap<String, Vec<u8>>, ) -> Self

Adds a pre-loaded package to the compilation environment.

Example

use typst::syntax::package::PackageSpec;
use std::str::FromStr;
use dioxus_typst::CompileOptions;

let options = CompileOptions::new()
    .with_package(
        PackageSpec::from_str("@preview/cetz:0.2.2").unwrap(),
        package_files,
    );

Trait Implementations

impl Clone for CompileOptions

fn clone(&self) -> CompileOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompileOptions

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

Formats the value using the given formatter.

impl Default for CompileOptions

fn default() -> CompileOptions

Returns the “default value” for a type.

impl PartialEq for CompileOptions

fn eq(&self, other: &CompileOptions) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CompileOptions