Struct CompilerUniverse

pub struct CompilerUniverse<F>
where
    F: CompilerFeat,
{
    pub features: Features,
    pub font_resolver: Arc<<F as CompilerFeat>::FontResolver>,
    pub registry: Arc<<F as CompilerFeat>::Registry>,
    pub revision: NonZero<usize>,
    /* 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

features: Features

Features enabled for the 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.

revision: NonZero<usize>

The current revision of the universe.

Implementations

impl<F> CompilerUniverse<F>

where F: CompilerFeat,

Creates, snapshots, and manages the compiler universe.

pub fn new_raw( entry: EntryState, features: Features, inputs: Option<Arc<LazyHash<Dict>>>, vfs: Vfs<<F as CompilerFeat>::AccessModel>, package_registry: Arc<<F as CompilerFeat>::Registry>, font_resolver: Arc<<F as CompilerFeat>::FontResolver>, ) -> CompilerUniverse<F>

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) -> CompilerUniverse<F>

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 as CompilerFeat>::AccessModel>

impl<F> CompilerUniverse<F>

where F: CompilerFeat,

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>>, Error>

impl CompilerUniverse<SystemCompilerFeat>

pub fn new( opts: CompileOpts, ) -> Result<CompilerUniverse<SystemCompilerFeat>, Error>

Create TypstSystemWorld with the given options. See SystemCompilerFeat for instantiation details. See [CompileOpts] for available options.

impl CompilerUniverse<BrowserCompilerFeat>

pub fn new( root_dir: PathBuf, inputs: Option<Arc<LazyHash<Dict>>>, access_model: ProxyAccessModel, registry: JsRegistry, font_resolver: FontResolverImpl, ) -> CompilerUniverse<BrowserCompilerFeat>

Trait Implementations

impl<F> Debug for CompilerUniverse<F>

where F: Debug + CompilerFeat, <F as CompilerFeat>::FontResolver: Debug, <F as CompilerFeat>::Registry: Debug, <F as CompilerFeat>::AccessModel: Debug,

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

Formats the value using the given formatter.

impl<F> EntryManager for CompilerUniverse<F>

where F: CompilerFeat,

fn mutate_entry( &mut self, state: EntryState, ) -> Result<EntryState, EcoVec<SourceDiagnostic>>

impl<F> EntryReader for CompilerUniverse<F>

where F: CompilerFeat,

fn entry_state(&self) -> EntryState

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

impl<F> ShadowApi for CompilerUniverse<F>

where F: CompilerFeat,

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<FileId>

Get the shadow files by file id.

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.