Struct rustdoc::visit_ast::RustdocVisitor

pub(crate) struct RustdocVisitor<'a, 'tcx> {
    cx: &'a mut DocContext<'tcx>,
    view_item_stack: FxHashSet<HirId>,
    inlining: bool,
    inside_public_path: bool,
    exact_paths: FxHashMap<DefId, Vec<String>>,
}

Fields

cx: &'a mut DocContext<'tcx>

view_item_stack: FxHashSet<HirId>

inlining: bool

inside_public_path: bool

Are the current module and all of its parents public?

exact_paths: FxHashMap<DefId, Vec<String>>

Implementations

impl<'a, 'tcx> RustdocVisitor<'a, 'tcx>

pub(crate) fn new(cx: &'a mut DocContext<'tcx>) -> RustdocVisitor<'a, 'tcx>

pub(in visit_ast) fn store_path(
    &mut self,
    did: DefId
)

pub(crate) fn visit(self, krate: &'tcx Crate<'_>) -> Module<'tcx>

pub(in visit_ast) fn visit_variant_data(
    &mut self,
    item: &'tcx Item<'_>,
    name: Symbol,
    sd: &'tcx VariantData<'_>,
    generics: &'tcx Generics<'_>
) -> Struct<'tcx>

pub(in visit_ast) fn visit_union_data(
    &mut self,
    item: &'tcx Item<'_>,
    name: Symbol,
    sd: &'tcx VariantData<'_>,
    generics: &'tcx Generics<'_>
) -> Union<'tcx>

pub(in visit_ast) fn visit_enum_def(
    &mut self,
    it: &'tcx Item<'_>,
    name: Symbol,
    def: &'tcx EnumDef<'_>,
    generics: &'tcx Generics<'_>
) -> Enum<'tcx>

pub(in visit_ast) fn visit_fn(
    &mut self,
    om: &mut Module<'tcx>,
    item: &'tcx Item<'_>,
    name: Symbol,
    decl: &'tcx FnDecl<'_>,
    header: FnHeader,
    generics: &'tcx Generics<'_>,
    body: BodyId
)

pub(in visit_ast) fn visit_mod_contents(
    &mut self,
    span: Span,
    attrs: &'tcx [Attribute],
    vis: &'tcx Visibility<'_>,
    id: HirId,
    m: &'tcx Mod<'tcx>,
    name: Option<Symbol>
) -> Module<'tcx>

pub(in visit_ast) fn maybe_inline_local(
    &mut self,
    id: HirId,
    res: Res,
    renamed: Option<Ident>,
    glob: bool,
    om: &mut Module<'tcx>,
    please_inline: bool
) -> bool

Tries to resolve the target of a crate use statement and inlines the target if it is defined locally and would not be documented otherwise, or when it is specifically requested with please_inline. (the latter is the case when the import is marked doc(inline))

Cross-crate inlining occurs later on during crate cleaning and follows different rules.

Returns true if the target has been inlined.

pub(in visit_ast) fn visit_item(
    &mut self,
    item: &'tcx Item<'_>,
    renamed: Option<Ident>,
    om: &mut Module<'tcx>
)

pub(in visit_ast) fn visit_foreign_item(
    &mut self,
    item: &'tcx ForeignItem<'_>,
    renamed: Option<Ident>,
    om: &mut Module<'tcx>
)

pub(in visit_ast) fn visit_local_macro(
    &self,
    def: &'tcx MacroDef<'_>,
    renamed: Option<Symbol>
) -> Macro