Struct hir::DefMap

pub struct DefMap {
    pub modules: Arena<ModuleData>,
    /* private fields */
}

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.

Fields

modules: Arena<ModuleData>

The modules and their data declared in this crate.

Implementations

impl DefMap

pub const ROOT: Idx<ModuleData> = _

The module id of a crate or block root.

pub fn edition(&self) -> Edition

impl DefMap

pub fn modules_for_file( &self, file_id: FileId, ) -> impl Iterator<Item = Idx<ModuleData>>

pub fn modules(&self) -> impl Iterator<Item = (Idx<ModuleData>, &ModuleData)>

pub fn derive_helpers_in_scope( &self, id: InFileWrapper<HirFileId, FileAstId<Adt>>, ) -> Option<&[(Name, MacroId, MacroCallId)]>

pub fn registered_tools(&self) -> &[Symbol]

pub fn registered_attrs(&self) -> &[Symbol]

pub fn is_unstable_feature_enabled(&self, feature: &Symbol) -> bool

pub fn is_rustc_coherence_is_core(&self) -> bool

pub fn is_no_std(&self) -> bool

pub fn fn_as_proc_macro(&self, id: FunctionId) -> Option<ProcMacroId>

pub fn krate(&self) -> Idx<CrateData>

pub fn module_id(&self, local_id: Idx<ModuleData>) -> ModuleId

pub fn crate_root(&self) -> CrateRootModuleId

pub fn root_module_id(&self) -> ModuleId

This is the same as Self::crate_root for crate def maps, but for block def maps, it returns the root block module.

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: Idx<ModuleData>) -> Option<ModuleId>

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

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

Get a reference to the def map’s diagnostics.

pub fn recursion_limit(&self) -> u32

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

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

Trait Implementations

impl Debug for DefMap

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

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: Idx<ModuleData>) -> &ModuleData

Performs the indexing (container[index]) operation.

impl PartialEq for DefMap

fn eq(&self, other: &DefMap) -> 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 DefMap

impl StructuralPartialEq for DefMap