Struct rustc_middle::hir::map::Map

pub struct Map<'hir> {
    pub(super) tcx: TyCtxt<'hir>,
}

Fields

tcx: TyCtxt<'hir>

Implementations

impl<'hir> Map<'hir>

pub fn krate(&self) -> &'hir Crate<'hir>

pub fn definitions(&self) -> &'hir Definitions

pub fn def_key(&self, def_id: LocalDefId) -> DefKey

pub fn def_path_from_hir_id(&self, id: HirId) -> Option<DefPath>

pub fn def_path(&self, def_id: LocalDefId) -> DefPath

pub fn local_def_id(&self, hir_id: HirId) -> LocalDefId

pub fn opt_local_def_id(&self, hir_id: HirId) -> Option<LocalDefId>

pub fn local_def_id_to_hir_id(&self, def_id: LocalDefId) -> HirId

pub fn iter_local_def_id(&self) -> impl Iterator<Item = LocalDefId> + '_

pub fn opt_def_kind(&self, local_def_id: LocalDefId) -> Option<DefKind>

pub fn def_kind(&self, local_def_id: LocalDefId) -> DefKind

pub fn find_parent_node(&self, id: HirId) -> Option<HirId>

pub fn get_parent_node(&self, hir_id: HirId) -> HirId

pub fn find(&self, id: HirId) -> Option<Node<'hir>>

Retrieves the Node corresponding to id, returning None if cannot be found.

pub fn get(&self, id: HirId) -> Node<'hir>

Retrieves the Node corresponding to id, panicking if it cannot be found.

pub fn get_if_local(&self, id: DefId) -> Option<Node<'hir>>

pub fn get_generics(&self, id: DefId) -> Option<&'hir Generics<'hir>>

pub fn item(&self, id: ItemId) -> &'hir Item<'hir>

pub fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem<'hir>

pub fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem<'hir>

pub fn foreign_item(&self, id: ForeignItemId) -> &'hir ForeignItem<'hir>

pub fn body(&self, id: BodyId) -> &'hir Body<'hir>

pub fn fn_decl_by_hir_id(&self, hir_id: HirId) -> Option<&'hir FnDecl<'hir>>

pub fn fn_sig_by_hir_id(&self, hir_id: HirId) -> Option<&'hir FnSig<'hir>>

pub fn enclosing_body_owner(&self, hir_id: HirId) -> HirId

pub fn body_owner(&self, _: BodyId) -> HirId

Returns the HirId that corresponds to the definition of which this is the body of, i.e., a fn, const or static item (possibly associated), a closure, or a hir::AnonConst.

pub fn body_owner_def_id(&self, id: BodyId) -> LocalDefId

pub fn maybe_body_owned_by(&self, hir_id: HirId) -> Option<BodyId>

Given a HirId, returns the BodyId associated with it, if the node is a body owner, otherwise returns None.

pub fn body_owned_by(&self, id: HirId) -> BodyId

Given a body owner’s id, returns the BodyId associated with it.

pub fn body_param_names(&self, id: BodyId) -> impl Iterator<Item = Ident> + 'hir

pub fn body_owner_kind(&self, id: HirId) -> BodyOwnerKind

Returns the BodyOwnerKind of this LocalDefId.

Panics if LocalDefId does not have an associated body.

pub fn body_const_context(&self, did: LocalDefId) -> Option<ConstContext>

Returns the ConstContext of the body associated with this LocalDefId.

Panics if LocalDefId does not have an associated body.

pub fn ty_param_owner(&self, id: HirId) -> HirId

pub fn ty_param_name(&self, id: HirId) -> Symbol

pub fn trait_impls(&self, trait_did: DefId) -> &'hir [LocalDefId]

pub fn krate_attrs(&self) -> &'hir [Attribute]

Gets the attributes on the crate. This is preferable to invoking krate.attrs because it registers a tighter dep-graph access.

pub fn get_module(&self, module: LocalDefId) -> (&'hir Mod<'hir>, Span, HirId)

pub fn visit_item_likes_in_module<V>(&self, module: LocalDefId, visitor: &mut V) where
    V: ItemLikeVisitor<'hir>, 

pub fn visit_exported_macros_in_krate<V>(&self, visitor: &mut V) where
    V: Visitor<'hir>, 

pub fn parent_iter(&self, current_id: HirId) -> ParentHirIterator<'_, 'hir>

Returns an iterator for the nodes in the ancestor tree of the current_id until the crate root is reached. Prefer this over your own loop using get_parent_node.

pub fn parent_owner_iter(
    &self,
    current_id: HirId
) -> ParentOwnerIterator<'_, 'hir>

