Struct rustdoc::visit_ast::Module

pub(crate) struct Module<'hir> {
    pub(crate) name: Symbol,
    pub(crate) where_inner: Span,
    pub(crate) mods: Vec<Module<'hir>>,
    pub(crate) def_id: LocalDefId,
    pub(crate) renamed: Option<Symbol>,
    pub(crate) import_id: Option<LocalDefId>,
    pub(crate) items: FxIndexMap<(LocalDefId, Option<Symbol>), (&'hir Item<'hir>, Option<Symbol>, Option<LocalDefId>)>,
    pub(crate) inlined_foreigns: FxIndexMap<(DefId, Option<Symbol>), (Res, LocalDefId)>,
    pub(crate) foreigns: Vec<(&'hir ForeignItem<'hir>, Option<Symbol>)>,
}

This module is used to store stuff from Rust’s AST in a more convenient manner (and with prettier names) before cleaning.

Fields

name: Symbol

where_inner: Span

mods: Vec<Module<'hir>>

def_id: LocalDefId

renamed: Option<Symbol>

import_id: Option<LocalDefId>

items: FxIndexMap<(LocalDefId, Option<Symbol>), (&'hir Item<'hir>, Option<Symbol>, Option<LocalDefId>)>

The key is the item ItemId and the value is: (item, renamed, import_id). We use FxIndexMap to keep the insert order.

inlined_foreigns: FxIndexMap<(DefId, Option<Symbol>), (Res, LocalDefId)>

Same as for items.

foreigns: Vec<(&'hir ForeignItem<'hir>, Option<Symbol>)>

Implementations

impl Module<'_>

pub(crate) fn new( name: Symbol, def_id: LocalDefId, where_inner: Span, renamed: Option<Symbol>, import_id: Option<LocalDefId>, ) -> Self

pub(crate) fn where_outer(&self, tcx: TyCtxt<'_>) -> Span

Trait Implementations

impl<'hir> Debug for Module<'hir>

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

Formats the value using the given formatter.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 184 bytes