Struct ide::SourceRoot

pub struct SourceRoot {
    pub is_library: bool,
    /* private fields */
}

Files are grouped into source roots. A source root is a directory on the file systems which is watched for changes. Typically it corresponds to a Rust crate. Source roots might be nested: in this case, a file belongs to the nearest enclosing source root. Paths to files are always relative to a source root, and the analyzer does not know the root path of the source root at all. So, a file from one source root can’t refer to a file in another source root by path.

Fields

is_library: bool

Sysroot or crates.io library.

Libraries are considered mostly immutable, this assumption is used to optimize salsa’s query structure

Implementations

impl SourceRoot

pub fn new_local(file_set: FileSet) -> SourceRoot

pub fn new_library(file_set: FileSet) -> SourceRoot

pub fn path_for_file(&self, file: &FileId) -> Option<&VfsPath>

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

pub fn resolve_path(&self, path: AnchoredPath<'_>) -> Option<FileId>

pub fn iter(&self) -> impl Iterator<Item = FileId>

Trait Implementations

impl Clone for SourceRoot

fn clone(&self) -> SourceRoot

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SourceRoot

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

Formats the value using the given formatter.

impl PartialEq for SourceRoot

fn eq(&self, other: &SourceRoot) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for SourceRoot

impl StructuralPartialEq for SourceRoot