Returns an iterator for the nodes in the ancestor tree of the current_id until the crate root is reached. Prefer this over your own loop using get_parent_node.

pub fn is_lhs(&self, id: HirId) -> bool

Checks if the node is left-hand side of an assignment.

pub fn is_inside_const_context(&self, hir_id: HirId) -> bool

Whether the expression pointed at by hir_id belongs to a const evaluation context. Used exclusively for diagnostics, to avoid suggestion function calls.

pub fn is_hir_id_module(&self, hir_id: HirId) -> bool

Whether hir_id corresponds to a mod or a crate.

pub fn get_return_block(&self, id: HirId) -> Option<HirId>

Retrieves the HirId for id’s enclosing method, unless there’s a while or loop before reaching it, as block tail returns are not available in them.

fn foo(x: usize) -> bool {
    if x == 1 {
        true  // If `get_return_block` gets passed the `id` corresponding
    } else {  // to this, it will return `foo`'s `HirId`.
        false
    }
}

fn foo(x: usize) -> bool {
    loop {
        true  // If `get_return_block` gets passed the `id` corresponding
    }         // to this, it will return `None`.
    false
}

pub fn get_parent_item(&self, hir_id: HirId) -> HirId

Retrieves the HirId for id’s parent item, or id itself if no parent item is in this map. The “parent item” is the closest parent node in the HIR which is recorded by the map and is an item, either an item in a module, trait, or impl.

pub(super) fn get_module_parent_node(&self, hir_id: HirId) -> HirId

Returns the HirId of id’s nearest module parent, or id itself if no module parent is in this map.

pub fn get_if_cause(&self, hir_id: HirId) -> Option<&'hir Expr<'hir>>

When on an if expression, a match arm tail expression or a match arm, give back the enclosing if or match expression.

Used by error reporting when there’s a type error in an if or match arm caused by the expression needing to be unit.

pub fn get_enclosing_scope(&self, hir_id: HirId) -> Option<HirId>

Returns the nearest enclosing scope. A scope is roughly an item or block.

pub fn get_defining_scope(&self, id: HirId) -> HirId

Returns the defining scope for an opaque type definition.

pub fn get_parent_did(&self, id: HirId) -> LocalDefId

pub fn get_foreign_abi(&self, hir_id: HirId) -> Abi

pub fn expect_item(&self, id: HirId) -> &'hir Item<'hir>

pub fn expect_impl_item(&self, id: HirId) -> &'hir ImplItem<'hir>

pub fn expect_trait_item(&self, id: HirId) -> &'hir TraitItem<'hir>

pub fn expect_variant(&self, id: HirId) -> &'hir Variant<'hir>

pub fn expect_foreign_item(&self, id: HirId) -> &'hir ForeignItem<'hir>

pub fn expect_macro_def(&self, id: HirId) -> &'hir MacroDef<'hir>

pub fn expect_expr(&self, id: HirId) -> &'hir Expr<'hir>

pub fn opt_name(&self, id: HirId) -> Option<Symbol>

pub fn name(&self, id: HirId) -> Symbol

pub fn attrs(&self, id: HirId) -> &'hir [Attribute]

Given a node ID, gets a list of attributes associated with the AST corresponding to the node-ID.

pub fn span(&self, hir_id: HirId) -> Span

Gets the span of the definition of the specified HIR node. This is used by tcx.get_span

pub fn opt_span(&self, hir_id: HirId) -> Option<Span>

pub fn span_with_body(&self, hir_id: HirId) -> Span

Like hir.span(), but includes the body of function items (instead of just the function header)

pub fn span_if_local(&self, id: DefId) -> Option<Span>

pub fn res_span(&self, res: Res) -> Option<Span>

pub fn node_to_string(&self, id: HirId) -> String

Get a representation of this id for debugging purposes. NOTE: Do NOT use this in diagnostics!

Trait Implementations

impl<'hir> Clone for Map<'hir>

fn clone(&self) -> Map<'hir>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'hir> Map<'hir> for Map<'hir>

fn find(&self, hir_id: HirId) -> Option<Node<'hir>>

Retrieves the Node corresponding to id, returning None if cannot be found.

fn body(&self, id: BodyId) -> &'hir Body<'hir>

fn item(&self, id: ItemId) -> &'hir Item<'hir>

fn trait_item(&self, id: TraitItemId) -> &'hir TraitItem<'hir>

fn impl_item(&self, id: ImplItemId) -> &'hir ImplItem<'hir>

fn foreign_item(&self, id: ForeignItemId) -> &'hir ForeignItem<'hir>

impl<'hir> Copy for Map<'hir>