Module rustdoc::clean[src]

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

Structs

Argument
Arguments
BareFunctionDecl
ClosureDecl
Crate
Enum
ExternalCrate
FnDecl
Function
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
Macro
Method
Module
Path
PathSegment
Span
Static
Struct
Trait
TyMethod
TyParam
Typedef
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.

ViewItem
ViewListIdent

Enums

Attribute
ItemEnum
Mutability
Primitive
RetStyle
SelfTy
StructField
TraitMethod
TyParamBound
Type

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

TypeKind
VariantKind
ViewItemInner
ViewPath

Statics

pub static SCHEMA_VERSION: &'static str = "0.8.3"

A stable identifier to the particular version of JSON output. Increment this when the Crate and related structures change.

 

Traits

Clean
ToSource

Type Definitions

Visibility