Struct TypstTemplateEngineBuilder

pub struct TypstTemplateEngineBuilder<T = TypstTemplateCollection> { /* private fields */ }

Implementations

impl TypstTemplateEngineBuilder<TypstTemplateCollection>

pub fn main_file<S: IntoSource>( self, source: S, ) -> TypstTemplateEngineBuilder<TypstTemplateMainFile>

Declare a main_file that is used for each compilation as a starting point. This is optional.

impl<T> TypstTemplateEngineBuilder<T>

pub fn custom_inject_location( self, module_name: &'static str, value_name: &'static str, ) -> Self

Use other typst location for injected inputs (instead of#import sys: inputs, where sys is the module_name and inputs is the value_name).

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

where I: IntoIterator<Item = F>, F: IntoFonts,

Fonts Accepts IntoIterator Items:

• &u8
• Vec
• Bytes
• Font

pub fn add_file_resolver<F>(self, file_resolver: F) -> Self

where F: FileResolver + Send + Sync + 'static,

Add file resolver, that implements the FileResolver`` trait to a vec of file resolvers. When a FileId`` needs to be resolved by Typst, the vec will be iterated over until one file resolver returns a file.

pub fn with_static_source_file_resolver<IS, S>(self, sources: IS) -> Self

where IS: IntoIterator<Item = S>, S: IntoSource,

Adds the StaticSourceFileResolver to the file resolvers. It creates HashMaps for sources.

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)

pub fn with_static_file_resolver<IB, F, B>(self, binaries: IB) -> Self

where IB: IntoIterator<Item = (F, B)>, F: IntoFileId, B: IntoBytes,

Adds the StaticFileResolver to the file resolvers. It creates HashMaps for binaries.

pub fn with_file_system_resolver<P>(self, root: P) -> Self

where P: Into<PathBuf>,

Adds FileSystemResolver to the file resolvers, a resolver that can resolve local files (when package is not set in FileId).

pub fn comemo_evict_max_age( &mut self, comemo_evict_max_age: Option<usize>, ) -> &mut Self

pub fn build(self) -> TypstEngine<T>

Trait Implementations

impl Default for TypstTemplateEngineBuilder

fn default() -> Self

Returns the “default value” for a type.