[][src]Module rustdoc::clean

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

Re-exports

pub use self::Type::*;
pub use self::Mutability::*;
pub use self::ItemEnum::*;
pub use self::SelfTy::*;
pub use self::FunctionRetTy::*;
pub use self::Visibility::Public;
pub use self::Visibility::Inherited;

Modules

auto_trait
blanket_impl
cfg

Representation of a #[doc(cfg(...))] attribute.

def_ctor
inline

Support for inlining external documentation into the current AST.

simplify

Simplification of where clauses and parameter bounds into a prettier and more canonical form.

Structs

Argument
Arguments
Attributes
BareFunctionDecl
Constant
Crate
Deprecation
Enum
Existential
ExternalCrate
FnDecl
Function
GenericParamDef
Generics
Impl
ImportSource
Item

Anything with a source location and set of attributes and, optionally, a name. That is, anything that can be documented. This doesn't correspond directly to the AST's concept of an item; it's a strict superset.

Lifetime
ListAttributesIter
Macro
Method
Module
Path
PathSegment
PolyTrait

A trait reference, which may have higher ranked lifetimes.

RegionDeps
Span
Stability
Static
Struct
Trait
TyMethod
TypeBinding

An equality constraint on an associated type, e.g. A=Bar in Foo<A=Bar>

Typedef
Union
Variant
VariantStruct

This is a more limited form of the standard Struct, different in that it lacks the things most items have (name, id, parameterization). Found only as a variant in an enum.

Enums

AutoTraitResult
DocFragment

A portion of documentation, extracted from a #[doc] attribute.

FunctionRetTy
GenericArgs
GenericBound
GenericParamDefKind
ImplPolarity
Import
ItemEnum
Mutability
PrimitiveType
RegionTarget
SelfTy
SimpleBound
Type

A representation of a Type suitable for hyperlinking purposes. Ideally one can get the original type out of the AST/TyCtxt given one of these, if more information is needed. Most importantly it does not preserve mutability or boxes.

TypeKind
VariantKind
Visibility
WherePredicate

Constants

FN_OUTPUT_NAME
MAX_DEF_ID

Traits

AttributesExt
Clean
GetDefId
NestedAttributesExt
ToSource

Functions

build_deref_target_impls
def_id_to_path
enter_impl_trait
external_generic_args
external_path
get_auto_traits_with_def_id
get_auto_traits_with_node_id
get_blanket_impls_with_def_id
get_blanket_impls_with_node_id
get_deprecation
get_path_for_type
get_stability
name_from_pat
path_to_def
path_to_def_local
print_const
print_const_expr
qpath_to_string
register_def
resolve_type

Given a type Path, resolve it to a Type using the TyCtxt

resolve_use_source
strip_path
strip_type