Struct CompilerUniverse

pub struct CompilerUniverse<F: CompilerFeat> {
    pub font_resolver: Arc<F::FontResolver>,
    pub registry: Arc<F::Registry>,
    pub revision: NonZeroUsize,
    /* private fields */
}

A universe that provides access to the operating system.

Use CompilerUniverse::new_raw to create a new universe. The concrete implementation usually wraps this function with a more user-friendly new function. Use CompilerUniverse::snapshot to create a new world.

Fields

font_resolver: Arc<F::FontResolver>

Provides font management for typst compiler.

registry: Arc<F::Registry>

Provides package management for typst compiler.

revision: NonZeroUsize

The current revision of the universe.

Implementations

impl<F: CompilerFeat> CompilerUniverse<F>

Creates, snapshots, and manages the compiler universe.

pub fn new_raw( entry: EntryState, enable_html: bool, inputs: Option<Arc<LazyHash<Dict>>>, vfs: Vfs<F::AccessModel>, registry: Arc<F::Registry>, font_resolver: Arc<F::FontResolver>, ) -> Self

Create a CompilerUniverse with feature implementation.

Although this function is public, it is always unstable and not intended to be used directly.

• See [crate::TypstSystemUniverse::new] for system environment.
• See [crate::TypstBrowserUniverse::new] for browser environment.

pub fn with_entry_file(self, entry_file: PathBuf) -> Self

Wrap driver with a given entry file.

pub fn entry_file(&self) -> Option<PathResolution>

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

pub fn snapshot(&self) -> CompilerWorld<F>

pub fn computation(&self) -> Arc<WorldComputeGraph<F>>

pub fn computation_with(&self, mutant: TaskInputs) -> Arc<WorldComputeGraph<F>>

pub fn snapshot_with_entry_content( &self, content: Bytes, inputs: Option<TaskInputs>, ) -> Arc<WorldComputeGraph<F>>

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

pub fn increment_revision<T>( &mut self, f: impl FnOnce(&mut RevisingUniverse<'_, F>) -> T, ) -> T

Increment revision with actions.

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

impl<F: CompilerFeat> CompilerUniverse<F>

pub fn reset(&mut self)

Reset the world for a new lifecycle (of garbage collection).

pub fn evict(&mut self, vfs_threshold: usize)

Clear the vfs cache that is not touched for a long time.

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 get_semantic_token_legend(&self) -> Arc<SemanticTokensLegend>

pub fn get_semantic_tokens( &self, file_path: Option<String>, encoding: OffsetEncoding, ) -> Result<Arc<Vec<SemanticToken>>>

Trait Implementations

impl<F: Debug + CompilerFeat> Debug for CompilerUniverse<F>

where F::FontResolver: Debug, F::Registry: Debug, F::AccessModel: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<F: CompilerFeat> EntryManager for CompilerUniverse<F>

fn mutate_entry(&mut self, state: EntryState) -> SourceResult<EntryState>

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

fn entry_state(&self) -> EntryState

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

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

fn reset_shadow(&mut self)

Reset the shadow files.

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

Get the shadow files.

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

Get the shadow files by file id.

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: 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) -> FileResult<()>

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.