Struct FindUsages 

pub struct FindUsages<'a> {
    def: Definition,
    rename: Option<&'a Rename>,
    sema: &'a Semantics<'a, RootDatabase>,
    scope: Option<&'a SearchScope>,
    assoc_item_container: Option<AssocItemContainer>,
    include_self_kw_refs: Option<Type<'a>>,
    search_self_mod: bool,
}

Fields

def: Definition

rename: Option<&'a Rename>

sema: &'a Semantics<'a, RootDatabase>

scope: Option<&'a SearchScope>

assoc_item_container: Option<AssocItemContainer>

The container of our definition should it be an assoc item

include_self_kw_refs: Option<Type<'a>>

whether to search for the Self type of the definition

search_self_mod: bool

whether to search for the self module

Implementations

impl<'a> FindUsages<'a>

pub fn include_self_refs(self) -> Self

Enable searching for Self when the definition is a type or self for modules.

pub fn in_scope(self, scope: &'a SearchScope) -> Self

Limit the search to a given SearchScope.

pub fn set_scope(self, scope: Option<&'a SearchScope>) -> Self

Limit the search to a given SearchScope.

pub fn with_rename(self, rename: Option<&'a Rename>) -> Self

pub fn at_least_one(&self) -> bool

pub fn all(self) -> UsageSearchResult

fn scope_files<'b>( db: &'b RootDatabase, scope: &'b SearchScope, ) -> impl Iterator<Item = (Arc<str>, EditionedFileId, TextRange)> + 'b

fn match_indices<'b>( text: &'b str, finder: &'b Finder<'b>, search_range: TextRange, ) -> impl Iterator<Item = TextSize> + 'b

fn find_nodes<'b>( sema: &'b Semantics<'_, RootDatabase>, name: &str, file_id: EditionedFileId, node: &SyntaxNode, offset: TextSize, ) -> impl Iterator<Item = SyntaxNode> + 'b

fn short_associated_function_fast_search( &self, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, search_scope: &SearchScope, name: &str, ) -> bool

Performs a special fast search for associated functions. This is mainly intended to speed up new() which can take a long time.

The trick is instead of searching for func_name search for TypeThatContainsContainerName::func_name. We cannot search exactly that (not even in tokens), because ContainerName may be aliased. Instead, we perform a textual search for ContainerName. Then, we look for all cases where ContainerName may be aliased (that includes use ContainerName as Xyz and type Xyz = ContainerName). We collect a list of all possible aliases of ContainerName. The list can have false positives (because there may be multiple types named ContainerName), but it cannot have false negatives. Then, we look for TypeThatContainsContainerNameOrAnyAlias::func_name. Those that will be found are of high chance to be actual hits (of course, we will need to verify that).

Returns true if completed the search.

pub fn search( &self, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, )

fn found_self_ty_name_ref( &self, self_ty: &Type<'_>, name_ref: &NameRef, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, ) -> bool

fn found_self_module_name_ref( &self, name_ref: &NameRef, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, ) -> bool

fn found_format_args_ref( &self, file_id: EditionedFileId, range: TextRange, token: String, res: Either<PathResolution, InlineAsmOperand>, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, ) -> bool

fn found_lifetime( &self, lifetime: &Lifetime, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, ) -> bool

fn found_name_ref( &self, name_ref: &NameRef, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, ) -> bool

fn found_name( &self, name: &Name, sink: &mut dyn FnMut(EditionedFileId, FileReference) -> bool, ) -> bool

Trait Implementations

impl<'a> Clone for FindUsages<'a>

fn clone(&self) -> FindUsages<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.