1 //! Rustdoc's JSON output interface
3 //! These types are the public API exposed through the `--output-format json` flag. The [`Crate`]
4 //! struct is the root of the JSON blob and all other items are contained within.
6 use std::collections::HashMap;
7 use std::path::PathBuf;
9 use serde::{Deserialize, Serialize};
11 /// rustdoc format-version.
12 pub const FORMAT_VERSION: u32 = 20;
14 /// A `Crate` is the root of the emitted JSON blob. It contains all type/documentation information
15 /// about the language items in the local crate, as well as info about external items to allow
16 /// tools to find or link to them.
17 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
19 /// The id of the root [`Module`] item of the local crate.
21 /// The version string given to `--crate-version`, if any.
22 pub crate_version: Option<String>,
23 /// Whether or not the output includes private items.
24 pub includes_private: bool,
25 /// A collection of all items in the local crate as well as some external traits and their
26 /// items that are referenced locally.
27 pub index: HashMap<Id, Item>,
28 /// Maps IDs to fully qualified paths and other info helpful for generating links.
29 pub paths: HashMap<Id, ItemSummary>,
30 /// Maps `crate_id` of items to a crate name and html_root_url if it exists.
31 pub external_crates: HashMap<u32, ExternalCrate>,
32 /// A single version number to be used in the future when making backwards incompatible changes
33 /// to the JSON output.
34 pub format_version: u32,
37 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
38 pub struct ExternalCrate {
40 pub html_root_url: Option<String>,
43 /// For external (not defined in the local crate) items, you don't get the same level of
44 /// information. This struct should contain enough to generate a link/reference to the item in
45 /// question, or can be used by a tool that takes the json output of multiple crates to find
46 /// the actual item definition with all the relevant info.
47 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
48 pub struct ItemSummary {
49 /// Can be used to look up the name and html_root_url of the crate this item came from in the
50 /// `external_crates` map.
52 /// The list of path components for the fully qualified path of this item (e.g.
53 /// `["std", "io", "lazy", "Lazy"]` for `std::io::lazy::Lazy`).
54 pub path: Vec<String>,
55 /// Whether this item is a struct, trait, macro, etc.
59 #[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
61 /// The unique identifier of this item. Can be used to find this item in various mappings.
63 /// This can be used as a key to the `external_crates` map of [`Crate`] to see which crate
64 /// this item came from.
66 /// Some items such as impls don't have names.
67 pub name: Option<String>,
68 /// The source location of this item (absent if it came from a macro expansion or inline
70 pub span: Option<Span>,
71 /// By default all documented items are public, but you can tell rustdoc to output private items
72 /// so this field is needed to differentiate.
73 pub visibility: Visibility,
74 /// The full markdown docstring of this item. Absent if there is no documentation at all,
75 /// Some("") if there is some documentation but it is empty (EG `#[doc = ""]`).
76 pub docs: Option<String>,
77 /// This mapping resolves [intra-doc links](https://github.com/rust-lang/rfcs/blob/master/text/1946-intra-rustdoc-links.md) from the docstring to their IDs
78 pub links: HashMap<String, Id>,
79 /// Stringified versions of the attributes on this item (e.g. `"#[inline]"`)
80 pub attrs: Vec<String>,
81 pub deprecation: Option<Deprecation>,
86 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
88 /// The path to the source file for this span relative to the path `rustdoc` was invoked with.
89 pub filename: PathBuf,
90 /// Zero indexed Line and Column of the first character of the `Span`
91 pub begin: (usize, usize),
92 /// Zero indexed Line and Column of the last character of the `Span`
93 pub end: (usize, usize),
96 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
97 pub struct Deprecation {
98 pub since: Option<String>,
99 pub note: Option<String>,
102 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
103 #[serde(rename_all = "snake_case")]
104 pub enum Visibility {
106 /// For the most part items are private by default. The exceptions are associated items of
107 /// public traits and variants of public enums.
110 /// For `pub(in path)` visibility. `parent` is the module it's restricted to and `path` is how
111 /// that module was referenced (like `"super::super"` or `"crate::foo::bar"`).
118 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
119 pub struct DynTrait {
120 /// All the traits implemented. One of them is the vtable, and the rest must be auto traits.
121 pub traits: Vec<PolyTrait>,
122 /// The lifetime of the whole dyn object
124 /// dyn Debug + 'static
129 pub lifetime: Option<String>,
132 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
133 /// A trait and potential HRTBs
134 pub struct PolyTrait {
135 #[serde(rename = "trait")]
137 /// Used for Higher-Rank Trait Bounds (HRTBs)
139 /// dyn for<'a> Fn() -> &'a i32"
144 pub generic_params: Vec<GenericParamDef>,
147 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
148 #[serde(rename_all = "snake_case")]
149 pub enum GenericArgs {
150 /// <'a, 32, B: Copy, C = u32>
151 AngleBracketed { args: Vec<GenericArg>, bindings: Vec<TypeBinding> },
153 Parenthesized { inputs: Vec<Type>, output: Option<Type> },
156 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
157 #[serde(rename_all = "snake_case")]
158 pub enum GenericArg {
165 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
166 pub struct Constant {
167 #[serde(rename = "type")]
170 pub value: Option<String>,
171 pub is_literal: bool,
174 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
175 pub struct TypeBinding {
177 pub args: GenericArgs,
178 pub binding: TypeBindingKind,
181 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
182 #[serde(rename_all = "snake_case")]
183 pub enum TypeBindingKind {
185 Constraint(Vec<GenericBound>),
188 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
189 pub struct Id(pub String);
191 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
192 #[serde(rename_all = "snake_case")]
221 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
222 #[serde(tag = "kind", content = "inner", rename_all = "snake_case")]
227 rename: Option<String>,
240 TraitAlias(TraitAlias),
250 /// `type`s from an extern block
253 /// Declarative macro_rules! macro
255 ProcMacro(ProcMacro),
257 PrimitiveType(String),
260 #[serde(rename = "type")]
262 /// e.g. `const X: usize = 5;`
263 default: Option<String>,
267 bounds: Vec<GenericBound>,
268 /// e.g. `type X = usize;`
269 default: Option<Type>,
273 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
277 /// If `true`, this module is not part of the public API, but it contains
278 /// items that are re-exported as public API.
279 pub is_stripped: bool,
282 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
284 pub generics: Generics,
285 pub fields_stripped: bool,
290 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
292 pub struct_type: StructType,
293 pub generics: Generics,
294 pub fields_stripped: bool,
299 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
301 pub generics: Generics,
302 pub variants_stripped: bool,
303 pub variants: Vec<Id>,
307 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
308 #[serde(rename_all = "snake_case")]
309 #[serde(tag = "variant_kind", content = "variant_inner")]
311 /// A variant with no parentheses, and possible discriminant.
316 /// PlainWithDiscriminant = 1,
319 Plain(Option<Discriminant>),
320 /// A variant with unnamed fields.
322 /// Unlike most of json, `#[doc(hidden)]` fields will be given as `None`
323 /// instead of being ommited, because order matters.
327 /// TupleVariant(i32),
328 /// EmptyTupleVariant(),
331 Tuple(Vec<Option<Id>>),
332 /// A variant with named fields.
336 /// StructVariant { x: i32 },
337 /// EmptyStructVariant {},
340 Struct { fields: Vec<Id>, fields_stripped: bool },
343 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
344 pub struct Discriminant {
345 /// The expression that produced the discriminant.
347 /// Unlike `value`, this preserves the original formatting (eg suffixes,
348 /// hexadecimal, and underscores), making it unsuitable to be machine
351 /// In some cases, when the value is to complex, this may be `"{ _ }"`.
352 /// When this occurs is unstable, and may change without notice.
354 /// The numerical value of the discriminant. Stored as a string due to
355 /// JSON's poor support for large integers, and the fact that it would need
356 /// to store from [`i128::MIN`] to [`u128::MAX`].
360 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
361 #[serde(rename_all = "snake_case")]
362 pub enum StructType {
368 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
370 #[serde(rename = "const")]
372 #[serde(rename = "unsafe")]
374 #[serde(rename = "async")]
379 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
381 // We only have a concrete listing here for stable ABI's because their are so many
382 // See rustc_ast_passes::feature_gate::PostExpansionVisitor::check_abi for the list
385 Cdecl { unwind: bool },
386 Stdcall { unwind: bool },
387 Fastcall { unwind: bool },
388 Aapcs { unwind: bool },
389 Win64 { unwind: bool },
390 SysV64 { unwind: bool },
391 System { unwind: bool },
395 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
396 pub struct Function {
398 pub generics: Generics,
402 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
405 pub generics: Generics,
410 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
411 pub struct Generics {
412 pub params: Vec<GenericParamDef>,
413 pub where_predicates: Vec<WherePredicate>,
416 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
417 pub struct GenericParamDef {
419 pub kind: GenericParamDefKind,
422 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
423 #[serde(rename_all = "snake_case")]
424 pub enum GenericParamDefKind {
426 outlives: Vec<String>,
429 bounds: Vec<GenericBound>,
430 default: Option<Type>,
431 /// This is normally `false`, which means that this generic parameter is
432 /// declared in the Rust source text.
434 /// If it is `true`, this generic parameter has been introduced by the
435 /// compiler behind the scenes.
441 /// ```ignore (pseudo-rust)
442 /// pub fn f(_: impl Trait) {}
445 /// The compiler will transform this behind the scenes to
447 /// ```ignore (pseudo-rust)
448 /// pub fn f<impl Trait: Trait>(_: impl Trait) {}
451 /// In this example, the generic parameter named `impl Trait` (and which
452 /// is bound by `Trait`) is synthetic, because it was not originally in
453 /// the Rust source text.
457 #[serde(rename = "type")]
459 default: Option<String>,
463 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
464 #[serde(rename_all = "snake_case")]
465 pub enum WherePredicate {
467 #[serde(rename = "type")]
469 bounds: Vec<GenericBound>,
470 /// Used for Higher-Rank Trait Bounds (HRTBs)
472 /// where for<'a> &'a T: Iterator,"
477 generic_params: Vec<GenericParamDef>,
481 bounds: Vec<GenericBound>,
489 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
490 #[serde(rename_all = "snake_case")]
491 pub enum GenericBound {
493 #[serde(rename = "trait")]
495 /// Used for Higher-Rank Trait Bounds (HRTBs)
497 /// where F: for<'a, 'b> Fn(&'a u8, &'b u8)
502 generic_params: Vec<GenericParamDef>,
503 modifier: TraitBoundModifier,
508 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
509 #[serde(rename_all = "snake_case")]
510 pub enum TraitBoundModifier {
516 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
517 #[serde(rename_all = "snake_case")]
523 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
524 #[serde(rename_all = "snake_case")]
525 #[serde(tag = "kind", content = "inner")]
527 /// Structs, enums, and traits
530 /// Parameterized types
532 /// Fixed-size numeric types (plus int/usize/float), char, arrays, slices, and tuples
534 /// `extern "ABI" fn`
535 FunctionPointer(Box<FunctionPointer>),
536 /// `(String, u32, Box<usize>)`
542 #[serde(rename = "type")]
546 /// `impl TraitA + TraitB + ...`
547 ImplTrait(Vec<GenericBound>),
550 /// `*mut u32`, `*u8`, etc.
553 #[serde(rename = "type")]
556 /// `&'a mut String`, `&str`, etc.
558 lifetime: Option<String>,
560 #[serde(rename = "type")]
563 /// `<Type as Trait>::Name` or associated types like `T::Item` where `T: Iterator`
566 args: Box<GenericArgs>,
567 self_type: Box<Type>,
568 #[serde(rename = "trait")]
573 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
577 /// Generic arguments to the type
579 /// std::borrow::Cow<'static, str>
584 pub args: Option<Box<GenericArgs>>,
587 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
588 pub struct FunctionPointer {
590 /// Used for Higher-Rank Trait Bounds (HRTBs)
592 /// for<'c> fn(val: &'c i32) -> i32
597 pub generic_params: Vec<GenericParamDef>,
601 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
603 pub inputs: Vec<(String, Type)>,
604 pub output: Option<Type>,
605 pub c_variadic: bool,
608 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
613 pub generics: Generics,
614 pub bounds: Vec<GenericBound>,
615 pub implementations: Vec<Id>,
618 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
619 pub struct TraitAlias {
620 pub generics: Generics,
621 pub params: Vec<GenericBound>,
624 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
627 pub generics: Generics,
628 pub provided_trait_methods: Vec<String>,
629 #[serde(rename = "trait")]
630 pub trait_: Option<Path>,
631 #[serde(rename = "for")]
636 pub blanket_impl: Option<Type>,
639 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
640 #[serde(rename_all = "snake_case")]
642 /// The full path being imported.
644 /// May be different from the last segment of `source` when renaming imports:
645 /// `use source as name;`
647 /// The ID of the item being imported. Will be `None` in case of re-exports of primitives:
649 /// pub use i32 as my_i32;
652 /// Whether this import uses a glob: `use source::*;`
656 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
657 pub struct ProcMacro {
659 pub helpers: Vec<String>,
662 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
663 #[serde(rename_all = "snake_case")]
665 /// A bang macro `foo!()`.
667 /// An attribute macro `#[foo]`.
669 /// A derive macro `#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]`
673 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
675 #[serde(rename = "type")]
677 pub generics: Generics,
680 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
681 pub struct OpaqueTy {
682 pub bounds: Vec<GenericBound>,
683 pub generics: Generics,
686 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
688 #[serde(rename = "type")]