Struct CompilerWorld 

pub struct CompilerWorld<F: CompilerFeat> {
    pub library: Arc<LazyHash<Library>>,
    pub font_resolver: Arc<F::FontResolver>,
    pub registry: Arc<F::Registry>,
    pub source_db: SourceDb,
    /* private fields */
}

Fields

library: Arc<LazyHash<Library>>

Provides library for typst compiler.

font_resolver: Arc<F::FontResolver>

Provides font management for typst compiler.

registry: Arc<F::Registry>

Provides package management for typst compiler.

source_db: SourceDb

Provides source database for typst compiler.

Implementations

impl<F: CompilerFeat> CompilerWorld<F>

pub fn task(&self, mutant: TaskInputs) -> CompilerWorld<F>

pub fn inputs(&self) -> Arc<LazyHash<Dict>>

pub fn path_for_id(&self, id: FileId) -> Result<PathBuf, FileError>

Resolve the real path for a file id.

pub fn revision(&self) -> NonZeroUsize

Trait Implementations

impl<F: CompilerFeat> Clone for CompilerWorld<F>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<F: CompilerFeat> Drop for CompilerWorld<F>

fn drop(&mut self)

Executes the destructor for this type.

impl<F: CompilerFeat> EntryReader for CompilerWorld<F>

fn entry_state(&self) -> EntryState

fn workspace_root(&self) -> Option<Arc<Path>>

fn main_id(&self) -> Option<FileId>

impl<'a, F: CompilerFeat> Files<'a> for CompilerWorld<F>

type FileId = FileId

A unique identifier for files in the file provider. This will be used for rendering diagnostic::Labels in the corresponding source files.

type Name = String

The user-facing name of a file, to be displayed in diagnostics.

type Source = Source

The source code of a file.

fn name(&'a self, id: FileId) -> Result<Self::Name, Error>

The user-facing name of a file.

fn source(&'a self, id: FileId) -> Result<Self::Source, Error>

The source code of a file.

fn line_index(&'a self, id: FileId, given: usize) -> Result<usize, Error>

See codespan_reporting::files::Files::line_index.

fn column_number( &'a self, id: FileId, _: usize, given: usize, ) -> Result<usize, Error>

See codespan_reporting::files::Files::column_number.

fn line_range(&'a self, id: FileId, given: usize) -> Result<Range<usize>, Error>

See codespan_reporting::files::Files::line_range.

fn line_number( &'a self, id: Self::FileId, line_index: usize, ) -> Result<usize, Error>

The user-facing line number at the given line index. It is not necessarily checked that the specified line index is actually in the file.

fn location( &'a self, id: Self::FileId, byte_index: usize, ) -> Result<Location, Error>

Convenience method for returning line and column number at the given byte index in the file.

impl<F: CompilerFeat> ShadowApi for CompilerWorld<F>

fn _shadow_map_id(&self, file_id: FileId) -> FileResult<PathBuf>

fn shadow_paths(&self) -> Vec<Arc<Path>>

Get the shadow files.

fn reset_shadow(&mut self)

Reset the shadow files.

fn map_shadow(&mut self, path: &Path, content: Bytes) -> FileResult<()>

Add a shadow file to the driver.

fn unmap_shadow(&mut self, path: &Path) -> FileResult<()>

Add a shadow file to the driver.

fn map_shadow_by_id( &mut self, file_id: FileId, content: Bytes, ) -> FileResult<()>

Add a shadow file to the driver by file id. Note: to enable this function, ShadowApi must implement _shadow_map_id.

fn unmap_shadow_by_id(&mut self, file_id: FileId) -> FileResult<()>

Add a shadow file to the driver by file id. Note: to enable this function, ShadowApi must implement _shadow_map_id.

impl<F: CompilerFeat> World for CompilerWorld<F>

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

The standard library.

fn main(&self) -> FileId

Access the main source file.

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

Metadata about all known fonts.

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

Try to access the specified file.

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

Try to access the specified source file.

The returned Source file’s id does not have to match the given id. Due to symlinks, two different file id’s can point to the same on-disk file. Implementors can deduplicate and return the same Source if they want to, but do not have to.

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

Try to access the specified file.

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

Get the current date.

If no offset is specified, the local date should be chosen. Otherwise, the UTC date should be chosen with the corresponding offset in hours.

If this function returns None, Typst’s datetime function will return an error.

fn packages(&self) -> &[(PackageSpec, Option<EcoString>)]

A list of all available packages and optionally descriptions for them.

This function is optional to implement. It enhances the user experience by enabling autocompletion for packages. Details about packages from the @preview namespace are available from https://packages.typst.org/preview/index.json.

impl<F: CompilerFeat> WorldDeps for CompilerWorld<F>

fn iter_dependencies(&self, f: &mut dyn FnMut(ImmutPath))