Struct SimpleWorld 

pub struct SimpleWorld { /* private fields */ }

A minimal implementation of Typst’s World trait for standalone compilation.

This struct provides the bare minimum functionality needed to compile Typst documents. It handles file system access, source loading, package resolution, and maintains references to the Typst standard library.

Limitations

• Uses a fixed date for compilation reproducibility
• Resolves files relative to the main document’s directory

Examples

use typst_count::world::SimpleWorld;
use typst::World;
use std::path::Path;

let world = SimpleWorld::new(Path::new("document.typ"))?;
let main_id = world.main();

Implementations

impl SimpleWorld

pub fn new(main_path: &Path) -> Result<Self>

Creates a new SimpleWorld for compiling a Typst document.

This function initializes the compilation environment by:

1. Canonicalizing the main file path
2. Setting the root directory to the file’s parent directory
3. Creating a virtual path for the main file
4. Initializing the Typst standard library

Arguments

• main_path - Path to the main Typst document to compile

Returns

A new SimpleWorld instance ready for compilation, or an error if the file cannot be found or has no parent directory.

Errors

Returns an error if:

• The file path cannot be canonicalized (file doesn’t exist)
• The file has no parent directory
• The file has no filename component

Examples

use typst_count::world::SimpleWorld;
use std::path::Path;

let world = SimpleWorld::new(Path::new("document.typ"))?;

Trait Implementations

impl World for SimpleWorld

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

Returns a reference to the Typst standard library.

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

Returns a reference to the font book.

fn main(&self) -> FileId

Returns the file ID of the main document.

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

Loads the source code for a given file ID.

This method resolves the file path (either absolute or relative to the root directory) and reads the file contents as a UTF-8 string.

Arguments

• id - The file ID to load

Returns

A Source object containing the file’s content and ID, or a file error if the file cannot be read.

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

Loads binary data for a given file ID.

This method resolves the file path and reads the file contents as raw bytes. Used for loading images, fonts, and other binary assets referenced by the document.

Arguments

• id - The file ID to load

Returns

A Bytes object containing the file’s binary content, or a file error if the file cannot be read.

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

Returns a font at the given index.

Fonts are loaded lazily from the font book as needed by the compiler.

fn today(&self, _offset: Option<i64>) -> Option<Datetime>

Returns the current date for compilation.

This implementation returns a fixed date (2024-01-01) for reproducibility. The date is used by Typst’s datetime.today() function but doesn’t affect word counting results.

Arguments

• _offset - UTC offset in hours (ignored in this implementation)