Struct rustdoc::visit_ast::RustdocVisitor

pub struct RustdocVisitor<'a, 'tcx: 'a, 'rcx: 'a> {
    pub cstore: &'a CrateStore,
    pub module: Module,
    pub attrs: HirVec<Attribute>,
    pub cx: &'a DocContext<'a, 'tcx, 'rcx>,
    view_item_stack: FxHashSet<NodeId>,
    inlining: bool,
    inside_public_path: bool,
    exact_paths: Option<FxHashMap<DefId, Vec<String>>>,
}

Fields

cstore: &'a CrateStore

module: Module

attrs: HirVec<Attribute>

cx: &'a DocContext<'a, 'tcx, 'rcx>

view_item_stack: FxHashSet<NodeId>

inlining: bool

inside_public_path: bool

Is the current module and all of its parents public?

exact_paths: Option<FxHashMap<DefId, Vec<String>>>

Methods

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

pub fn new(     cstore: &'a CrateStore,     cx: &'a DocContext<'a, 'tcx, 'rcx> ) -> RustdocVisitor<'a, 'tcx, 'rcx>

fn store_path(&mut self, did: DefId)

fn stability(&self, id: NodeId) -> Option<Stability>

fn deprecation(&self, id: NodeId) -> Option<Deprecation>

pub fn visit(&mut self, krate: &Crate)

pub fn visit_variant_data(     &mut self,     item: &Item,     name: Name,     sd: &VariantData,     generics: &Generics ) -> Struct

pub fn visit_union_data(     &mut self,     item: &Item,     name: Name,     sd: &VariantData,     generics: &Generics ) -> Union

pub fn visit_enum_def(     &mut self,     it: &Item,     name: Name,     def: &EnumDef,     params: &Generics ) -> Enum

pub fn visit_fn(     &mut self,     item: &Item,     name: Name,     fd: &FnDecl,     unsafety: &Unsafety,     constness: Constness,     abi: &Abi,     gen: &Generics,     body: BodyId ) -> Function

pub fn visit_mod_contents(     &mut self,     span: Span,     attrs: HirVec<Attribute>,     vis: Visibility,     id: NodeId,     m: &Mod,     name: Option<Name> ) -> Module

fn maybe_inline_local(     &mut self,     id: NodeId,     def: Def,     renamed: Option<Name>,     glob: bool,     om: &mut Module,     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.

pub fn visit_item(     &mut self,     item: &Item,     renamed: Option<Name>,     om: &mut Module )

fn visit_local_macro(&self, def: &MacroDef) -> Macro

Trait Implementations

impl<'a, 'tcx, 'rcx> Clean<Crate> for RustdocVisitor<'a, 'tcx, 'rcx>

fn clean(&self, cx: &DocContext) -> Crate