Struct Vfs

pub struct Vfs<M: PathAccessModel + Sized> { /* private fields */ }

Create a new Vfs harnessing over the given access_model specific for reflexo_world::CompilerWorld. With vfs, we can minimize the implementation overhead for AccessModel trait.

Implementations

impl<M: PathAccessModel + Clone + Sized> Vfs<M>

pub fn revision(&self) -> NonZeroUsize

pub fn snapshot(&self) -> Self

pub fn fork(&self) -> Self

pub fn is_clean_compile(&self, rev: usize, file_ids: &[FileId]) -> bool

impl<M: PathAccessModel + Sized> Vfs<M>

pub fn new( resolver: Arc<dyn RootResolver + Send + Sync>, access_model: M, ) -> Self

Create a new Vfs with a given access_model.

Retrieving an AccessModel, it will further wrap the access model with OverlayAccessModel and NotifyAccessModel. This means that you don’t need to implement:

• overlay: allowing to shadow the underlying access model with memory contents, which is useful for a limited execution environment and instrumenting or overriding source files or packages.
• notify: regards problems of synchronizing with the file system when the vfs is watching the file system.

See AccessModel for more information.

pub fn reset_all(&mut self)

Reset all state.

pub fn reset_access_model(&mut self)

Reset access model.

pub fn reset_mapping(&mut self)

Reset all possible caches.

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

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

pub fn take_source_cache(&mut self) -> SourceCache

pub fn clone_source_cache(&self) -> SourceCache

pub fn file_path(&self, id: TypstFileId) -> Result<PathResolution, FileError>

Resolve the real path for a file id.

pub fn shadow_paths(&self) -> Vec<ImmutPath>

Get paths to all the shadowing paths in OverlayAccessModel.

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

Get paths to all the shadowing file ids in OverlayAccessModel.

The in memory untitled files can have no path so they only have file ids.

pub fn memory_usage(&self) -> usize

Returns the overall memory usage for the stored files.

pub fn revise(&mut self) -> RevisingVfs<'_, M>

pub fn display(&self) -> DisplayVfs<'_, M>

pub fn read(&self, fid: TypstFileId) -> FileResult<Bytes>

Reads a file.

pub fn source(&self, file_id: TypstFileId) -> FileResult<Source>

Reads a source.

Trait Implementations

impl<M: PathAccessModel + Sized> Debug for Vfs<M>

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

Formats the value using the given formatter.