Struct typst_as_lib::TypstTemplate

pub struct TypstTemplate { /* private fields */ }

Implementations

impl TypstTemplate

pub fn new<V, S>(fonts: V, source: S) -> Self

where V: Into<Vec<Font>>, S: Into<SourceNewType>,

Initialize with fonts and a given source.

• source can be of types:
  • &str/String, creating a detached Source (Has vpath /main.typ)
  • (&str, &str/String), where &str is the absolute virtual path of the Source file.
  • (typst::syntax::FileId, &str/String)
  • typst::syntax::Source

(&str/String is always the template file content)

Example:

static TEMPLATE: &str = include_str!("./templates/template.typ");
static FONT: &[u8] = include_bytes!("./fonts/texgyrecursor-regular.otf");
// ...
let font = Font::new(Bytes::from(FONT), 0).expect("Could not parse font!");
let template = TypstTemplate::new(vec![font], TEMPLATE);

pub fn new_from_string<S>(fonts: Vec<Font>, source: S) -> Self

where S: Into<String>,

👎Deprecated: Use TypstTemplate::new instead

Initialize with fonts and string that will be converted to a source. It will have the virtual path: /template.typ.

pub fn add_other_sources<I, S>(self, other_sources: I) -> Self

where I: IntoIterator<Item = S>, S: Into<SourceNewType>,

Add sources for template

• other_sources The item of the IntoIterator can be of types:
  • &str/String, creating a detached Source (Has vpath /main.typ)
  • (&str, &str/String), where &str is the absolute virtual path of the Source file.
  • (typst::syntax::FileId, &str/String)
  • typst::syntax::Source

(&str/String is always the template file content)

Example:

static OTHER_SOURCE: &str = include_str!("./templates/other_source.typ");
// ...
let source = ("/other_source.typ", OTHER_SOURCE);
template = template.add_other_sources([source]);

pub fn add_other_sources_from_strings<I, S>(self, other_sources: I) -> Self

where I: IntoIterator<Item = (FileId, S)>, S: Into<String>,

👎Deprecated: Use TypstTemplate::add_other_sources instead

Add sources for template Example:

static OTHER_SOURCE: &str = include_str!("./templates/other_source.typ");
// ...
let file_id = FileId::new(None, VirtualPath::new("/other_source.typ"))
let tuple = (file_id, OTHER_SOURCE);
template = template.add_other_sources_from_strings([tuple]);

pub fn add_binary_files<I, F, B>(self, files: I) -> Self

where I: IntoIterator<Item = (F, B)>, F: Into<FileIdNewType>, B: Into<Bytes>,

Add binary files for template Example:

static IMAGE: &[u8] = include_bytes!("./images/image.png");
// ...
let tuple = ("/images/image.png", IMAGE);
template = template.add_binary_files([tuple]);

pub fn set_source<S>(self, source: S) -> Self

where S: Into<SourceNewType>,

👎Deprecated: Use TypstTemplate::source instead

Replace main source

pub fn source<S>(self, source: S) -> Self

where S: Into<SourceNewType>,

Replace main source

pub fn custom_inject_location<S>(self, module_name: S, value_name: S) -> Self

where S: Into<String>,

Use other typst location for injected inputs (instead of#import sys: inputs, where sys is the module_name and inputs is the value_name). Also preinitializes the library for better performance, if the template will be reused. TypstTemplate::compile will panic in debug build, if the location is already used.

pub fn add_fonts<I, F>(self, fonts: I) -> Self

where I: IntoIterator<Item = F>, F: Into<Font>,

Add Fonts

pub fn compile_with_input<D>( &self, tracer: &mut Tracer, inputs: D, ) -> SourceResult<Document>

where D: Into<Dict>,

Call typst::compile() with our template and a Dict as input, that will be availible in a typst script with #import sys: inputs.

pub fn compile(&self, tracer: &mut Tracer) -> SourceResult<Document>

Just call typst::compile()

Trait Implementations

impl Clone for TypstTemplate

fn clone(&self) -> TypstTemplate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TypstTemplate

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

Formats the value using the given formatter.