Struct ide::SearchScope

pub struct SearchScope { /* private fields */ }

Generally, search_scope returns files that might contain references for the element. For pub(crate) things it’s a crate, for pub things it’s a crate and dependant crates. In some cases, the location of the references is known to within a TextRange, e.g. for things like local variables.

Implementations

impl SearchScope

pub fn module_and_children(db: &RootDatabase, module: Module) -> SearchScope

Build a search scope spanning the given module and all its submodules.

pub fn empty() -> SearchScope

Build an empty search scope.

pub fn single_file(file: FileId) -> SearchScope

Build a empty search scope spanning the given file.

pub fn file_range(range: FileRange) -> SearchScope

Build a empty search scope spanning the text range of the given file.

pub fn files(files: &[FileId]) -> SearchScope

Build a empty search scope spanning the given files.

pub fn intersection(&self, other: &SearchScope) -> SearchScope

Trait Implementations

impl Clone for SearchScope

fn clone(&self) -> SearchScope

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SearchScope

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

Formats the value using the given formatter.

impl IntoIterator for SearchScope

type Item = (FileId, Option<TextRange>)

The type of the elements being iterated over.

type IntoIter = IntoIter<FileId, Option<TextRange>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <SearchScope as IntoIterator>::IntoIter

Creates an iterator from a value.