Struct ra_ap_hir_def::nameres::DefMap

pub struct DefMap { /* fields omitted */ }

Contains the results of (early) name resolution.

A DefMap stores the module tree and the definitions that are in scope in every module after item-level macros have been expanded.

Every crate has a primary DefMap whose root is the crate’s main file (main.rs/lib.rs), computed by the crate_def_map query. Additionally, every block expression introduces the opportunity to write arbitrary item and module hierarchies, and thus gets its own DefMap that is computed by the block_def_map query.

Implementations

impl DefMap

pub fn modules_for_file(
    &self,
    file_id: FileId
) -> impl Iterator<Item = LocalModuleId> + '_

pub fn modules(&self) -> impl Iterator<Item = (LocalModuleId, &ModuleData)> + '_

pub fn root(&self) -> LocalModuleId

pub fn module_id(&self, local_id: LocalModuleId) -> ModuleId

pub fn with_ancestor_maps<T>(
    &self,
    db: &dyn DefDatabase,
    local_mod: LocalModuleId,
    f: &mut dyn FnMut(&DefMap, LocalModuleId) -> Option<T>
) -> Option<T>

Ascends the DefMap hierarchy and calls f with every DefMap and containing module.

If f returns Some(val), iteration is stopped and Some(val) is returned. If f returns None, iteration continues.

pub fn parent(&self) -> Option<ModuleId>

If this DefMap is for a block expression, returns the module containing the block (which might again be a block, or a module inside a block).

pub fn containing_module(&self, local_mod: LocalModuleId) -> Option<ModuleId>

Returns the module containing local_mod, either the parent mod, or the module containing the block, if self corresponds to a block expression.

pub fn dump(&self, db: &dyn DefDatabase) -> String

pub fn dump_block_scopes(&self, db: &dyn DefDatabase) -> String

pub fn diagnostics(&self) -> &[DefDiagnostic]

Get a reference to the def map’s diagnostics.

Trait Implementations

impl Debug for DefMap

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

Formats the value using the given formatter.

impl Index<Idx<ModuleData>> for DefMap

type Output = ModuleData

The returned type after indexing.

fn index(&self, id: LocalModuleId) -> &ModuleData

Performs the indexing (container[index]) operation.

impl PartialEq<DefMap> for DefMap

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Eq for DefMap

impl StructuralEq for DefMap

impl StructuralPartialEq for DefMap