Module rustdoc::clean

This module contains the “cleaned” pieces of the AST, and the functions that clean them.

Modules

• auto_trait 🔒
• blanket_impl 🔒
• cfg 🔒
  The representation of a #[doc(cfg(...))] attribute.
• inline 🔒
  Support for inlining external documentation into the current AST.
• render_macro_matchers 🔒
• simplify 🔒
  Simplification of where-clauses and parameter bounds into a prettier and more canonical form.
• types 🔒
• utils 🔒

Structs

• OneLevelVisitor 🔒
  This visitor is used to find an HIR Item based on its use path. This doesn’t use the ordinary name resolver because it does not walk all the way through a chain of re-exports.

Enums

• FunctionArgs 🔒

Statics

• CALLSITE 🔒
• CALLSITE 🔒
• CALLSITE 🔒
• CALLSITE 🔒
• CALLSITE 🔒
• CALLSITE 🔒
• META 🔒
• META 🔒
• META 🔒
• META 🔒
• META 🔒
• META 🔒

Functions

• add_without_unwanted_attributes 🔒
  When inlining items, we merge its attributes (and all the reexports attributes too) with the final reexport. For example:
• clean_args_from_types_and_body_id 🔒
• clean_args_from_types_and_names 🔒
• clean_bare_fn_ty 🔒
• clean_const 🔒
• clean_doc_module 🔒
• clean_extern_crate 🔒
• clean_field 🔒
• clean_field_with_def_id 🔒
• clean_fn_decl_from_did_and_sig 🔒
• clean_fn_decl_legacy_const_generics 🔒
  This is needed to make it more “readable” when documenting functions using rustc_legacy_const_generics. More information in https://github.com/rust-lang/rust/issues/83167.
• clean_fn_decl_with_args 🔒
• clean_fn_or_proc_macro 🔒
• clean_function 🔒
• clean_generic_args 🔒
• clean_generic_bound 🔒
• clean_generic_param 🔒
• clean_generic_param_def 🔒
• clean_generics 🔒
• clean_hir_term 🔒
• clean_impl 🔒
• clean_impl_item 🔒
• clean_lifetime 🔒
• clean_maybe_renamed_foreign_item 🔒
• clean_maybe_renamed_item 🔒
• clean_middle_assoc_item 🔒
• clean_middle_const 🔒
• clean_middle_field 🔒
• clean_middle_opaque_bounds 🔒
• clean_middle_region 🔒
• clean_middle_term 🔒
• clean_middle_ty 🔒
• clean_path 🔒
• clean_path_segment 🔒
• clean_poly_trait_predicate 🔒
• clean_poly_trait_ref 🔒
• clean_poly_trait_ref_with_bindings 🔒
• clean_predicate 🔒
• clean_projection 🔒
• clean_projection_predicate 🔒
• clean_qpath 🔒
• clean_region_outlives_predicate 🔒
• clean_trait_item 🔒
• clean_trait_ref 🔒
• clean_trait_ref_with_bindings 🔒
• clean_ty 🔒
• clean_ty_generics 🔒
• clean_type_binding 🔒
• clean_type_outlives_predicate 🔒
• clean_use_statement 🔒
• clean_use_statement_inner 🔒
• clean_variant 🔒
• clean_variant_data 🔒
• clean_variant_def 🔒
• clean_where_predicate 🔒
• compute_should_show_cast 🔒
• filter_tokens_from_list 🔒
• get_all_import_attributes 🔒
  Because a Use item directly links to the imported item, we need to manually go through each import one by one. To do so, we go to the parent item and look for the Ident into it. Then, if we found the “end item” (the imported one), we stop there because we don’t need its documentation. Otherwise, we repeat the same operation until we find the “end item”.
• get_path_parent_def_id 🔒
  Get DefId of of an item’s user-visible parent.
• is_elided_lifetime 🔒
  This can happen for async fn, e.g. async fn f<'_>(&'_ self).
• is_impl_trait 🔒
  Synthetic type-parameters are inserted after normal ones. In order for normal parameters to be able to refer to synthetic ones, scans them first.
• maybe_expand_private_type_alias 🔒
• normalize 🔒
  Returns None if the type could not be normalized
• param_eq_arg 🔒
• projection_to_path_segment 🔒