Module rustdoc::clean::types[][src]

Structs

Argument
Arguments
Attributes

The attributes on an Item, including attributes like #[derive(...)] and #[inline], as well as doc comments.

BareFunctionDecl
Constant
Crate
DocFragment

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

Enum
ExternalCrate
FnDecl
Function
GenericParamDef
Generics
Impl
Import
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.

ItemLink

A link that has not yet been rendered.

Lifetime
ListAttributesIter
Macro
Module
OpaqueTy
Path
PathSegment
PolyTrait

A trait reference, which may have higher ranked lifetimes.

ProcMacro
RenderedLink
Span

Small wrapper around [rustc_span::Span] that adds helper methods and enforces calling rustc_span::Span::source_callsite().

Static
Struct
Trait
TraitAlias
TraitWithExtraInfo

This struct is used to wrap additional information added by rustdoc on a trait item.

TypeBinding

An type binding on an associated type (e.g., A = Bar in Foo<A = Bar> or A: Send + Sync in Foo<A: Send + Sync>).

Typedef
Union
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

ConstantKind
DocFragmentKind
FakeDefId
FnRetTy
GenericArg
GenericArgs
GenericBound
GenericParamDefKind
ImportKind
ItemKind
PrimitiveType

N.B. this has to be different from hir::PrimTy because it also includes types that aren’t paths, like Unit.

SelfTy
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.

TypeBindingKind
Variant
Visibility
WherePredicate

Traits

AttributesExt
GetDefId
NestedAttributesExt

Functions

add_doc_fragment
rustc_span

Type Definitions

FakeDefIdSet