Struct Files 

pub struct Files { /* private fields */ }

Lookup table that maps file paths to salsa interned File instances.

Implementations

impl Files

pub fn freeze(&self)

Freezes all inputs on files created from now on.

Existing files retain their current durability. Callers should therefore call this before discovering any files if they need the freeze to apply to the entire project.

pub fn try_system(&self, db: &dyn Db, path: &SystemPath) -> Option<File>

Tries to look up the file for the given system path, returns None if no such file exists yet

pub fn virtual_file(&self, db: &dyn Db, path: &SystemVirtualPath) -> VirtualFile

Create a new virtual file at the given path and store it for future lookups.

This will always create a new file, overwriting any existing file at path in the internal storage.

pub fn try_virtual_file(&self, path: &SystemVirtualPath) -> Option<VirtualFile>

Tries to look up a virtual file by its path. Returns None if no such file exists yet.

pub fn root(&self, db: &dyn Db, path: &SystemPath) -> Option<FileRoot>

Looks up the closest root for path. Returns None if path isn’t enclosed by any source root.

Roots can be nested, in which case the closest root is returned.

pub fn try_add_root( &self, db: &dyn Db, path: &SystemPath, kind: FileRootKind, ) -> FileRoot

Adds a new root for path and returns the root.

The root isn’t added nor is the file root’s kind updated if a root for path already exists.

pub fn sync_all_recursive<P, I>(db: &mut dyn Db, paths: I)

where P: AsRef<SystemPath>, I: IntoIterator<Item = P>,

Refreshes the state of all known files under paths recursively.

The most common use case is to update the Files state after removing or moving directories.

Performance

Refreshing the state of files recursively is expensive. It requires iterating over all known files and making system calls to get the latest status of matching files. That’s why File::sync_path is preferred if it is known that the path is a file.

pub fn sync_all(db: &mut dyn Db)

Refreshes the state of all known files.

This is a last-resort method that should only be used when more granular updates aren’t possible (for example, because the file watcher failed to observe some changes). Use responsibly!

Performance

Refreshing the state of every file is expensive. It requires iterating over all known files and issuing a system call to get the latest status of each file.

Trait Implementations

impl Clone for Files

fn clone(&self) -> Files

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Files

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

Formats the value using the given formatter.

impl Default for Files

fn default() -> Files

Returns the “default value” for a type.

impl RefUnwindSafe for Files