Expand description
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
- Crate
- A
Crateis the root of the emitted JSON blob. It contains all type/documentation information about the language items in the local crate, as well as info about external items to allow tools to find or link to them. - Deprecation
- Enum
- External
Crate - FnDecl
- Function
- Function
Pointer - Generic
Param Def - Generics
- Id
- Impl
- Import
- Item
- Item
Summary - For external (not defined in the local crate) items, you don’t get the same level of information. This struct should contain enough to generate a link/reference to the item in question, or can be used by a tool that takes the json output of multiple crates to find the actual item definition with all the relevant info.
- Method
- Module
- Opaque
Ty - Proc
Macro - Span
- Static
- Struct
- Trait
- Trait
Alias - Type
Binding - Typedef
- Union
Enums§
- Generic
Arg - Generic
Args - Generic
Bound - Generic
Param DefKind - Item
Enum - Item
Kind - Macro
Kind - Qualifiers
- Struct
Type - Trait
Bound Modifier - Type
- Type
Binding Kind - Variant
- Visibility
- Where
Predicate
Constants§
- FORMAT_
VERSION - rustdoc format-version.