Struct rustdoc::visit_ast::RustdocVisitor

source ·
pub(crate) struct RustdocVisitor<'a, 'tcx> {
    cx: &'a mut DocContext<'tcx>,
    view_item_stack: LocalDefIdSet,
    inlining: bool,
    inside_public_path: bool,
    exact_paths: DefIdMap<Vec<Symbol>>,
    modules: Vec<Module<'tcx>>,
    is_importable_from_parent: bool,
    inside_body: bool,
}

Fields§

§cx: &'a mut DocContext<'tcx>§view_item_stack: LocalDefIdSet§inlining: bool§inside_public_path: bool

Are the current module and all of its parents public?

§exact_paths: DefIdMap<Vec<Symbol>>§modules: Vec<Module<'tcx>>§is_importable_from_parent: bool§inside_body: bool

Implementations§

source§

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

source

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

source

fn store_path(&mut self, did: DefId)

source

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

source

fn visit_mod_contents(&mut self, def_id: LocalDefId, 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.
source

fn maybe_inline_local( &mut self, def_id: LocalDefId, 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.

source

fn reexport_public_and_not_hidden( &self, import_def_id: LocalDefId, target_def_id: LocalDefId ) -> bool

Returns true if the item is visible, meaning it’s not #[doc(hidden)] or private.

This function takes into account the entire re-export use chain, so it needs the ID of the “leaf” use and the ID of the “root” item.

source

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

source

fn visit_item_inner( &mut self, item: &'tcx Item<'_>, renamed: Option<Symbol>, import_id: Option<LocalDefId> )

source

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

source

fn enter_mod( &mut self, id: LocalDefId, m: &'tcx Mod<'tcx>, name: Symbol, renamed: Option<Symbol>, import_id: Option<LocalDefId> )

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 the list of modules of the current module.

Trait Implementations§

source§

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. Read more
source§

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.
source§

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.
source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

§

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

§

type Result = ()

The result type of the visit_* methods. Can be either (), or ControlFlow<T>.
source§

fn visit_nested_item(&mut self, id: ItemId) -> Self::Result

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 at rustc_hir::intravisit. 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.
source§

fn visit_nested_trait_item(&mut self, id: TraitItemId) -> Self::Result

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

fn visit_nested_impl_item(&mut self, id: ImplItemId) -> Self::Result

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

fn visit_nested_foreign_item(&mut self, id: ForeignItemId) -> Self::Result

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

fn visit_nested_body(&mut self, id: BodyId) -> Self::Result

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

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

source§

fn visit_id(&mut self, _hir_id: HirId) -> Self::Result

source§

fn visit_name(&mut self, _name: Symbol) -> Self::Result

source§

fn visit_ident(&mut self, ident: Ident) -> Self::Result

source§

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

source§

fn visit_local(&mut self, l: &'v LetStmt<'v>) -> Self::Result

source§

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

source§

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

source§

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

source§

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

source§

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

source§

fn visit_array_length(&mut self, len: &'v ArrayLen<'v>) -> Self::Result

source§

fn visit_anon_const(&mut self, c: &'v AnonConst) -> Self::Result

source§

fn visit_inline_const(&mut self, c: &'v ConstBlock) -> Self::Result

source§

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

source§

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

source§

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

source§

fn visit_pattern_type_pattern(&mut self, _p: &'v Pat<'v>)

source§

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

source§

fn visit_const_param_default( &mut self, _param: HirId, ct: &'v AnonConst ) -> Self::Result

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

fn visit_trait_item_ref(&mut self, ii: &'v TraitItemRef) -> Self::Result

source§

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

source§

fn visit_foreign_item_ref(&mut self, ii: &'v ForeignItemRef) -> Self::Result

source§

fn visit_impl_item_ref(&mut self, ii: &'v ImplItemRef) -> Self::Result

source§

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

source§

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

source§

fn visit_precise_capturing_arg( &mut self, arg: &'v PreciseCapturingArg<'v> ) -> Self::Result

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

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

source§

fn visit_attribute(&mut self, _attr: &'v Attribute) -> Self::Result

source§

fn visit_associated_item_kind( &mut self, kind: &'v AssocItemKind ) -> Self::Result

source§

fn visit_defaultness(&mut self, defaultness: &'v Defaultness) -> Self::Result

source§

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

Auto Trait Implementations§

§

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

§

impl<'a, 'tcx> !RefUnwindSafe for RustdocVisitor<'a, 'tcx>

§

impl<'a, 'tcx> !Send for RustdocVisitor<'a, 'tcx>

§

impl<'a, 'tcx> !Sync for RustdocVisitor<'a, 'tcx>

§

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

§

impl<'a, 'tcx> !UnwindSafe for RustdocVisitor<'a, 'tcx>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

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