Crate rustdoc_json_types

Rustdoc’s JSON output interface

These types are the public API exposed through the --output-format json flag. The Crate struct is the root of the JSON blob and all other items are contained within.

Structs

• Constant
  A constant.
• Crate
  The root of the emitted JSON blob.
• Deprecation
  Information about the deprecation of an Item.
• Discriminant
  The value that distinguishes a variant in an Enum from other variants.
• DynTrait
  Dynamic trait object type (dyn Trait).
• Enum
  An enum.
• ExternalCrate
  Metadata of a crate, either the same crate on which rustdoc was invoked, or its dependency.
• FnDecl
  The signature of a function.
• Function
  A function declaration (including methods and other associated functions).
• FunctionPointer
  A type that is a function pointer.
• GenericParamDef
  One generic parameter accepted by an item.
• Generics
  Generic parameters accepted by an item and where clauses imposed on it and the parameters.
• Header
  A set of fundamental properties of a function.
• Id
  An opaque identifier for an item.
• Impl
  An impl block.
• Import
  A use statement.
• Item
  Anything that can hold documentation - modules, structs, enums, functions, traits, etc.
• ItemSummary
  Information about an external (not defined in the local crate) Item.
• Module
  A module declaration, e.g. mod foo; or mod foo {}.
• Path
  A type that has a simple path to it. This is the kind of type of structs, unions, enums, etc.
• PolyTrait
  A trait and potential HRTBs
• Primitive
  A primitive type declaration. Declarations of this kind can only come from the core library.
• ProcMacro
  A procedural macro.
• Span
  A range of source code.
• Static
  A static declaration.
• Struct
  A struct.
• Trait
  A trait declaration.
• TraitAlias
  A trait alias declaration, e.g. trait Int = Add + Sub + Mul + Div;
• TypeAlias
  A type alias declaration, e.g. type Pig = std::borrow::Cow<'static, str>;
• TypeBinding
  Describes a bound applied to an associated type/constant.
• Union
  A union.
• Variant
  A variant of an enum.

Enums

• Abi
  The ABI (Application Binary Interface) used by a function.
• GenericArg
  One argument in a list of generic arguments to a path segment.
• GenericArgs
  A set of generic arguments provided to a path segment, e.g.
• GenericBound
  Either a trait bound or a lifetime bound.
• GenericParamDefKind
  The kind of a GenericParamDef.
• ItemEnum
  Specific fields of an item.
• ItemKind
  The fundamental kind of an item. Unlike ItemEnum, this does not carry any aditional info.
• MacroKind
  The way a ProcMacro is declared to be used.
• StructKind
  The kind of a Struct and the data specific to it, i.e. fields.
• Term
  Either a type or a constant, usually stored as the right-hand side of an equation in places like TypeBinding
• TraitBoundModifier
  A set of modifiers applied to a trait.
• Type
  A type.
• TypeBindingKind
  The way in which an associate type/constant is bound.
• VariantKind
  The kind of an Enum Variant and the data specific to it, i.e. fields.
• Visibility
  Visibility of an Item.
• WherePredicate
  One where clause.

Constants

• FORMAT_VERSION
  The version of JSON output that this crate represents.

Type Aliases

• FxHashMap
  Type alias for a hashmap using the fx hash algorithm.