1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225
//! 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.
use std::path::PathBuf;
pub use rustc_hash::FxHashMap;
use serde::{Deserialize, Serialize};
/// The version of JSON output that this crate represents.
///
/// This integer is incremented with every breaking change to the API,
/// and is returned along with the JSON blob as [`Crate::format_version`].
/// Consuming code should assert that this value matches the format version(s) that it supports.
pub const FORMAT_VERSION: u32 = 33;
/// 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.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct Crate {
/// The id of the root [`Module`] item of the local crate.
pub root: Id,
/// The version string given to `--crate-version`, if any.
pub crate_version: Option<String>,
/// Whether or not the output includes private items.
pub includes_private: bool,
/// A collection of all items in the local crate as well as some external traits and their
/// items that are referenced locally.
pub index: FxHashMap<Id, Item>,
/// Maps IDs to fully qualified paths and other info helpful for generating links.
pub paths: FxHashMap<Id, ItemSummary>,
/// Maps `crate_id` of items to a crate name and html_root_url if it exists.
pub external_crates: FxHashMap<u32, ExternalCrate>,
/// A single version number to be used in the future when making backwards incompatible changes
/// to the JSON output.
pub format_version: u32,
}
/// Metadata of a crate, either the same crate on which `rustdoc` was invoked, or its dependency.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct ExternalCrate {
/// The name of the crate.
pub name: String,
/// The root URL at which the crate's documentation lives.
pub html_root_url: Option<String>,
}
/// Information about an external (not defined in the local crate) [`Item`].
///
/// For external 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.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct ItemSummary {
/// Can be used to look up the name and html_root_url of the crate this item came from in the
/// `external_crates` map.
pub crate_id: u32,
/// The list of path components for the fully qualified path of this item (e.g.
/// `["std", "io", "lazy", "Lazy"]` for `std::io::lazy::Lazy`).
///
/// Note that items can appear in multiple paths, and the one chosen is implementation
/// defined. Currently, this is the full path to where the item was defined. Eg
/// [`String`] is currently `["alloc", "string", "String"]` and [`HashMap`][`std::collections::HashMap`]
/// is `["std", "collections", "hash", "map", "HashMap"]`, but this is subject to change.
pub path: Vec<String>,
/// Whether this item is a struct, trait, macro, etc.
pub kind: ItemKind,
}
/// Anything that can hold documentation - modules, structs, enums, functions, traits, etc.
///
/// The `Item` data type holds fields that can apply to any of these,
/// and leaves kind-specific details (like function args or enum variants) to the `inner` field.
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)]
pub struct Item {
/// The unique identifier of this item. Can be used to find this item in various mappings.
pub id: Id,
/// This can be used as a key to the `external_crates` map of [`Crate`] to see which crate
/// this item came from.
pub crate_id: u32,
/// Some items such as impls don't have names.
pub name: Option<String>,
/// The source location of this item (absent if it came from a macro expansion or inline
/// assembly).
pub span: Option<Span>,
/// By default all documented items are public, but you can tell rustdoc to output private items
/// so this field is needed to differentiate.
pub visibility: Visibility,
/// The full markdown docstring of this item. Absent if there is no documentation at all,
/// Some("") if there is some documentation but it is empty (EG `#[doc = ""]`).
pub docs: Option<String>,
/// 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
pub links: FxHashMap<String, Id>,
/// Stringified versions of the attributes on this item (e.g. `"#[inline]"`)
pub attrs: Vec<String>,
/// Information about the item’s deprecation, if present.
pub deprecation: Option<Deprecation>,
/// The type-specific fields describing this item.
pub inner: ItemEnum,
}
/// A range of source code.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Span {
/// The path to the source file for this span relative to the path `rustdoc` was invoked with.
pub filename: PathBuf,
/// Zero indexed Line and Column of the first character of the `Span`
pub begin: (usize, usize),
/// Zero indexed Line and Column of the last character of the `Span`
pub end: (usize, usize),
}
/// Information about the deprecation of an [`Item`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Deprecation {
/// Usually a version number when this [`Item`] first became deprecated.
pub since: Option<String>,
/// The reason for deprecation and/or what alternatives to use.
pub note: Option<String>,
}
/// Visibility of an [`Item`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Visibility {
/// Explicitly public visibility set with `pub`.
Public,
/// For the most part items are private by default. The exceptions are associated items of
/// public traits and variants of public enums.
Default,
/// Explicitly crate-wide visibility set with `pub(crate)`
Crate,
/// For `pub(in path)` visibility.
Restricted {
/// ID of the module to which this visibility restricts items.
parent: Id,
/// The path with which [`parent`] was referenced
/// (like `super::super` or `crate::foo::bar`).
///
/// [`parent`]: Visibility::Restricted::parent
path: String,
},
}
/// Dynamic trait object type (`dyn Trait`).
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct DynTrait {
/// All the traits implemented. One of them is the vtable, and the rest must be auto traits.
pub traits: Vec<PolyTrait>,
/// The lifetime of the whole dyn object
/// ```text
/// dyn Debug + 'static
/// ^^^^^^^
/// |
/// this part
/// ```
pub lifetime: Option<String>,
}
/// A trait and potential HRTBs
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct PolyTrait {
/// The path to the trait.
#[serde(rename = "trait")]
pub trait_: Path,
/// Used for Higher-Rank Trait Bounds (HRTBs)
/// ```text
/// dyn for<'a> Fn() -> &'a i32"
/// ^^^^^^^
/// ```
pub generic_params: Vec<GenericParamDef>,
}
/// A set of generic arguments provided to a path segment, e.g.
///
/// ```text
/// std::option::Option::<u32>::None
/// ^^^^^
/// ```
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum GenericArgs {
/// `<'a, 32, B: Copy, C = u32>`
AngleBracketed {
/// The list of each argument on this type.
/// ```text
/// <'a, 32, B: Copy, C = u32>
/// ^^^^^^
/// ```
args: Vec<GenericArg>,
/// Associated type or constant bindings (e.g. `Item=i32` or `Item: Clone`) for this type.
bindings: Vec<TypeBinding>,
},
/// `Fn(A, B) -> C`
Parenthesized {
/// The input types, enclosed in parentheses.
inputs: Vec<Type>,
/// The output type provided after the `->`, if present.
output: Option<Type>,
},
}
/// One argument in a list of generic arguments to a path segment.
///
/// Part of [`GenericArgs`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum GenericArg {
/// A lifetime argument.
/// ```text
/// std::borrow::Cow<'static, str>
/// ^^^^^^^
/// ```
Lifetime(String),
/// A type argument.
/// ```text
/// std::borrow::Cow<'static, str>
/// ^^^
/// ```
Type(Type),
/// A constant as a generic argument.
/// ```text
/// core::array::IntoIter<u32, { 640 * 1024 }>
/// ^^^^^^^^^^^^^^
/// ```
Const(Constant),
/// A generic argument that's explicitly set to be inferred.
/// ```text
/// std::vec::Vec::<_>::new()
/// ^
/// ```
Infer,
}
/// A constant.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Constant {
/// The stringified expression of this constant. Note that its mapping to the original
/// source code is unstable and it's not guaranteed that it'll match the source code.
pub expr: String,
/// The value of the evaluated expression for this constant, which is only computed for numeric
/// types.
pub value: Option<String>,
/// Whether this constant is a bool, numeric, string, or char literal.
pub is_literal: bool,
}
/// Describes a bound applied to an associated type/constant.
///
/// Example:
/// ```text
/// IntoIterator<Item = u32, IntoIter: Clone>
/// ^^^^^^^^^^ ^^^^^^^^^^^^^^^
/// ```
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct TypeBinding {
/// The name of the associated type/constant.
pub name: String,
/// Arguments provided to the associated type/constant.
pub args: GenericArgs,
/// The kind of bound applied to the associated type/constant.
pub binding: TypeBindingKind,
}
/// The way in which an associate type/constant is bound.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TypeBindingKind {
/// The required value/type is specified exactly. e.g.
/// ```text
/// Iterator<Item = u32, IntoIter: DoubleEndedIterator>
/// ^^^^^^^^^^
/// ```
Equality(Term),
/// The type is required to satisfy a set of bounds.
/// ```text
/// Iterator<Item = u32, IntoIter: DoubleEndedIterator>
/// ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/// ```
Constraint(Vec<GenericBound>),
}
/// An opaque identifier for an item.
///
/// It can be used to lookup in [`Crate::index`] or [`Crate::paths`] to resolve it
/// to an [`Item`].
///
/// Id's are only valid within a single JSON blob. They cannot be used to
/// resolve references between the JSON output's for different crates.
///
/// Rustdoc makes no guarantees about the inner value of Id's. Applications
/// should treat them as opaque keys to lookup items, and avoid attempting
/// to parse them, or otherwise depend on any implementation details.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
// FIXME(aDotInTheVoid): Consider making this non-public in rustdoc-types.
pub struct Id(pub String);
/// The fundamental kind of an item. Unlike [`ItemEnum`], this does not carry any aditional info.
///
/// Part of [`ItemSummary`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ItemKind {
/// A module declaration, e.g. `mod foo;` or `mod foo {}`
Module,
/// A crate imported via the `extern crate` syntax.
ExternCrate,
/// An import of 1 or more items into scope, using the `use` keyword.
Import,
/// A `struct` declaration.
Struct,
/// A field of a struct.
StructField,
/// A `union` declaration.
Union,
/// An `enum` declaration.
Enum,
/// A variant of a enum.
Variant,
/// A function declaration, e.g. `fn f() {}`
Function,
/// A type alias declaration, e.g. `type Pig = std::borrow::Cow<'static, str>;`
TypeAlias,
/// The declaration of a constant, e.g. `const GREETING: &str = "Hi :3";`
Constant,
/// A `trait` declaration.
Trait,
/// A trait alias declaration, e.g. `trait Int = Add + Sub + Mul + Div;`
///
/// See [the tracking issue](https://github.com/rust-lang/rust/issues/41517)
TraitAlias,
/// An `impl` block.
Impl,
/// A `static` declaration.
Static,
/// `type`s from an `extern` block.
///
/// See [the tracking issue](https://github.com/rust-lang/rust/issues/43467)
ForeignType,
/// A macro declaration.
///
/// Corresponds to either `ItemEnum::Macro(_)`
/// or `ItemEnum::ProcMacro(ProcMacro { kind: MacroKind::Bang })`
Macro,
/// A procedural macro attribute.
///
/// Corresponds to `ItemEnum::ProcMacro(ProcMacro { kind: MacroKind::Attr })`
ProcAttribute,
/// A procedural macro usable in the `#[derive()]` attribute.
///
/// Corresponds to `ItemEnum::ProcMacro(ProcMacro { kind: MacroKind::Derive })`
ProcDerive,
/// An associated constant of a trait or a type.
AssocConst,
/// An associated type of a trait or a type.
AssocType,
/// A primitive type, e.g. `u32`.
///
/// [`Item`]s of this kind only come from the core library.
Primitive,
/// A keyword declaration.
///
/// [`Item`]s of this kind only come from the come library and exist solely
/// to carry documentation for the respective keywords.
Keyword,
}
/// Specific fields of an item.
///
/// Part of [`Item`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum ItemEnum {
/// A module declaration, e.g. `mod foo;` or `mod foo {}`
Module(Module),
/// A crate imported via the `extern crate` syntax.
ExternCrate {
/// The name of the imported crate.
name: String,
/// If the crate is renamed, this is its name in the crate.
rename: Option<String>,
},
/// An import of 1 or more items into scope, using the `use` keyword.
Import(Import),
/// A `union` declaration.
Union(Union),
/// A `struct` declaration.
Struct(Struct),
/// A field of a struct.
StructField(Type),
/// An `enum` declaration.
Enum(Enum),
/// A variant of a enum.
Variant(Variant),
/// A function declaration (including methods and other associated functions)
Function(Function),
/// A `trait` declaration.
Trait(Trait),
/// A trait alias declaration, e.g. `trait Int = Add + Sub + Mul + Div;`
///
/// See [the tracking issue](https://github.com/rust-lang/rust/issues/41517)
TraitAlias(TraitAlias),
/// An `impl` block.
Impl(Impl),
/// A type alias declaration, e.g. `type Pig = std::borrow::Cow<'static, str>;`
TypeAlias(TypeAlias),
/// The declaration of a constant, e.g. `const GREETING: &str = "Hi :3";`
Constant {
/// The type of the constant.
#[serde(rename = "type")]
type_: Type,
/// The declared constant itself.
#[serde(rename = "const")]
const_: Constant,
},
/// A declaration of a `static`.
Static(Static),
/// `type`s from an `extern` block.
///
/// See [the tracking issue](https://github.com/rust-lang/rust/issues/43467)
ForeignType,
/// A macro_rules! declarative macro. Contains a single string with the source
/// representation of the macro with the patterns stripped.
Macro(String),
/// A procedural macro.
ProcMacro(ProcMacro),
/// A primitive type, e.g. `u32`.
///
/// [`Item`]s of this kind only come from the core library.
Primitive(Primitive),
/// An associated constant of a trait or a type.
AssocConst {
/// The type of the constant.
#[serde(rename = "type")]
type_: Type,
/// The stringified expression for the default value, if provided, e.g.
/// ```rust
/// const X: usize = 640 * 1024;
/// // ^^^^^^^^^^
/// ```
default: Option<String>,
},
/// An associated type of a trait or a type.
AssocType {
/// The generic parameters and where clauses on ahis associated type.
generics: Generics,
/// The bounds for this associated type. e.g.
/// ```rust
/// trait IntoIterator {
/// type Item;
/// type IntoIter: Iterator<Item = Self::Item>;
/// // ^^^^^^^^^^^^^^^^^^^^^^^^^^^
/// }
/// ```
bounds: Vec<GenericBound>,
/// The default for this type, if provided, e.g.
/// ```rust
/// type X = usize;
/// // ^^^^^
/// ```
default: Option<Type>,
},
}
/// A module declaration, e.g. `mod foo;` or `mod foo {}`.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Module {
/// Whether this is the root item of a crate.
///
/// This item doesn't correspond to any construction in the source code and is generated by the
/// compiler.
pub is_crate: bool,
/// [`Item`]s declared inside this module.
pub items: Vec<Id>,
/// If `true`, this module is not part of the public API, but it contains
/// items that are re-exported as public API.
pub is_stripped: bool,
}
/// A `union`.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Union {
/// The generic parameters and where clauses on this union.
pub generics: Generics,
/// Whether any fields have been removed from the result, due to being private or hidden.
pub fields_stripped: bool,
/// The list of fields in the union.
///
/// All of the corresponding [`Item`]s are of kind [`ItemEnum::StructField`].
pub fields: Vec<Id>,
/// All impls (both of traits and inherent) for this union.
///
/// All of the corresponding [`Item`]s are of kind [`ItemEnum::Impl`].
pub impls: Vec<Id>,
}
/// A `struct`.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Struct {
/// The kind of the struct (e.g. unit, tuple-like or struct-like) and the data specific to it,
/// i.e. fields.
pub kind: StructKind,
/// The generic parameters and where clauses on this struct.
pub generics: Generics,
/// All impls (both of traits and inherent) for this struct.
/// All of the corresponding [`Item`]s are of kind [`ItemEnum::Impl`].
pub impls: Vec<Id>,
}
/// The kind of a [`Struct`] and the data specific to it, i.e. fields.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum StructKind {
/// A struct with no fields and no parentheses.
///
/// ```rust
/// pub struct Unit;
/// ```
Unit,
/// A struct with unnamed fields.
///
/// All [`Id`]'s will point to [`ItemEnum::StructField`].
/// Unlike most of JSON, private and `#[doc(hidden)]` fields will be given as `None`
/// instead of being omitted, because order matters.
///
/// ```rust
/// pub struct TupleStruct(i32);
/// pub struct EmptyTupleStruct();
/// ```
Tuple(Vec<Option<Id>>),
/// A struct with named fields.
///
/// ```rust
/// pub struct PlainStruct { x: i32 }
/// pub struct EmptyPlainStruct {}
/// ```
Plain {
/// The list of fields in the struct.
///
/// All of the corresponding [`Item`]s are of kind [`ItemEnum::StructField`].
fields: Vec<Id>,
/// Whether any fields have been removed from the result, due to being private or hidden.
fields_stripped: bool,
},
}
/// An `enum`.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Enum {
/// Information about the type parameters and `where` clauses of the enum.
pub generics: Generics,
/// Whether any variants have been removed from the result, due to being private or hidden.
pub variants_stripped: bool,
/// The list of variants in the enum.
///
/// All of the corresponding [`Item`]s are of kind [`ItemEnum::Variant`]
pub variants: Vec<Id>,
/// `impl`s for the enum.
pub impls: Vec<Id>,
}
/// A variant of an enum.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Variant {
/// Whether the variant is plain, a tuple-like, or struct-like. Contains the fields.
pub kind: VariantKind,
/// The discriminant, if explicitly specified.
pub discriminant: Option<Discriminant>,
}
/// The kind of an [`Enum`] [`Variant`] and the data specific to it, i.e. fields.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum VariantKind {
/// A variant with no parentheses
///
/// ```rust
/// enum Demo {
/// PlainVariant,
/// PlainWithDiscriminant = 1,
/// }
/// ```
Plain,
/// A variant with unnamed fields.
///
/// All [`Id`]'s will point to [`ItemEnum::StructField`].
/// Unlike most of JSON, `#[doc(hidden)]` fields will be given as `None`
/// instead of being omitted, because order matters.
///
/// ```rust
/// enum Demo {
/// TupleVariant(i32),
/// EmptyTupleVariant(),
/// }
/// ```
Tuple(Vec<Option<Id>>),
/// A variant with named fields.
///
/// ```rust
/// enum Demo {
/// StructVariant { x: i32 },
/// EmptyStructVariant {},
/// }
/// ```
Struct {
/// The list of variants in the enum.
/// All of the corresponding [`Item`]s are of kind [`ItemEnum::Variant`].
fields: Vec<Id>,
/// Whether any variants have been removed from the result, due to being private or hidden.
fields_stripped: bool,
},
}
/// The value that distinguishes a variant in an [`Enum`] from other variants.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Discriminant {
/// The expression that produced the discriminant.
///
/// Unlike `value`, this preserves the original formatting (eg suffixes,
/// hexadecimal, and underscores), making it unsuitable to be machine
/// interpreted.
///
/// In some cases, when the value is too complex, this may be `"{ _ }"`.
/// When this occurs is unstable, and may change without notice.
pub expr: String,
/// The numerical value of the discriminant. Stored as a string due to
/// JSON's poor support for large integers, and the fact that it would need
/// to store from [`i128::MIN`] to [`u128::MAX`].
pub value: String,
}
/// A set of fundamental properties of a function.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Header {
/// Is this function marked as `const`?
#[serde(rename = "const")]
pub const_: bool,
/// Is this function unsafe?
#[serde(rename = "unsafe")]
pub unsafe_: bool,
/// Is this function async?
#[serde(rename = "async")]
pub async_: bool,
/// The ABI used by the function.
pub abi: Abi,
}
/// The ABI (Application Binary Interface) used by a function.
///
/// If a variant has an `unwind` field, this means the ABI that it represents can be specified in 2
/// ways: `extern "_"` and `extern "_-unwind"`, and a value of `true` for that field signifies the
/// latter variant.
///
/// See the [Rustonomicon section](https://doc.rust-lang.org/nightly/nomicon/ffi.html#ffi-and-unwinding)
/// on unwinding for more info.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub enum Abi {
// We only have a concrete listing here for stable ABI's because their are so many
// See rustc_ast_passes::feature_gate::PostExpansionVisitor::check_abi for the list
/// The default ABI, but that can also be written explicitly with `extern "Rust"`.
Rust,
/// Can be specified as `extern "C"` or, as a shorthand, just `extern`.
C { unwind: bool },
/// Can be specified as `extern "cdecl"`.
Cdecl { unwind: bool },
/// Can be specified as `extern "stdcall"`.
Stdcall { unwind: bool },
/// Can be specified as `extern "fastcall"`.
Fastcall { unwind: bool },
/// Can be specified as `extern "aapcs"`.
Aapcs { unwind: bool },
/// Can be specified as `extern "win64"`.
Win64 { unwind: bool },
/// Can be specifed as `extern "sysv64"`.
SysV64 { unwind: bool },
/// Can be specified as `extern "system"`.
System { unwind: bool },
/// Any other ABI, including unstable ones.
Other(String),
}
/// A function declaration (including methods and other associated functions).
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Function {
/// Information about the function signature, or declaration.
pub decl: FnDecl,
/// Information about the function’s type parameters and `where` clauses.
pub generics: Generics,
/// Information about core properties of the function, e.g. whether it's `const`, its ABI, etc.
pub header: Header,
/// Whether the function has a body, i.e. an implementation.
pub has_body: bool,
}
/// Generic parameters accepted by an item and `where` clauses imposed on it and the parameters.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Generics {
/// A list of generic parameter definitions (e.g. `<T: Clone + Hash, U: Copy>`).
pub params: Vec<GenericParamDef>,
/// A list of where predicates (e.g. `where T: Iterator, T::Item: Copy`).
pub where_predicates: Vec<WherePredicate>,
}
/// One generic parameter accepted by an item.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct GenericParamDef {
/// Name of the parameter.
/// ```rust
/// fn f<'resource, Resource>(x: &'resource Resource) {}
/// // ^^^^^^^^ ^^^^^^^^
/// ```
pub name: String,
/// The kind of the parameter and data specific to a particular parameter kind, e.g. type
/// bounds.
pub kind: GenericParamDefKind,
}
/// The kind of a [`GenericParamDef`].
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum GenericParamDefKind {
/// Denotes a lifetime parameter.
Lifetime {
/// Lifetimes that this lifetime parameter is required to outlive.
///
/// ```rust
/// fn f<'a, 'b, 'resource: 'a + 'b>(a: &'a str, b: &'b str, res: &'resource str) {}
/// // ^^^^^^^
/// ```
outlives: Vec<String>,
},
/// Denotes a type parameter.
Type {
/// Bounds applied directly to the type. Note that the bounds from `where` clauses
/// that constrain this parameter won't appear here.
///
/// ```rust
/// fn default2<T: Default>() -> [T; 2] where T: Clone { todo!() }
/// // ^^^^^^^
/// ```
bounds: Vec<GenericBound>,
/// The default type for this parameter, if provided, e.g.
///
/// ```rust
/// trait PartialEq<Rhs = Self> {}
/// // ^^^^
/// ```
default: Option<Type>,
/// This is normally `false`, which means that this generic parameter is
/// declared in the Rust source text.
///
/// If it is `true`, this generic parameter has been introduced by the
/// compiler behind the scenes.
///
/// # Example
///
/// Consider
///
/// ```ignore (pseudo-rust)
/// pub fn f(_: impl Trait) {}
/// ```
///
/// The compiler will transform this behind the scenes to
///
/// ```ignore (pseudo-rust)
/// pub fn f<impl Trait: Trait>(_: impl Trait) {}
/// ```
///
/// In this example, the generic parameter named `impl Trait` (and which
/// is bound by `Trait`) is synthetic, because it was not originally in
/// the Rust source text.
synthetic: bool,
},
/// Denotes a constant parameter.
Const {
/// The type of the constant as declared.
#[serde(rename = "type")]
type_: Type,
/// The stringified expression for the default value, if provided. It's not guaranteed that
/// it'll match the actual source code for the default value.
default: Option<String>,
},
}
/// One `where` clause.
/// ```rust
/// fn default<T>() -> T where T: Default { T::default() }
/// // ^^^^^^^^^^
/// ```
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum WherePredicate {
/// A type is expected to comply with a set of bounds
BoundPredicate {
/// The type that's being constrained.
///
/// ```rust
/// fn f<T>(x: T) where for<'a> &'a T: Iterator {}
/// // ^
/// ```
#[serde(rename = "type")]
type_: Type,
/// The set of bounds that constrain the type.
///
/// ```rust
/// fn f<T>(x: T) where for<'a> &'a T: Iterator {}
/// // ^^^^^^^^
/// ```
bounds: Vec<GenericBound>,
/// Used for Higher-Rank Trait Bounds (HRTBs)
/// ```rust
/// fn f<T>(x: T) where for<'a> &'a T: Iterator {}
/// // ^^^^^^^
/// ```
generic_params: Vec<GenericParamDef>,
},
/// A lifetime is expected to outlive other lifetimes.
LifetimePredicate {
/// The name of the lifetime.
lifetime: String,
/// The lifetimes that must be encompassed by the lifetime.
outlives: Vec<String>,
},
/// A type must exactly equal another type.
EqPredicate {
/// The left side of the equation.
lhs: Type,
/// The right side of the equation.
rhs: Term,
},
}
/// Either a trait bound or a lifetime bound.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum GenericBound {
/// A trait bound.
TraitBound {
/// The full path to the trait.
#[serde(rename = "trait")]
trait_: Path,
/// Used for Higher-Rank Trait Bounds (HRTBs)
/// ```text
/// where F: for<'a, 'b> Fn(&'a u8, &'b u8)
/// ^^^^^^^^^^^
/// |
/// this part
/// ```
generic_params: Vec<GenericParamDef>,
/// The context for which a trait is supposed to be used, e.g. `const
modifier: TraitBoundModifier,
},
/// A lifetime bound, e.g.
/// ```rust
/// fn f<'a, T>(x: &'a str, y: &T) where T: 'a {}
/// // ^^^
/// ```
Outlives(String),
/// `use<'a, T>` precise-capturing bound syntax
Use(Vec<String>),
}
/// A set of modifiers applied to a trait.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum TraitBoundModifier {
/// Marks the absence of a modifier.
None,
/// Indicates that the trait bound relaxes a trait bound applied to a parameter by default,
/// e.g. `T: Sized?`, the `Sized` trait is required for all generic type parameters by default
/// unless specified otherwise with this modifier.
Maybe,
/// Indicates that the trait bound must be applicable in both a run-time and a compile-time
/// context.
MaybeConst,
}
/// Either a type or a constant, usually stored as the right-hand side of an equation in places like
/// [`TypeBinding`]
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Term {
/// A type.
///
/// ```rust
/// fn f(x: impl IntoIterator<Item = u32>) {}
/// // ^^^
/// ```
Type(Type),
/// A constant.
///
/// ```ignore (incomplete feature in the snippet)
/// trait Foo {
/// const BAR: usize;
/// }
///
/// fn f(x: impl Foo<BAR = 42>) {}
/// // ^^
/// ```
Constant(Constant),
}
/// A type.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum Type {
/// Structs, enums, unions and type aliases, e.g. `std::option::Option<u32>`
ResolvedPath(Path),
/// Dynamic trait object type (`dyn Trait`).
DynTrait(DynTrait),
/// Parameterized types. The contained string is the name of the parameter.
Generic(String),
/// Built-in numeric types (e.g. `u32`, `f32`), `bool`, `char`.
Primitive(String),
/// A function pointer type, e.g. `fn(u32) -> u32`, `extern "C" fn() -> *const u8`
FunctionPointer(Box<FunctionPointer>),
/// A tuple type, e.g. `(String, u32, Box<usize>)`
Tuple(Vec<Type>),
/// An unsized slice type, e.g. `[u32]`.
Slice(Box<Type>),
/// An array type, e.g. `[u32; 15]`
Array {
/// The type of the contained element.
#[serde(rename = "type")]
type_: Box<Type>,
/// The stringified expression that is the length of the array.
///
/// Keep in mind that it's not guaranteed to match the actual source code of the expression.
len: String,
},
/// A pattern type, e.g. `u32 is 1..`
///
/// See [the tracking issue](https://github.com/rust-lang/rust/issues/123646)
Pat {
/// The base type, e.g. the `u32` in `u32 is 1..`
#[serde(rename = "type")]
type_: Box<Type>,
#[doc(hidden)]
__pat_unstable_do_not_use: String,
},
/// An opaque type that satisfies a set of bounds, `impl TraitA + TraitB + ...`
ImplTrait(Vec<GenericBound>),
/// A type that's left to be inferred, `_`
Infer,
/// A raw pointer type, e.g. `*mut u32`, `*const u8`, etc.
RawPointer {
/// This is `true` for `*mut _` and `false` for `*const _`.
mutable: bool,
/// The type of the pointee.
#[serde(rename = "type")]
type_: Box<Type>,
},
/// `&'a mut String`, `&str`, etc.
BorrowedRef {
/// The name of the lifetime of the reference, if provided.
lifetime: Option<String>,
/// This is `true` for `&mut i32` and `false` for `&i32`
mutable: bool,
/// The type of the pointee, e.g. the `i32` in `&'a mut i32`
#[serde(rename = "type")]
type_: Box<Type>,
},
/// Associated types like `<Type as Trait>::Name` and `T::Item` where
/// `T: Iterator` or inherent associated types like `Struct::Name`.
QualifiedPath {
/// The name of the associated type in the parent type.
///
/// ```ignore (incomplete expresssion)
/// <core::array::IntoIter<u32, 42> as Iterator>::Item
/// // ^^^^
/// ```
name: String,
/// The generic arguments provided to the associated type.
///
/// ```ignore (incomplete expression)
/// <core::slice::IterMut<'static, u32> as BetterIterator>::Item<'static>
/// // ^^^^^^^^^
/// ```
args: Box<GenericArgs>,
/// The type with which this type is associated.
///
/// ```ignore (incomplete expression)
/// <core::array::IntoIter<u32, 42> as Iterator>::Item
/// // ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
/// ```
self_type: Box<Type>,
/// `None` iff this is an *inherent* associated type.
#[serde(rename = "trait")]
trait_: Option<Path>,
},
}
/// A type that has a simple path to it. This is the kind of type of structs, unions, enums, etc.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Path {
/// The name of the type as declared, e.g. in
///
/// ```rust
/// mod foo {
/// struct Bar;
/// }
/// ```
///
/// for `foo::Bar`, this field will be `Bar`.
pub name: String,
/// The ID of the type.
pub id: Id,
/// Generic arguments to the type.
///
/// ```ignore (incomplete expression)
/// std::borrow::Cow<'static, str>
/// // ^^^^^^^^^^^^^^
/// ```
pub args: Option<Box<GenericArgs>>,
}
/// A type that is a function pointer.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct FunctionPointer {
/// The signature of the function.
pub decl: FnDecl,
/// Used for Higher-Rank Trait Bounds (HRTBs)
///
/// ```ignore (incomplete expression)
/// for<'c> fn(val: &'c i32) -> i32
/// // ^^^^^^^
/// ```
pub generic_params: Vec<GenericParamDef>,
/// The core properties of the function, such as the ABI it conforms to, whether it's unsafe, etc.
pub header: Header,
}
/// The signature of a function.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct FnDecl {
/// List of argument names and their type.
///
/// Note that not all names will be valid identifiers, as some of
/// them may be patterns.
pub inputs: Vec<(String, Type)>,
/// The output type, if specified.
pub output: Option<Type>,
/// Whether the function accepts an arbitrary amount of trailing arguments the C way.
///
/// ```ignore (incomplete code)
/// fn printf(fmt: &str, ...);
/// ```
pub c_variadic: bool,
}
/// A `trait` declaration.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Trait {
/// Whether the trait is marked `auto` and is thus implemented automatically
/// for all aplicable types.
pub is_auto: bool,
/// Whether the trait is marked as `unsafe`.
pub is_unsafe: bool,
/// Whether the trait is [object safe](https://doc.rust-lang.org/reference/items/traits.html#object-safety).
pub is_object_safe: bool,
/// Associated [`Item`]s that can/must be implemented by the `impl` blocks.
pub items: Vec<Id>,
/// Information about the type parameters and `where` clauses of the trait.
pub generics: Generics,
/// Constraints that must be met by the implementor of the trait.
pub bounds: Vec<GenericBound>,
/// The implementations of the trait.
pub implementations: Vec<Id>,
}
/// A trait alias declaration, e.g. `trait Int = Add + Sub + Mul + Div;`
///
/// See [the tracking issue](https://github.com/rust-lang/rust/issues/41517)
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct TraitAlias {
/// Information about the type parameters and `where` clauses of the alias.
pub generics: Generics,
/// The bounds that are associated with the alias.
pub params: Vec<GenericBound>,
}
/// An `impl` block.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Impl {
/// Whether this impl is for an unsafe trait.
pub is_unsafe: bool,
/// Information about the impl’s type parameters and `where` clauses.
pub generics: Generics,
/// The list of the names of all the trait methods that weren't mentioned in this impl but
/// were provided by the trait itself.
///
/// For example, for this impl of the [`PartialEq`] trait:
/// ```rust
/// struct Foo;
///
/// impl PartialEq for Foo {
/// fn eq(&self, other: &Self) -> bool { todo!() }
/// }
/// ```
/// This field will be `["ne"]`, as it has a default implementation defined for it.
pub provided_trait_methods: Vec<String>,
/// The trait being implemented or `None` if the impl is inherent, which means
/// `impl Struct {}` as opposed to `impl Trait for Struct {}`.
#[serde(rename = "trait")]
pub trait_: Option<Path>,
/// The type that the impl block is for.
#[serde(rename = "for")]
pub for_: Type,
/// The list of associated items contained in this impl block.
pub items: Vec<Id>,
/// Whether this is a negative impl (e.g. `!Sized` or `!Send`).
pub negative: bool,
/// Whether this is an impl that’s implied by the compiler
/// (for autotraits, e.g. `Send` or `Sync`).
pub synthetic: bool,
// FIXME: document this
pub blanket_impl: Option<Type>,
}
/// A `use` statement.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub struct Import {
/// The full path being imported.
pub source: String,
/// May be different from the last segment of `source` when renaming imports:
/// `use source as name;`
pub name: String,
/// The ID of the item being imported. Will be `None` in case of re-exports of primitives:
/// ```rust
/// pub use i32 as my_i32;
/// ```
pub id: Option<Id>,
/// Whether this statement is a wildcard `use`, e.g. `use source::*;`
pub glob: bool,
}
/// A procedural macro.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct ProcMacro {
/// How this macro is supposed to be called: `foo!()`, `#[foo]` or `#[derive(foo)]`
pub kind: MacroKind,
/// Helper attributes defined by a macro to be used inside it.
///
/// Defined only for attribute & derive macros.
///
/// E.g. the [`Default`] derive macro defines a `#[default]` helper attribute so that one can
/// do:
///
/// ```rust
/// #[derive(Default)]
/// enum Option<T> {
/// #[default]
/// None,
/// Some(T),
/// }
/// ```
pub helpers: Vec<String>,
}
/// The way a [`ProcMacro`] is declared to be used.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
#[serde(rename_all = "snake_case")]
pub enum MacroKind {
/// A bang macro `foo!()`.
Bang,
/// An attribute macro `#[foo]`.
Attr,
/// A derive macro `#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]`
Derive,
}
/// A type alias declaration, e.g. `type Pig = std::borrow::Cow<'static, str>;`
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct TypeAlias {
/// The type referred to by this alias.
#[serde(rename = "type")]
pub type_: Type,
/// Information about the type parameters and `where` clauses of the alias.
pub generics: Generics,
}
/// A `static` declaration.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Static {
/// The type of the static.
#[serde(rename = "type")]
pub type_: Type,
/// This is `true` for mutable statics, declared as `static mut X: T = f();`
pub mutable: bool,
/// The stringified expression for the initial value.
///
/// It's not guaranteed that it'll match the actual source code for the initial value.
pub expr: String,
}
/// A primitive type declaration. Declarations of this kind can only come from the core library.
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
pub struct Primitive {
/// The name of the type.
pub name: String,
/// The implementations, inherent and of traits, on the primitive type.
pub impls: Vec<Id>,
}
#[cfg(test)]
mod tests;