Struct CompilerWorld

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

Fields

library: Arc<LazyHash<Library>>

Provides library for typst compiler.

font_resolver: Arc<<F as CompilerFeat>::FontResolver>

Provides font management for typst compiler.

registry: Arc<<F as CompilerFeat>::Registry>

Provides package management for typst compiler.

Implementations

impl<F> CompilerWorld<F>

where F: CompilerFeat,

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

pub fn take_cache(&mut self) -> SourceCache

pub fn clone_cache(&mut self) -> SourceCache

pub fn take_db(&mut self) -> SourceDb

pub fn vfs(&self) -> &Vfs<<F as CompilerFeat>::AccessModel>

pub fn set_is_compiling(&mut self, is_compiling: bool)

Sets flag to indicate whether the compiler is currently compiling. Note: Since CompilerWorld can be cloned, you can clone the world and set the flag then to avoid affecting the original world.

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

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

Resolve the real path for a file id.

pub fn id_for_path(&self, path: &Path) -> Option<FileId>

Resolve the root of the workspace.

pub fn revision(&self) -> NonZero<usize>

pub fn evict_vfs(&mut self, threshold: usize)

pub fn evict_source_cache(&mut self, threshold: usize)

pub 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.

pub fn paged_task(&self) -> Cow<'_, CompilerWorld<F>>

pub fn html_task(&self) -> Cow<'_, CompilerWorld<F>>

Trait Implementations

impl<F> Clone for CompilerWorld<F>

where F: CompilerFeat,

fn clone(&self) -> CompilerWorld<F>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<F> EntryReader for CompilerWorld<F>

where F: CompilerFeat,

fn entry_state(&self) -> EntryState

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

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

where F: CompilerFeat,

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<<CompilerWorld<F> as Files<'a>>::Name, Error>

The user-facing name of a file.

fn source( &'a self, id: FileId, ) -> Result<<CompilerWorld<F> as Files<'a>>::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> FsProvider for CompilerWorld<F>

where F: CompilerFeat,

fn file_path(&self, file_id: FileId) -> Result<PathResolution, FileError>

Arbitrary one of file path corresponding to the given id.

fn read(&self, file_id: FileId) -> Result<Bytes, FileError>

fn read_source(&self, file_id: FileId) -> Result<Source, FileError>

impl<F> ShadowApi for CompilerWorld<F>

where F: CompilerFeat,

fn shadow_ids(&self) -> Vec<FileId>

Get the shadow files by file id.

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) -> Result<(), FileError>

Add a shadow file to the driver.

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

Add a shadow file to the driver.

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

Add a shadow file to the driver by file id. Note: If a path is both shadowed by id and by path, the shadow by id will be used.

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

Add a shadow file to the driver by file id. Note: If a path is both shadowed by id and by path, the shadow by id will be used.

impl<F> SourceWorld for CompilerWorld<F>

where F: CompilerFeat,

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

Resolve the real path for a file id.

fn as_world(&self) -> &dyn World

fn lookup(&self, id: FileId) -> Source

impl<F> World for CompilerWorld<F>

where F: CompilerFeat,

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) -> Result<Source, FileError>

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. Implementers can deduplicate and return the same Source if they want to, but do not have to.

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

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.

impl<F> WorldDeps for CompilerWorld<F>

where F: CompilerFeat,

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