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<Symbol>>,
    modules: Vec<Module<'tcx>>,
}

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<Symbol>>

modules: Vec<Module<'tcx>>

Implementations

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

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

fn store_path(&mut self, did: DefId)

pub(crate) fn visit(self) -> Module<'tcx>

fn visit_mod_contents(&mut self, id: HirId, m: &'tcx Mod<'tcx>)

This method will go through the given module items in two passes:

1. The items which are not glob imports/reexports.
2. The glob imports/reexports.

fn maybe_inline_local(
    &mut self,
    id: HirId,
    res: Res,
    renamed: Option<Symbol>,
    glob: bool,
    please_inline: bool
) -> bool

Tries to resolve the target of a pub 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.

fn add_to_current_mod(
    &mut self,
    item: &'tcx Item<'_>,
    renamed: Option<Symbol>,
    parent_id: Option<HirId>
)

fn visit_item_inner(
    &mut self,
    item: &'tcx Item<'_>,
    renamed: Option<Symbol>,
    parent_id: Option<HirId>
) -> bool

fn visit_foreign_item_inner(
    &mut self,
    item: &'tcx ForeignItem<'_>,
    renamed: Option<Symbol>
)

fn enter_mod(&mut self, id: HirId, m: &'tcx Mod<'tcx>, name: Symbol)

This method will create a new module and push it onto the “modules stack” then call visit_mod_contents. Once done, it’ll remove it from the “modules stack” and instead add into into the list of modules of the current module.

Trait Implementations

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

type NestedFilter = All

Override this type to control which nested HIR are visited; see NestedFilter for details. If you override this type, you must also override nested_visit_map.

fn nested_visit_map(&mut self) -> Self::Map

If type NestedFilter is set to visit nested items, this method must also be overridden to provide a map to retrieve nested items.

fn visit_item(&mut self, i: &'tcx Item<'tcx>)

Visits the top-level item and (optionally) nested items / impl items. See visit_nested_item for details.

fn visit_mod(&mut self, _: &Mod<'tcx>, _: Span, _: HirId)

fn visit_use(&mut self, _: &UsePath<'tcx>, _: HirId)

fn visit_path(&mut self, _: &Path<'tcx>, _: HirId)

fn visit_label(&mut self, _: &Label)

fn visit_infer(&mut self, _: &InferArg)

fn visit_lifetime(&mut self, _: &Lifetime)

type Map = <Self::NestedFilter as NestedFilter<'v>>::Map

fn visit_nested_item(&mut self, id: ItemId)

Invoked when a nested item is encountered. By default, when Self::NestedFilter is nested_filter::None, this method does nothing. You probably don’t want to override this method – instead, override Self::NestedFilter or use the “shallow” or “deep” visit patterns described on itemlikevisit::ItemLikeVisitor. The only reason to override this method is if you want a nested pattern but cannot supply a Map; see nested_visit_map for advice.

fn visit_nested_trait_item(&mut self, id: TraitItemId)

Like visit_nested_item(), but for trait items. See visit_nested_item() for advice on when to override this method.

fn visit_nested_impl_item(&mut self, id: ImplItemId)

Like visit_nested_item(), but for impl items. See visit_nested_item() for advice on when to override this method.

fn visit_nested_foreign_item(&mut self, id: ForeignItemId)

Like visit_nested_item(), but for foreign items. See visit_nested_item() for advice on when to override this method.

fn visit_nested_body(&mut self, id: BodyId)

Invoked to visit the body of a function, method or closure. Like visit_nested_item, does nothing by default unless you override Self::NestedFilter.

fn visit_param(&mut self, param: &'v Param<'v>)

fn visit_body(&mut self, b: &'v Body<'v>)

fn visit_id(&mut self, _hir_id: HirId)

fn visit_name(&mut self, _name: Symbol)

fn visit_ident(&mut self, ident: Ident)

fn visit_foreign_item(&mut self, i: &'v ForeignItem<'v>)

fn visit_local(&mut self, l: &'v Local<'v>)

fn visit_block(&mut self, b: &'v Block<'v>)

fn visit_stmt(&mut self, s: &'v Stmt<'v>)

fn visit_arm(&mut self, a: &'v Arm<'v>)

fn visit_pat(&mut self, p: &'v Pat<'v>)

fn visit_pat_field(&mut self, f: &'v PatField<'v>)

fn visit_array_length(&mut self, len: &'v ArrayLen)

fn visit_anon_const(&mut self, c: &'v AnonConst)

fn visit_expr(&mut self, ex: &'v Expr<'v>)

fn visit_let_expr(&mut self, lex: &'v Let<'v>)

fn visit_expr_field(&mut self, field: &'v ExprField<'v>)

fn visit_ty(&mut self, t: &'v Ty<'v>)

fn visit_generic_param(&mut self, p: &'v GenericParam<'v>)

fn visit_const_param_default(&mut self, _param: HirId, ct: &'v AnonConst)

fn visit_generics(&mut self, g: &'v Generics<'v>)

fn visit_where_predicate(&mut self, predicate: &'v WherePredicate<'v>)

fn visit_fn_ret_ty(&mut self, ret_ty: &'v FnRetTy<'v>)

fn visit_fn_decl(&mut self, fd: &'v FnDecl<'v>)

fn visit_fn(
    &mut self,
    fk: FnKind<'v>,
    fd: &'v FnDecl<'v>,
    b: BodyId,
    _: Span,
    id: HirId
)

fn visit_trait_item(&mut self, ti: &'v TraitItem<'v>)

fn visit_trait_item_ref(&mut self, ii: &'v TraitItemRef)

fn visit_impl_item(&mut self, ii: &'v ImplItem<'v>)

fn visit_foreign_item_ref(&mut self, ii: &'v ForeignItemRef)

fn visit_impl_item_ref(&mut self, ii: &'v ImplItemRef)

fn visit_trait_ref(&mut self, t: &'v TraitRef<'v>)

fn visit_param_bound(&mut self, bounds: &'v GenericBound<'v>)

fn visit_poly_trait_ref(&mut self, t: &'v PolyTraitRef<'v>)

fn visit_variant_data(&mut self, s: &'v VariantData<'v>)

fn visit_field_def(&mut self, s: &'v FieldDef<'v>)

fn visit_enum_def(&mut self, enum_definition: &'v EnumDef<'v>, item_id: HirId)

fn visit_variant(&mut self, v: &'v Variant<'v>)

fn visit_generic_arg(&mut self, generic_arg: &'v GenericArg<'v>)

fn visit_qpath(&mut self, qpath: &'v QPath<'v>, id: HirId, _span: Span)

fn visit_path_segment(&mut self, path_segment: &'v PathSegment<'v>)

fn visit_generic_args(&mut self, generic_args: &'v GenericArgs<'v>)

fn visit_assoc_type_binding(&mut self, type_binding: &'v TypeBinding<'v>)

fn visit_attribute(&mut self, _attr: &'v Attribute)

fn visit_associated_item_kind(&mut self, kind: &'v AssocItemKind)

fn visit_defaultness(&mut self, defaultness: &'v Defaultness)

fn visit_inline_asm(&mut self, asm: &'v InlineAsm<'v>, id: HirId)

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: 104 bytes