Module rustdoc::clean [] [src]

🔬 This is a nightly-only experimental API. (rustdoc)

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

Reexports

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

Modules

inline [
Experimental
]

Support for inlining external documentation into the current AST.

Structs

Argument [
Experimental
]
Arguments [
Experimental
]
Attributes [
Experimental
]
BareFunctionDecl [
Experimental
]
Constant [
Experimental
]
Crate [
Experimental
]
DefaultImpl [
Experimental
]
Deprecation [
Experimental
]
Enum [
Experimental
]
ExternalCrate [
Experimental
]
FnDecl [
Experimental
]
Function [
Experimental
]
Generics [
Experimental
]
Impl [
Experimental
]
ImportSource [
Experimental
]
Item [
Experimental
]

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 [
Experimental
]
ListAttributesIter [
Experimental
]
Macro [
Experimental
]
Method [
Experimental
]
Module [
Experimental
]
Path [
Experimental
]
PathSegment [
Experimental
]
PolyTrait [
Experimental
]

A trait reference, which may have higher ranked lifetimes.

Span [
Experimental
]
Stability [
Experimental
]
Static [
Experimental
]
Struct [
Experimental
]
Trait [
Experimental
]
TyMethod [
Experimental
]
TyParam [
Experimental
]
TypeBinding [
Experimental
]

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

Typedef [
Experimental
]
Union [
Experimental
]
Variant [
Experimental
]
VariantStruct [
Experimental
]

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

FunctionRetTy [
Experimental
]
ImplPolarity [
Experimental
]
Import [
Experimental
]
ItemEnum [
Experimental
]
Mutability [
Experimental
]
PathParameters [
Experimental
]
PrimitiveType [
Experimental
]
SelfTy [
Experimental
]
TyParamBound [
Experimental
]
Type [
Experimental
]

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 [
Experimental
]
VariantKind [
Experimental
]
Visibility [
Experimental
]
WherePredicate [
Experimental
]

Traits

AttributesExt [
Experimental
]
Clean [
Experimental
]
GetDefId [
Experimental
]
NestedAttributesExt [
Experimental
]