Struct Vfs

pub struct Vfs { /* private fields */ }

Storage for all file changes and the file id to path mapping.

For more information see the crate-level documentation.

Implementations

impl Vfs

pub fn file_id(&self, path: &VfsPath) -> Option<(FileId, FileExcluded)>

Id of the given path if it exists in the Vfs and is not deleted.

pub fn file_path(&self, file_id: FileId) -> &VfsPath

File path corresponding to the given file_id.

Panics

Panics if the id is not present in the Vfs.

pub fn iter(&self) -> impl Iterator<Item = (FileId, &VfsPath)> + '_

Returns an iterator over the stored ids and their corresponding paths.

This will skip deleted files.

pub fn set_file_contents( &mut self, path: VfsPath, contents: Option<Vec<u8>>, ) -> bool

Update the path with the given contents. None means the file was deleted.

Returns true if the file was modified, and saves the change.

If the path does not currently exists in the Vfs, allocates a new FileId for it.

pub fn take_changes( &mut self, ) -> IndexMap<FileId, ChangedFile, BuildHasherDefault<FxHasher>>

Drain and returns all the changes in the Vfs.

pub fn exists(&self, file_id: FileId) -> bool

Provides a panic-less way to verify file_id validity.

pub fn insert_excluded_file(&mut self, path: VfsPath)

We cannot ignore excluded files, because this will lead to errors when the client requests semantic information for them, so we instead mark them specially.

Trait Implementations

impl Debug for Vfs

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

Formats the value using the given formatter.

impl Default for Vfs

fn default() -> Vfs

Returns the “default value” for a type.