Struct EmbeddedWorld 

pub struct EmbeddedWorld { /* private fields */ }

A Typst world for one compilation: the main source, in-memory files and, on native targets, files looked up in a list of root directories and in Typst packages.

Files are cached for the lifetime of the world, so create a new world for every compilation and share the Fonts between them.

Implementations

impl EmbeddedWorld

pub fn new( main: VirtualPath, source: impl Into<String>, fonts: Arc<Fonts>, ) -> Self

A world whose main file is main with the text source, without roots, inputs or packages.

pub fn with_roots(self, roots: Vec<PathBuf>) -> Self

Look up project files that are not in memory in these directories, in order. The first root that contains the file wins.

pub fn with_inputs(self, inputs: Dict) -> Self

Make inputs available as sys.inputs.

pub fn with_creation_timestamp(self, seconds: i64) -> Self

Answer datetime.today() from this Unix timestamp (in UTC) instead of the system clock, for reproducible output. Without it, Wasm has no date at all.

pub fn add_file( &self, path: VirtualPath, contents: impl AsRef<[u8]> + Send + Sync + 'static, )

Serve contents as the project file path, in front of the roots.

pub fn fonts(&self) -> &Fonts

The fonts of this world.

pub fn path_for(&self, id: FileId) -> FileResult<PathBuf>

The file on disk for id: a project file is looked up in every root, a package file in its package directory.

pub fn display_path(&self, id: FileId) -> String

The path to show in diagnostics: the real file, relative to the working directory where possible, otherwise the virtual path.

pub fn dependencies(&self) -> Vec<Dependency>

Every file Typst read from disk so far, except the main file and in-memory files.

Trait Implementations

impl World for EmbeddedWorld

fn library(&self) -> &LazyHash<Library>

The standard library.

fn book(&self) -> &LazyHash<FontBook>

Metadata about all known fonts.

fn main(&self) -> FileId

Get the file id of the main source file.

fn source(&self, id: FileId) -> FileResult<Source>

Try to access the specified file location as a source file.

fn file(&self, id: FileId) -> FileResult<Bytes>

Try to access the specified file.

fn font(&self, index: usize) -> Option<Font>

Try to access the font with the given index in the font book.

fn today(&self, offset: Option<Duration>) -> Option<Datetime>

Get the current date.