compiler/rustc_ast/src/ast.rs

   1 //! The Rust abstract syntax tree module.
   2 //!
   3 //! This module contains common structures forming the language AST.
   4 //! Two main entities in the module are [`Item`] (which represents an AST element with
   5 //! additional metadata), and [`ItemKind`] (which represents a concrete type and contains
   6 //! information specific to the type of the item).
   7 //!
   8 //! Other module items worth mentioning:
   9 //! - [`Ty`] and [`TyKind`]: A parsed Rust type.
  10 //! - [`Expr`] and [`ExprKind`]: A parsed Rust expression.
  11 //! - [`Pat`] and [`PatKind`]: A parsed Rust pattern. Patterns are often dual to expressions.
  12 //! - [`Stmt`] and [`StmtKind`]: An executable action that does not return a value.
  13 //! - [`FnDecl`], [`FnHeader`] and [`Param`]: Metadata associated with a function declaration.
  14 //! - [`Generics`], [`GenericParam`], [`WhereClause`]: Metadata associated with generic parameters.
  15 //! - [`EnumDef`] and [`Variant`]: Enum declaration.
  16 //! - [`MetaItemLit`] and [`LitKind`]: Literal expressions.
  17 //! - [`MacroDef`], [`MacStmtStyle`], [`MacCall`], [`MacDelimiter`]: Macro definition and invocation.
  18 //! - [`Attribute`]: Metadata associated with item.
  19 //! - [`UnOp`], [`BinOp`], and [`BinOpKind`]: Unary and binary operators.
  20
  21 pub use crate::format::*;
  22 pub use crate::util::parser::ExprPrecedence;
  23 pub use GenericArgs::*;
  24 pub use UnsafeSource::*;
  25
  26 use crate::ptr::P;
  27 use crate::token::{self, CommentKind, Delimiter};
  28 use crate::tokenstream::{DelimSpan, LazyAttrTokenStream, TokenStream};
  29 use rustc_data_structures::stable_hasher::{HashStable, StableHasher};
  30 use rustc_data_structures::stack::ensure_sufficient_stack;
  31 use rustc_data_structures::sync::Lrc;
  32 use rustc_macros::HashStable_Generic;
  33 use rustc_serialize::{Decodable, Decoder, Encodable, Encoder};
  34 use rustc_span::source_map::{respan, Spanned};
  35 use rustc_span::symbol::{kw, sym, Ident, Symbol};
  36 use rustc_span::{Span, DUMMY_SP};
  37 use std::fmt;
  38 use std::mem;
  39 use thin_vec::{thin_vec, ThinVec};
  40
  41 /// A "Label" is an identifier of some point in sources,
  42 /// e.g. in the following code:
  43 ///
  44 /// ```rust
  45 /// 'outer: loop {
  46 ///     break 'outer;
  47 /// }
  48 /// ```
  49 ///
  50 /// `'outer` is a label.
  51 #[derive(Clone, Encodable, Decodable, Copy, HashStable_Generic, Eq, PartialEq)]
  52 pub struct Label {
  53     pub ident: Ident,
  54 }
  55
  56 impl fmt::Debug for Label {
  57     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  58         write!(f, "label({:?})", self.ident)
  59     }
  60 }
  61
  62 /// A "Lifetime" is an annotation of the scope in which variable
  63 /// can be used, e.g. `'a` in `&'a i32`.
  64 #[derive(Clone, Encodable, Decodable, Copy, PartialEq, Eq)]
  65 pub struct Lifetime {
  66     pub id: NodeId,
  67     pub ident: Ident,
  68 }
  69
  70 impl fmt::Debug for Lifetime {
  71     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  72         write!(f, "lifetime({}: {})", self.id, self)
  73     }
  74 }
  75
  76 impl fmt::Display for Lifetime {
  77     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
  78         write!(f, "{}", self.ident.name)
  79     }
  80 }
  81
  82 /// A "Path" is essentially Rust's notion of a name.
  83 ///
  84 /// It's represented as a sequence of identifiers,
  85 /// along with a bunch of supporting information.
  86 ///
  87 /// E.g., `std::cmp::PartialEq`.
  88 #[derive(Clone, Encodable, Decodable, Debug)]
  89 pub struct Path {
  90     pub span: Span,
  91     /// The segments in the path: the things separated by `::`.
  92     /// Global paths begin with `kw::PathRoot`.
  93     pub segments: ThinVec<PathSegment>,
  94     pub tokens: Option<LazyAttrTokenStream>,
  95 }
  96
  97 impl PartialEq<Symbol> for Path {
  98     #[inline]
  99     fn eq(&self, symbol: &Symbol) -> bool {
 100         self.segments.len() == 1 && { self.segments[0].ident.name == *symbol }
 101     }
 102 }
 103
 104 impl<CTX: rustc_span::HashStableContext> HashStable<CTX> for Path {
 105     fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
 106         self.segments.len().hash_stable(hcx, hasher);
 107         for segment in &self.segments {
 108             segment.ident.hash_stable(hcx, hasher);
 109         }
 110     }
 111 }
 112
 113 impl Path {
 114     /// Convert a span and an identifier to the corresponding
 115     /// one-segment path.
 116     pub fn from_ident(ident: Ident) -> Path {
 117         Path { segments: thin_vec![PathSegment::from_ident(ident)], span: ident.span, tokens: None }
 118     }
 119
 120     pub fn is_global(&self) -> bool {
 121         !self.segments.is_empty() && self.segments[0].ident.name == kw::PathRoot
 122     }
 123 }
 124
 125 /// A segment of a path: an identifier, an optional lifetime, and a set of types.
 126 ///
 127 /// E.g., `std`, `String` or `Box<T>`.
 128 #[derive(Clone, Encodable, Decodable, Debug)]
 129 pub struct PathSegment {
 130     /// The identifier portion of this path segment.
 131     pub ident: Ident,
 132
 133     pub id: NodeId,
 134
 135     /// Type/lifetime parameters attached to this path. They come in
 136     /// two flavors: `Path<A,B,C>` and `Path(A,B) -> C`.
 137     /// `None` means that no parameter list is supplied (`Path`),
 138     /// `Some` means that parameter list is supplied (`Path<X, Y>`)
 139     /// but it can be empty (`Path<>`).
 140     /// `P` is used as a size optimization for the common case with no parameters.
 141     pub args: Option<P<GenericArgs>>,
 142 }
 143
 144 impl PathSegment {
 145     pub fn from_ident(ident: Ident) -> Self {
 146         PathSegment { ident, id: DUMMY_NODE_ID, args: None }
 147     }
 148
 149     pub fn path_root(span: Span) -> Self {
 150         PathSegment::from_ident(Ident::new(kw::PathRoot, span))
 151     }
 152
 153     pub fn span(&self) -> Span {
 154         match &self.args {
 155             Some(args) => self.ident.span.to(args.span()),
 156             None => self.ident.span,
 157         }
 158     }
 159 }
 160
 161 /// The arguments of a path segment.
 162 ///
 163 /// E.g., `<A, B>` as in `Foo<A, B>` or `(A, B)` as in `Foo(A, B)`.
 164 #[derive(Clone, Encodable, Decodable, Debug)]
 165 pub enum GenericArgs {
 166     /// The `<'a, A, B, C>` in `foo::bar::baz::<'a, A, B, C>`.
 167     AngleBracketed(AngleBracketedArgs),
 168     /// The `(A, B)` and `C` in `Foo(A, B) -> C`.
 169     Parenthesized(ParenthesizedArgs),
 170 }
 171
 172 impl GenericArgs {
 173     pub fn is_angle_bracketed(&self) -> bool {
 174         matches!(self, AngleBracketed(..))
 175     }
 176
 177     pub fn span(&self) -> Span {
 178         match self {
 179             AngleBracketed(data) => data.span,
 180             Parenthesized(data) => data.span,
 181         }
 182     }
 183 }
 184
 185 /// Concrete argument in the sequence of generic args.
 186 #[derive(Clone, Encodable, Decodable, Debug)]
 187 pub enum GenericArg {
 188     /// `'a` in `Foo<'a>`
 189     Lifetime(Lifetime),
 190     /// `Bar` in `Foo<Bar>`
 191     Type(P<Ty>),
 192     /// `1` in `Foo<1>`
 193     Const(AnonConst),
 194 }
 195
 196 impl GenericArg {
 197     pub fn span(&self) -> Span {
 198         match self {
 199             GenericArg::Lifetime(lt) => lt.ident.span,
 200             GenericArg::Type(ty) => ty.span,
 201             GenericArg::Const(ct) => ct.value.span,
 202         }
 203     }
 204 }
 205
 206 /// A path like `Foo<'a, T>`.
 207 #[derive(Clone, Encodable, Decodable, Debug, Default)]
 208 pub struct AngleBracketedArgs {
 209     /// The overall span.
 210     pub span: Span,
 211     /// The comma separated parts in the `<...>`.
 212     pub args: Vec<AngleBracketedArg>,
 213 }
 214
 215 /// Either an argument for a parameter e.g., `'a`, `Vec<u8>`, `0`,
 216 /// or a constraint on an associated item, e.g., `Item = String` or `Item: Bound`.
 217 #[derive(Clone, Encodable, Decodable, Debug)]
 218 pub enum AngleBracketedArg {
 219     /// Argument for a generic parameter.
 220     Arg(GenericArg),
 221     /// Constraint for an associated item.
 222     Constraint(AssocConstraint),
 223 }
 224
 225 impl AngleBracketedArg {
 226     pub fn span(&self) -> Span {
 227         match self {
 228             AngleBracketedArg::Arg(arg) => arg.span(),
 229             AngleBracketedArg::Constraint(constraint) => constraint.span,
 230         }
 231     }
 232 }
 233
 234 impl Into<Option<P<GenericArgs>>> for AngleBracketedArgs {
 235     fn into(self) -> Option<P<GenericArgs>> {
 236         Some(P(GenericArgs::AngleBracketed(self)))
 237     }
 238 }
 239
 240 impl Into<Option<P<GenericArgs>>> for ParenthesizedArgs {
 241     fn into(self) -> Option<P<GenericArgs>> {
 242         Some(P(GenericArgs::Parenthesized(self)))
 243     }
 244 }
 245
 246 /// A path like `Foo(A, B) -> C`.
 247 #[derive(Clone, Encodable, Decodable, Debug)]
 248 pub struct ParenthesizedArgs {
 249     /// ```text
 250     /// Foo(A, B) -> C
 251     /// ^^^^^^^^^^^^^^
 252     /// ```
 253     pub span: Span,
 254
 255     /// `(A, B)`
 256     pub inputs: Vec<P<Ty>>,
 257
 258     /// ```text
 259     /// Foo(A, B) -> C
 260     ///    ^^^^^^
 261     /// ```
 262     pub inputs_span: Span,
 263
 264     /// `C`
 265     pub output: FnRetTy,
 266 }
 267
 268 impl ParenthesizedArgs {
 269     pub fn as_angle_bracketed_args(&self) -> AngleBracketedArgs {
 270         let args = self
 271             .inputs
 272             .iter()
 273             .cloned()
 274             .map(|input| AngleBracketedArg::Arg(GenericArg::Type(input)))
 275             .collect();
 276         AngleBracketedArgs { span: self.inputs_span, args }
 277     }
 278 }
 279
 280 pub use crate::node_id::{NodeId, CRATE_NODE_ID, DUMMY_NODE_ID};
 281
 282 /// A modifier on a bound, e.g., `?Trait` or `~const Trait`.
 283 ///
 284 /// Negative bounds should also be handled here.
 285 #[derive(Copy, Clone, PartialEq, Eq, Encodable, Decodable, Debug)]
 286 pub enum TraitBoundModifier {
 287     /// No modifiers
 288     None,
 289
 290     /// `?Trait`
 291     Maybe,
 292
 293     /// `~const Trait`
 294     MaybeConst,
 295
 296     /// `~const ?Trait`
 297     //
 298     // This parses but will be rejected during AST validation.
 299     MaybeConstMaybe,
 300 }
 301
 302 /// The AST represents all type param bounds as types.
 303 /// `typeck::collect::compute_bounds` matches these against
 304 /// the "special" built-in traits (see `middle::lang_items`) and
 305 /// detects `Copy`, `Send` and `Sync`.
 306 #[derive(Clone, Encodable, Decodable, Debug)]
 307 pub enum GenericBound {
 308     Trait(PolyTraitRef, TraitBoundModifier),
 309     Outlives(Lifetime),
 310 }
 311
 312 impl GenericBound {
 313     pub fn span(&self) -> Span {
 314         match self {
 315             GenericBound::Trait(t, ..) => t.span,
 316             GenericBound::Outlives(l) => l.ident.span,
 317         }
 318     }
 319 }
 320
 321 pub type GenericBounds = Vec<GenericBound>;
 322
 323 /// Specifies the enforced ordering for generic parameters. In the future,
 324 /// if we wanted to relax this order, we could override `PartialEq` and
 325 /// `PartialOrd`, to allow the kinds to be unordered.
 326 #[derive(Hash, Clone, Copy, PartialEq, Eq, PartialOrd, Ord)]
 327 pub enum ParamKindOrd {
 328     Lifetime,
 329     TypeOrConst,
 330 }
 331
 332 impl fmt::Display for ParamKindOrd {
 333     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 334         match self {
 335             ParamKindOrd::Lifetime => "lifetime".fmt(f),
 336             ParamKindOrd::TypeOrConst => "type and const".fmt(f),
 337         }
 338     }
 339 }
 340
 341 #[derive(Clone, Encodable, Decodable, Debug)]
 342 pub enum GenericParamKind {
 343     /// A lifetime definition (e.g., `'a: 'b + 'c + 'd`).
 344     Lifetime,
 345     Type {
 346         default: Option<P<Ty>>,
 347     },
 348     Const {
 349         ty: P<Ty>,
 350         /// Span of the `const` keyword.
 351         kw_span: Span,
 352         /// Optional default value for the const generic param
 353         default: Option<AnonConst>,
 354     },
 355 }
 356
 357 #[derive(Clone, Encodable, Decodable, Debug)]
 358 pub struct GenericParam {
 359     pub id: NodeId,
 360     pub ident: Ident,
 361     pub attrs: AttrVec,
 362     pub bounds: GenericBounds,
 363     pub is_placeholder: bool,
 364     pub kind: GenericParamKind,
 365     pub colon_span: Option<Span>,
 366 }
 367
 368 impl GenericParam {
 369     pub fn span(&self) -> Span {
 370         match &self.kind {
 371             GenericParamKind::Lifetime | GenericParamKind::Type { default: None } => {
 372                 self.ident.span
 373             }
 374             GenericParamKind::Type { default: Some(ty) } => self.ident.span.to(ty.span),
 375             GenericParamKind::Const { kw_span, default: Some(default), .. } => {
 376                 kw_span.to(default.value.span)
 377             }
 378             GenericParamKind::Const { kw_span, default: None, ty } => kw_span.to(ty.span),
 379         }
 380     }
 381 }
 382
 383 /// Represents lifetime, type and const parameters attached to a declaration of
 384 /// a function, enum, trait, etc.
 385 #[derive(Clone, Encodable, Decodable, Debug)]
 386 pub struct Generics {
 387     pub params: Vec<GenericParam>,
 388     pub where_clause: WhereClause,
 389     pub span: Span,
 390 }
 391
 392 impl Default for Generics {
 393     /// Creates an instance of `Generics`.
 394     fn default() -> Generics {
 395         Generics { params: Vec::new(), where_clause: Default::default(), span: DUMMY_SP }
 396     }
 397 }
 398
 399 /// A where-clause in a definition.
 400 #[derive(Clone, Encodable, Decodable, Debug)]
 401 pub struct WhereClause {
 402     /// `true` if we ate a `where` token: this can happen
 403     /// if we parsed no predicates (e.g. `struct Foo where {}`).
 404     /// This allows us to pretty-print accurately.
 405     pub has_where_token: bool,
 406     pub predicates: Vec<WherePredicate>,
 407     pub span: Span,
 408 }
 409
 410 impl Default for WhereClause {
 411     fn default() -> WhereClause {
 412         WhereClause { has_where_token: false, predicates: Vec::new(), span: DUMMY_SP }
 413     }
 414 }
 415
 416 /// A single predicate in a where-clause.
 417 #[derive(Clone, Encodable, Decodable, Debug)]
 418 pub enum WherePredicate {
 419     /// A type binding (e.g., `for<'c> Foo: Send + Clone + 'c`).
 420     BoundPredicate(WhereBoundPredicate),
 421     /// A lifetime predicate (e.g., `'a: 'b + 'c`).
 422     RegionPredicate(WhereRegionPredicate),
 423     /// An equality predicate (unsupported).
 424     EqPredicate(WhereEqPredicate),
 425 }
 426
 427 impl WherePredicate {
 428     pub fn span(&self) -> Span {
 429         match self {
 430             WherePredicate::BoundPredicate(p) => p.span,
 431             WherePredicate::RegionPredicate(p) => p.span,
 432             WherePredicate::EqPredicate(p) => p.span,
 433         }
 434     }
 435 }
 436
 437 /// A type bound.
 438 ///
 439 /// E.g., `for<'c> Foo: Send + Clone + 'c`.
 440 #[derive(Clone, Encodable, Decodable, Debug)]
 441 pub struct WhereBoundPredicate {
 442     pub span: Span,
 443     /// Any generics from a `for` binding.
 444     pub bound_generic_params: Vec<GenericParam>,
 445     /// The type being bounded.
 446     pub bounded_ty: P<Ty>,
 447     /// Trait and lifetime bounds (`Clone + Send + 'static`).
 448     pub bounds: GenericBounds,
 449 }
 450
 451 /// A lifetime predicate.
 452 ///
 453 /// E.g., `'a: 'b + 'c`.
 454 #[derive(Clone, Encodable, Decodable, Debug)]
 455 pub struct WhereRegionPredicate {
 456     pub span: Span,
 457     pub lifetime: Lifetime,
 458     pub bounds: GenericBounds,
 459 }
 460
 461 /// An equality predicate (unsupported).
 462 ///
 463 /// E.g., `T = int`.
 464 #[derive(Clone, Encodable, Decodable, Debug)]
 465 pub struct WhereEqPredicate {
 466     pub span: Span,
 467     pub lhs_ty: P<Ty>,
 468     pub rhs_ty: P<Ty>,
 469 }
 470
 471 #[derive(Clone, Encodable, Decodable, Debug)]
 472 pub struct Crate {
 473     pub attrs: AttrVec,
 474     pub items: Vec<P<Item>>,
 475     pub spans: ModSpans,
 476     /// Must be equal to `CRATE_NODE_ID` after the crate root is expanded, but may hold
 477     /// expansion placeholders or an unassigned value (`DUMMY_NODE_ID`) before that.
 478     pub id: NodeId,
 479     pub is_placeholder: bool,
 480 }
 481
 482 /// A semantic representation of a meta item. A meta item is a slightly
 483 /// restricted form of an attribute -- it can only contain expressions in
 484 /// certain leaf positions, rather than arbitrary token streams -- that is used
 485 /// for most built-in attributes.
 486 ///
 487 /// E.g., `#[test]`, `#[derive(..)]`, `#[rustfmt::skip]` or `#[feature = "foo"]`.
 488 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
 489 pub struct MetaItem {
 490     pub path: Path,
 491     pub kind: MetaItemKind,
 492     pub span: Span,
 493 }
 494
 495 /// The meta item kind, containing the data after the initial path.
 496 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
 497 pub enum MetaItemKind {
 498     /// Word meta item.
 499     ///
 500     /// E.g., `#[test]`, which lacks any arguments after `test`.
 501     Word,
 502
 503     /// List meta item.
 504     ///
 505     /// E.g., `#[derive(..)]`, where the field represents the `..`.
 506     List(Vec<NestedMetaItem>),
 507
 508     /// Name value meta item.
 509     ///
 510     /// E.g., `#[feature = "foo"]`, where the field represents the `"foo"`.
 511     NameValue(MetaItemLit),
 512 }
 513
 514 /// Values inside meta item lists.
 515 ///
 516 /// E.g., each of `Clone`, `Copy` in `#[derive(Clone, Copy)]`.
 517 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
 518 pub enum NestedMetaItem {
 519     /// A full MetaItem, for recursive meta items.
 520     MetaItem(MetaItem),
 521
 522     /// A literal.
 523     ///
 524     /// E.g., `"foo"`, `64`, `true`.
 525     Lit(MetaItemLit),
 526 }
 527
 528 /// A block (`{ .. }`).
 529 ///
 530 /// E.g., `{ .. }` as in `fn foo() { .. }`.
 531 #[derive(Clone, Encodable, Decodable, Debug)]
 532 pub struct Block {
 533     /// The statements in the block.
 534     pub stmts: Vec<Stmt>,
 535     pub id: NodeId,
 536     /// Distinguishes between `unsafe { ... }` and `{ ... }`.
 537     pub rules: BlockCheckMode,
 538     pub span: Span,
 539     pub tokens: Option<LazyAttrTokenStream>,
 540     /// The following *isn't* a parse error, but will cause multiple errors in following stages.
 541     /// ```compile_fail
 542     /// let x = {
 543     ///     foo: var
 544     /// };
 545     /// ```
 546     /// #34255
 547     pub could_be_bare_literal: bool,
 548 }
 549
 550 /// A match pattern.
 551 ///
 552 /// Patterns appear in match statements and some other contexts, such as `let` and `if let`.
 553 #[derive(Clone, Encodable, Decodable, Debug)]
 554 pub struct Pat {
 555     pub id: NodeId,
 556     pub kind: PatKind,
 557     pub span: Span,
 558     pub tokens: Option<LazyAttrTokenStream>,
 559 }
 560
 561 impl Pat {
 562     /// Attempt reparsing the pattern as a type.
 563     /// This is intended for use by diagnostics.
 564     pub fn to_ty(&self) -> Option<P<Ty>> {
 565         let kind = match &self.kind {
 566             // In a type expression `_` is an inference variable.
 567             PatKind::Wild => TyKind::Infer,
 568             // An IDENT pattern with no binding mode would be valid as path to a type. E.g. `u32`.
 569             PatKind::Ident(BindingAnnotation::NONE, ident, None) => {
 570                 TyKind::Path(None, Path::from_ident(*ident))
 571             }
 572             PatKind::Path(qself, path) => TyKind::Path(qself.clone(), path.clone()),
 573             PatKind::MacCall(mac) => TyKind::MacCall(mac.clone()),
 574             // `&mut? P` can be reinterpreted as `&mut? T` where `T` is `P` reparsed as a type.
 575             PatKind::Ref(pat, mutbl) => {
 576                 pat.to_ty().map(|ty| TyKind::Ref(None, MutTy { ty, mutbl: *mutbl }))?
 577             }
 578             // A slice/array pattern `[P]` can be reparsed as `[T]`, an unsized array,
 579             // when `P` can be reparsed as a type `T`.
 580             PatKind::Slice(pats) if pats.len() == 1 => pats[0].to_ty().map(TyKind::Slice)?,
 581             // A tuple pattern `(P0, .., Pn)` can be reparsed as `(T0, .., Tn)`
 582             // assuming `T0` to `Tn` are all syntactically valid as types.
 583             PatKind::Tuple(pats) => {
 584                 let mut tys = Vec::with_capacity(pats.len());
 585                 // FIXME(#48994) - could just be collected into an Option<Vec>
 586                 for pat in pats {
 587                     tys.push(pat.to_ty()?);
 588                 }
 589                 TyKind::Tup(tys)
 590             }
 591             _ => return None,
 592         };
 593
 594         Some(P(Ty { kind, id: self.id, span: self.span, tokens: None }))
 595     }
 596
 597     /// Walk top-down and call `it` in each place where a pattern occurs
 598     /// starting with the root pattern `walk` is called on. If `it` returns
 599     /// false then we will descend no further but siblings will be processed.
 600     pub fn walk(&self, it: &mut impl FnMut(&Pat) -> bool) {
 601         if !it(self) {
 602             return;
 603         }
 604
 605         match &self.kind {
 606             // Walk into the pattern associated with `Ident` (if any).
 607             PatKind::Ident(_, _, Some(p)) => p.walk(it),
 608
 609             // Walk into each field of struct.
 610             PatKind::Struct(_, _, fields, _) => fields.iter().for_each(|field| field.pat.walk(it)),
 611
 612             // Sequence of patterns.
 613             PatKind::TupleStruct(_, _, s)
 614             | PatKind::Tuple(s)
 615             | PatKind::Slice(s)
 616             | PatKind::Or(s) => s.iter().for_each(|p| p.walk(it)),
 617
 618             // Trivial wrappers over inner patterns.
 619             PatKind::Box(s) | PatKind::Ref(s, _) | PatKind::Paren(s) => s.walk(it),
 620
 621             // These patterns do not contain subpatterns, skip.
 622             PatKind::Wild
 623             | PatKind::Rest
 624             | PatKind::Lit(_)
 625             | PatKind::Range(..)
 626             | PatKind::Ident(..)
 627             | PatKind::Path(..)
 628             | PatKind::MacCall(_) => {}
 629         }
 630     }
 631
 632     /// Is this a `..` pattern?
 633     pub fn is_rest(&self) -> bool {
 634         matches!(self.kind, PatKind::Rest)
 635     }
 636 }
 637
 638 /// A single field in a struct pattern.
 639 ///
 640 /// Patterns like the fields of `Foo { x, ref y, ref mut z }`
 641 /// are treated the same as `x: x, y: ref y, z: ref mut z`,
 642 /// except when `is_shorthand` is true.
 643 #[derive(Clone, Encodable, Decodable, Debug)]
 644 pub struct PatField {
 645     /// The identifier for the field.
 646     pub ident: Ident,
 647     /// The pattern the field is destructured to.
 648     pub pat: P<Pat>,
 649     pub is_shorthand: bool,
 650     pub attrs: AttrVec,
 651     pub id: NodeId,
 652     pub span: Span,
 653     pub is_placeholder: bool,
 654 }
 655
 656 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
 657 #[derive(Encodable, Decodable, HashStable_Generic)]
 658 pub enum ByRef {
 659     Yes,
 660     No,
 661 }
 662
 663 impl From<bool> for ByRef {
 664     fn from(b: bool) -> ByRef {
 665         match b {
 666             false => ByRef::No,
 667             true => ByRef::Yes,
 668         }
 669     }
 670 }
 671
 672 /// Explicit binding annotations given in the HIR for a binding. Note
 673 /// that this is not the final binding *mode* that we infer after type
 674 /// inference.
 675 #[derive(Clone, Copy, Debug, Eq, PartialEq)]
 676 #[derive(Encodable, Decodable, HashStable_Generic)]
 677 pub struct BindingAnnotation(pub ByRef, pub Mutability);
 678
 679 impl BindingAnnotation {
 680     pub const NONE: Self = Self(ByRef::No, Mutability::Not);
 681     pub const REF: Self = Self(ByRef::Yes, Mutability::Not);
 682     pub const MUT: Self = Self(ByRef::No, Mutability::Mut);
 683     pub const REF_MUT: Self = Self(ByRef::Yes, Mutability::Mut);
 684
 685     pub fn prefix_str(self) -> &'static str {
 686         match self {
 687             Self::NONE => "",
 688             Self::REF => "ref ",
 689             Self::MUT => "mut ",
 690             Self::REF_MUT => "ref mut ",
 691         }
 692     }
 693 }
 694
 695 #[derive(Clone, Encodable, Decodable, Debug)]
 696 pub enum RangeEnd {
 697     /// `..=` or `...`
 698     Included(RangeSyntax),
 699     /// `..`
 700     Excluded,
 701 }
 702
 703 #[derive(Clone, Encodable, Decodable, Debug)]
 704 pub enum RangeSyntax {
 705     /// `...`
 706     DotDotDot,
 707     /// `..=`
 708     DotDotEq,
 709 }
 710
 711 /// All the different flavors of pattern that Rust recognizes.
 712 #[derive(Clone, Encodable, Decodable, Debug)]
 713 pub enum PatKind {
 714     /// Represents a wildcard pattern (`_`).
 715     Wild,
 716
 717     /// A `PatKind::Ident` may either be a new bound variable (`ref mut binding @ OPT_SUBPATTERN`),
 718     /// or a unit struct/variant pattern, or a const pattern (in the last two cases the third
 719     /// field must be `None`). Disambiguation cannot be done with parser alone, so it happens
 720     /// during name resolution.
 721     Ident(BindingAnnotation, Ident, Option<P<Pat>>),
 722
 723     /// A struct or struct variant pattern (e.g., `Variant {x, y, ..}`).
 724     /// The `bool` is `true` in the presence of a `..`.
 725     Struct(Option<P<QSelf>>, Path, Vec<PatField>, /* recovered */ bool),
 726
 727     /// A tuple struct/variant pattern (`Variant(x, y, .., z)`).
 728     TupleStruct(Option<P<QSelf>>, Path, Vec<P<Pat>>),
 729
 730     /// An or-pattern `A | B | C`.
 731     /// Invariant: `pats.len() >= 2`.
 732     Or(Vec<P<Pat>>),
 733
 734     /// A possibly qualified path pattern.
 735     /// Unqualified path patterns `A::B::C` can legally refer to variants, structs, constants
 736     /// or associated constants. Qualified path patterns `<A>::B::C`/`<A as Trait>::B::C` can
 737     /// only legally refer to associated constants.
 738     Path(Option<P<QSelf>>, Path),
 739
 740     /// A tuple pattern (`(a, b)`).
 741     Tuple(Vec<P<Pat>>),
 742
 743     /// A `box` pattern.
 744     Box(P<Pat>),
 745
 746     /// A reference pattern (e.g., `&mut (a, b)`).
 747     Ref(P<Pat>, Mutability),
 748
 749     /// A literal.
 750     Lit(P<Expr>),
 751
 752     /// A range pattern (e.g., `1...2`, `1..2`, `1..`, `..2`, `1..=2`, `..=2`).
 753     Range(Option<P<Expr>>, Option<P<Expr>>, Spanned<RangeEnd>),
 754
 755     /// A slice pattern `[a, b, c]`.
 756     Slice(Vec<P<Pat>>),
 757
 758     /// A rest pattern `..`.
 759     ///
 760     /// Syntactically it is valid anywhere.
 761     ///
 762     /// Semantically however, it only has meaning immediately inside:
 763     /// - a slice pattern: `[a, .., b]`,
 764     /// - a binding pattern immediately inside a slice pattern: `[a, r @ ..]`,
 765     /// - a tuple pattern: `(a, .., b)`,
 766     /// - a tuple struct/variant pattern: `$path(a, .., b)`.
 767     ///
 768     /// In all of these cases, an additional restriction applies,
 769     /// only one rest pattern may occur in the pattern sequences.
 770     Rest,
 771
 772     /// Parentheses in patterns used for grouping (i.e., `(PAT)`).
 773     Paren(P<Pat>),
 774
 775     /// A macro pattern; pre-expansion.
 776     MacCall(P<MacCall>),
 777 }
 778
 779 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Copy)]
 780 #[derive(HashStable_Generic, Encodable, Decodable)]
 781 pub enum Mutability {
 782     // N.B. Order is deliberate, so that Not < Mut
 783     Not,
 784     Mut,
 785 }
 786
 787 impl Mutability {
 788     pub fn invert(self) -> Self {
 789         match self {
 790             Mutability::Mut => Mutability::Not,
 791             Mutability::Not => Mutability::Mut,
 792         }
 793     }
 794
 795     /// Returns `""` (empty string) or `"mut "` depending on the mutability.
 796     pub fn prefix_str(self) -> &'static str {
 797         match self {
 798             Mutability::Mut => "mut ",
 799             Mutability::Not => "",
 800         }
 801     }
 802
 803     /// Returns `"&"` or `"&mut "` depending on the mutability.
 804     pub fn ref_prefix_str(self) -> &'static str {
 805         match self {
 806             Mutability::Not => "&",
 807             Mutability::Mut => "&mut ",
 808         }
 809     }
 810
 811     /// Returns `""` (empty string) or `"mutably "` depending on the mutability.
 812     pub fn mutably_str(self) -> &'static str {
 813         match self {
 814             Mutability::Not => "",
 815             Mutability::Mut => "mutably ",
 816         }
 817     }
 818
 819     /// Return `true` if self is mutable
 820     pub fn is_mut(self) -> bool {
 821         matches!(self, Self::Mut)
 822     }
 823
 824     /// Return `true` if self is **not** mutable
 825     pub fn is_not(self) -> bool {
 826         matches!(self, Self::Not)
 827     }
 828 }
 829
 830 /// The kind of borrow in an `AddrOf` expression,
 831 /// e.g., `&place` or `&raw const place`.
 832 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
 833 #[derive(Encodable, Decodable, HashStable_Generic)]
 834 pub enum BorrowKind {
 835     /// A normal borrow, `&$expr` or `&mut $expr`.
 836     /// The resulting type is either `&'a T` or `&'a mut T`
 837     /// where `T = typeof($expr)` and `'a` is some lifetime.
 838     Ref,
 839     /// A raw borrow, `&raw const $expr` or `&raw mut $expr`.
 840     /// The resulting type is either `*const T` or `*mut T`
 841     /// where `T = typeof($expr)`.
 842     Raw,
 843 }
 844
 845 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy)]
 846 pub enum BinOpKind {
 847     /// The `+` operator (addition)
 848     Add,
 849     /// The `-` operator (subtraction)
 850     Sub,
 851     /// The `*` operator (multiplication)
 852     Mul,
 853     /// The `/` operator (division)
 854     Div,
 855     /// The `%` operator (modulus)
 856     Rem,
 857     /// The `&&` operator (logical and)
 858     And,
 859     /// The `||` operator (logical or)
 860     Or,
 861     /// The `^` operator (bitwise xor)
 862     BitXor,
 863     /// The `&` operator (bitwise and)
 864     BitAnd,
 865     /// The `|` operator (bitwise or)
 866     BitOr,
 867     /// The `<<` operator (shift left)
 868     Shl,
 869     /// The `>>` operator (shift right)
 870     Shr,
 871     /// The `==` operator (equality)
 872     Eq,
 873     /// The `<` operator (less than)
 874     Lt,
 875     /// The `<=` operator (less than or equal to)
 876     Le,
 877     /// The `!=` operator (not equal to)
 878     Ne,
 879     /// The `>=` operator (greater than or equal to)
 880     Ge,
 881     /// The `>` operator (greater than)
 882     Gt,
 883 }
 884
 885 impl BinOpKind {
 886     pub fn to_string(&self) -> &'static str {
 887         use BinOpKind::*;
 888         match *self {
 889             Add => "+",
 890             Sub => "-",
 891             Mul => "*",
 892             Div => "/",
 893             Rem => "%",
 894             And => "&&",
 895             Or => "||",
 896             BitXor => "^",
 897             BitAnd => "&",
 898             BitOr => "|",
 899             Shl => "<<",
 900             Shr => ">>",
 901             Eq => "==",
 902             Lt => "<",
 903             Le => "<=",
 904             Ne => "!=",
 905             Ge => ">=",
 906             Gt => ">",
 907         }
 908     }
 909     pub fn lazy(&self) -> bool {
 910         matches!(self, BinOpKind::And | BinOpKind::Or)
 911     }
 912
 913     pub fn is_comparison(&self) -> bool {
 914         use BinOpKind::*;
 915         // Note for developers: please keep this as is;
 916         // we want compilation to fail if another variant is added.
 917         match *self {
 918             Eq | Lt | Le | Ne | Gt | Ge => true,
 919             And | Or | Add | Sub | Mul | Div | Rem | BitXor | BitAnd | BitOr | Shl | Shr => false,
 920         }
 921     }
 922 }
 923
 924 pub type BinOp = Spanned<BinOpKind>;
 925
 926 /// Unary operator.
 927 ///
 928 /// Note that `&data` is not an operator, it's an `AddrOf` expression.
 929 #[derive(Clone, Encodable, Decodable, Debug, Copy)]
 930 pub enum UnOp {
 931     /// The `*` operator for dereferencing
 932     Deref,
 933     /// The `!` operator for logical inversion
 934     Not,
 935     /// The `-` operator for negation
 936     Neg,
 937 }
 938
 939 impl UnOp {
 940     pub fn to_string(op: UnOp) -> &'static str {
 941         match op {
 942             UnOp::Deref => "*",
 943             UnOp::Not => "!",
 944             UnOp::Neg => "-",
 945         }
 946     }
 947 }
 948
 949 /// A statement
 950 #[derive(Clone, Encodable, Decodable, Debug)]
 951 pub struct Stmt {
 952     pub id: NodeId,
 953     pub kind: StmtKind,
 954     pub span: Span,
 955 }
 956
 957 impl Stmt {
 958     pub fn has_trailing_semicolon(&self) -> bool {
 959         match &self.kind {
 960             StmtKind::Semi(_) => true,
 961             StmtKind::MacCall(mac) => matches!(mac.style, MacStmtStyle::Semicolon),
 962             _ => false,
 963         }
 964     }
 965
 966     /// Converts a parsed `Stmt` to a `Stmt` with
 967     /// a trailing semicolon.
 968     ///
 969     /// This only modifies the parsed AST struct, not the attached
 970     /// `LazyAttrTokenStream`. The parser is responsible for calling
 971     /// `ToAttrTokenStream::add_trailing_semi` when there is actually
 972     /// a semicolon in the tokenstream.
 973     pub fn add_trailing_semicolon(mut self) -> Self {
 974         self.kind = match self.kind {
 975             StmtKind::Expr(expr) => StmtKind::Semi(expr),
 976             StmtKind::MacCall(mac) => {
 977                 StmtKind::MacCall(mac.map(|MacCallStmt { mac, style: _, attrs, tokens }| {
 978                     MacCallStmt { mac, style: MacStmtStyle::Semicolon, attrs, tokens }
 979                 }))
 980             }
 981             kind => kind,
 982         };
 983
 984         self
 985     }
 986
 987     pub fn is_item(&self) -> bool {
 988         matches!(self.kind, StmtKind::Item(_))
 989     }
 990
 991     pub fn is_expr(&self) -> bool {
 992         matches!(self.kind, StmtKind::Expr(_))
 993     }
 994 }
 995
 996 #[derive(Clone, Encodable, Decodable, Debug)]
 997 pub enum StmtKind {
 998     /// A local (let) binding.
 999     Local(P<Local>),
1000     /// An item definition.
1001     Item(P<Item>),
1002     /// Expr without trailing semi-colon.
1003     Expr(P<Expr>),
1004     /// Expr with a trailing semi-colon.
1005     Semi(P<Expr>),
1006     /// Just a trailing semi-colon.
1007     Empty,
1008     /// Macro.
1009     MacCall(P<MacCallStmt>),
1010 }
1011
1012 #[derive(Clone, Encodable, Decodable, Debug)]
1013 pub struct MacCallStmt {
1014     pub mac: P<MacCall>,
1015     pub style: MacStmtStyle,
1016     pub attrs: AttrVec,
1017     pub tokens: Option<LazyAttrTokenStream>,
1018 }
1019
1020 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug)]
1021 pub enum MacStmtStyle {
1022     /// The macro statement had a trailing semicolon (e.g., `foo! { ... };`
1023     /// `foo!(...);`, `foo![...];`).
1024     Semicolon,
1025     /// The macro statement had braces (e.g., `foo! { ... }`).
1026     Braces,
1027     /// The macro statement had parentheses or brackets and no semicolon (e.g.,
1028     /// `foo!(...)`). All of these will end up being converted into macro
1029     /// expressions.
1030     NoBraces,
1031 }
1032
1033 /// Local represents a `let` statement, e.g., `let <pat>:<ty> = <expr>;`.
1034 #[derive(Clone, Encodable, Decodable, Debug)]
1035 pub struct Local {
1036     pub id: NodeId,
1037     pub pat: P<Pat>,
1038     pub ty: Option<P<Ty>>,
1039     pub kind: LocalKind,
1040     pub span: Span,
1041     pub attrs: AttrVec,
1042     pub tokens: Option<LazyAttrTokenStream>,
1043 }
1044
1045 #[derive(Clone, Encodable, Decodable, Debug)]
1046 pub enum LocalKind {
1047     /// Local declaration.
1048     /// Example: `let x;`
1049     Decl,
1050     /// Local declaration with an initializer.
1051     /// Example: `let x = y;`
1052     Init(P<Expr>),
1053     /// Local declaration with an initializer and an `else` clause.
1054     /// Example: `let Some(x) = y else { return };`
1055     InitElse(P<Expr>, P<Block>),
1056 }
1057
1058 impl LocalKind {
1059     pub fn init(&self) -> Option<&Expr> {
1060         match self {
1061             Self::Decl => None,
1062             Self::Init(i) | Self::InitElse(i, _) => Some(i),
1063         }
1064     }
1065
1066     pub fn init_else_opt(&self) -> Option<(&Expr, Option<&Block>)> {
1067         match self {
1068             Self::Decl => None,
1069             Self::Init(init) => Some((init, None)),
1070             Self::InitElse(init, els) => Some((init, Some(els))),
1071         }
1072     }
1073 }
1074
1075 /// An arm of a 'match'.
1076 ///
1077 /// E.g., `0..=10 => { println!("match!") }` as in
1078 ///
1079 /// ```
1080 /// match 123 {
1081 ///     0..=10 => { println!("match!") },
1082 ///     _ => { println!("no match!") },
1083 /// }
1084 /// ```
1085 #[derive(Clone, Encodable, Decodable, Debug)]
1086 pub struct Arm {
1087     pub attrs: AttrVec,
1088     /// Match arm pattern, e.g. `10` in `match foo { 10 => {}, _ => {} }`
1089     pub pat: P<Pat>,
1090     /// Match arm guard, e.g. `n > 10` in `match foo { n if n > 10 => {}, _ => {} }`
1091     pub guard: Option<P<Expr>>,
1092     /// Match arm body.
1093     pub body: P<Expr>,
1094     pub span: Span,
1095     pub id: NodeId,
1096     pub is_placeholder: bool,
1097 }
1098
1099 /// A single field in a struct expression, e.g. `x: value` and `y` in `Foo { x: value, y }`.
1100 #[derive(Clone, Encodable, Decodable, Debug)]
1101 pub struct ExprField {
1102     pub attrs: AttrVec,
1103     pub id: NodeId,
1104     pub span: Span,
1105     pub ident: Ident,
1106     pub expr: P<Expr>,
1107     pub is_shorthand: bool,
1108     pub is_placeholder: bool,
1109 }
1110
1111 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy)]
1112 pub enum BlockCheckMode {
1113     Default,
1114     Unsafe(UnsafeSource),
1115 }
1116
1117 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy)]
1118 pub enum UnsafeSource {
1119     CompilerGenerated,
1120     UserProvided,
1121 }
1122
1123 /// A constant (expression) that's not an item or associated item,
1124 /// but needs its own `DefId` for type-checking, const-eval, etc.
1125 /// These are usually found nested inside types (e.g., array lengths)
1126 /// or expressions (e.g., repeat counts), and also used to define
1127 /// explicit discriminant values for enum variants.
1128 #[derive(Clone, Encodable, Decodable, Debug)]
1129 pub struct AnonConst {
1130     pub id: NodeId,
1131     pub value: P<Expr>,
1132 }
1133
1134 /// An expression.
1135 #[derive(Clone, Encodable, Decodable, Debug)]
1136 pub struct Expr {
1137     pub id: NodeId,
1138     pub kind: ExprKind,
1139     pub span: Span,
1140     pub attrs: AttrVec,
1141     pub tokens: Option<LazyAttrTokenStream>,
1142 }
1143
1144 impl Expr {
1145     /// Is this expr either `N`, or `{ N }`.
1146     ///
1147     /// If this is not the case, name resolution does not resolve `N` when using
1148     /// `min_const_generics` as more complex expressions are not supported.
1149     pub fn is_potential_trivial_const_param(&self) -> bool {
1150         let this = if let ExprKind::Block(block, None) = &self.kind
1151             && block.stmts.len() == 1
1152             && let StmtKind::Expr(expr) = &block.stmts[0].kind
1153         {
1154             expr
1155         } else {
1156             self
1157         };
1158
1159         if let ExprKind::Path(None, path) = &this.kind
1160             && path.segments.len() == 1
1161             && path.segments[0].args.is_none()
1162         {
1163             true
1164         } else {
1165             false
1166         }
1167     }
1168
1169     pub fn to_bound(&self) -> Option<GenericBound> {
1170         match &self.kind {
1171             ExprKind::Path(None, path) => Some(GenericBound::Trait(
1172                 PolyTraitRef::new(Vec::new(), path.clone(), self.span),
1173                 TraitBoundModifier::None,
1174             )),
1175             _ => None,
1176         }
1177     }
1178
1179     pub fn peel_parens(&self) -> &Expr {
1180         let mut expr = self;
1181         while let ExprKind::Paren(inner) = &expr.kind {
1182             expr = inner;
1183         }
1184         expr
1185     }
1186
1187     /// Attempts to reparse as `Ty` (for diagnostic purposes).
1188     pub fn to_ty(&self) -> Option<P<Ty>> {
1189         let kind = match &self.kind {
1190             // Trivial conversions.
1191             ExprKind::Path(qself, path) => TyKind::Path(qself.clone(), path.clone()),
1192             ExprKind::MacCall(mac) => TyKind::MacCall(mac.clone()),
1193
1194             ExprKind::Paren(expr) => expr.to_ty().map(TyKind::Paren)?,
1195
1196             ExprKind::AddrOf(BorrowKind::Ref, mutbl, expr) => {
1197                 expr.to_ty().map(|ty| TyKind::Ref(None, MutTy { ty, mutbl: *mutbl }))?
1198             }
1199
1200             ExprKind::Repeat(expr, expr_len) => {
1201                 expr.to_ty().map(|ty| TyKind::Array(ty, expr_len.clone()))?
1202             }
1203
1204             ExprKind::Array(exprs) if exprs.len() == 1 => exprs[0].to_ty().map(TyKind::Slice)?,
1205
1206             ExprKind::Tup(exprs) => {
1207                 let tys = exprs.iter().map(|expr| expr.to_ty()).collect::<Option<Vec<_>>>()?;
1208                 TyKind::Tup(tys)
1209             }
1210
1211             // If binary operator is `Add` and both `lhs` and `rhs` are trait bounds,
1212             // then type of result is trait object.
1213             // Otherwise we don't assume the result type.
1214             ExprKind::Binary(binop, lhs, rhs) if binop.node == BinOpKind::Add => {
1215                 if let (Some(lhs), Some(rhs)) = (lhs.to_bound(), rhs.to_bound()) {
1216                     TyKind::TraitObject(vec![lhs, rhs], TraitObjectSyntax::None)
1217                 } else {
1218                     return None;
1219                 }
1220             }
1221
1222             ExprKind::Underscore => TyKind::Infer,
1223
1224             // This expression doesn't look like a type syntactically.
1225             _ => return None,
1226         };
1227
1228         Some(P(Ty { kind, id: self.id, span: self.span, tokens: None }))
1229     }
1230
1231     pub fn precedence(&self) -> ExprPrecedence {
1232         match self.kind {
1233             ExprKind::Box(_) => ExprPrecedence::Box,
1234             ExprKind::Array(_) => ExprPrecedence::Array,
1235             ExprKind::ConstBlock(_) => ExprPrecedence::ConstBlock,
1236             ExprKind::Call(..) => ExprPrecedence::Call,
1237             ExprKind::MethodCall(..) => ExprPrecedence::MethodCall,
1238             ExprKind::Tup(_) => ExprPrecedence::Tup,
1239             ExprKind::Binary(op, ..) => ExprPrecedence::Binary(op.node),
1240             ExprKind::Unary(..) => ExprPrecedence::Unary,
1241             ExprKind::Lit(_) | ExprKind::IncludedBytes(..) => ExprPrecedence::Lit,
1242             ExprKind::Type(..) | ExprKind::Cast(..) => ExprPrecedence::Cast,
1243             ExprKind::Let(..) => ExprPrecedence::Let,
1244             ExprKind::If(..) => ExprPrecedence::If,
1245             ExprKind::While(..) => ExprPrecedence::While,
1246             ExprKind::ForLoop(..) => ExprPrecedence::ForLoop,
1247             ExprKind::Loop(..) => ExprPrecedence::Loop,
1248             ExprKind::Match(..) => ExprPrecedence::Match,
1249             ExprKind::Closure(..) => ExprPrecedence::Closure,
1250             ExprKind::Block(..) => ExprPrecedence::Block,
1251             ExprKind::TryBlock(..) => ExprPrecedence::TryBlock,
1252             ExprKind::Async(..) => ExprPrecedence::Async,
1253             ExprKind::Await(..) => ExprPrecedence::Await,
1254             ExprKind::Assign(..) => ExprPrecedence::Assign,
1255             ExprKind::AssignOp(..) => ExprPrecedence::AssignOp,
1256             ExprKind::Field(..) => ExprPrecedence::Field,
1257             ExprKind::Index(..) => ExprPrecedence::Index,
1258             ExprKind::Range(..) => ExprPrecedence::Range,
1259             ExprKind::Underscore => ExprPrecedence::Path,
1260             ExprKind::Path(..) => ExprPrecedence::Path,
1261             ExprKind::AddrOf(..) => ExprPrecedence::AddrOf,
1262             ExprKind::Break(..) => ExprPrecedence::Break,
1263             ExprKind::Continue(..) => ExprPrecedence::Continue,
1264             ExprKind::Ret(..) => ExprPrecedence::Ret,
1265             ExprKind::InlineAsm(..) => ExprPrecedence::InlineAsm,
1266             ExprKind::MacCall(..) => ExprPrecedence::Mac,
1267             ExprKind::Struct(..) => ExprPrecedence::Struct,
1268             ExprKind::Repeat(..) => ExprPrecedence::Repeat,
1269             ExprKind::Paren(..) => ExprPrecedence::Paren,
1270             ExprKind::Try(..) => ExprPrecedence::Try,
1271             ExprKind::Yield(..) => ExprPrecedence::Yield,
1272             ExprKind::Yeet(..) => ExprPrecedence::Yeet,
1273             ExprKind::FormatArgs(..) => ExprPrecedence::FormatArgs,
1274             ExprKind::Err => ExprPrecedence::Err,
1275         }
1276     }
1277
1278     pub fn take(&mut self) -> Self {
1279         mem::replace(
1280             self,
1281             Expr {
1282                 id: DUMMY_NODE_ID,
1283                 kind: ExprKind::Err,
1284                 span: DUMMY_SP,
1285                 attrs: AttrVec::new(),
1286                 tokens: None,
1287             },
1288         )
1289     }
1290
1291     /// To a first-order approximation, is this a pattern?
1292     pub fn is_approximately_pattern(&self) -> bool {
1293         match &self.peel_parens().kind {
1294             ExprKind::Box(_)
1295             | ExprKind::Array(_)
1296             | ExprKind::Call(_, _)
1297             | ExprKind::Tup(_)
1298             | ExprKind::Lit(_)
1299             | ExprKind::Range(_, _, _)
1300             | ExprKind::Underscore
1301             | ExprKind::Path(_, _)
1302             | ExprKind::Struct(_) => true,
1303             _ => false,
1304         }
1305     }
1306 }
1307
1308 #[derive(Clone, Encodable, Decodable, Debug)]
1309 pub struct Closure {
1310     pub binder: ClosureBinder,
1311     pub capture_clause: CaptureBy,
1312     pub constness: Const,
1313     pub asyncness: Async,
1314     pub movability: Movability,
1315     pub fn_decl: P<FnDecl>,
1316     pub body: P<Expr>,
1317     /// The span of the declaration block: 'move |...| -> ...'
1318     pub fn_decl_span: Span,
1319     /// The span of the argument block `|...|`
1320     pub fn_arg_span: Span,
1321 }
1322
1323 /// Limit types of a range (inclusive or exclusive)
1324 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, Debug)]
1325 pub enum RangeLimits {
1326     /// Inclusive at the beginning, exclusive at the end
1327     HalfOpen,
1328     /// Inclusive at the beginning and end
1329     Closed,
1330 }
1331
1332 /// A method call (e.g. `x.foo::<Bar, Baz>(a, b, c)`).
1333 #[derive(Clone, Encodable, Decodable, Debug)]
1334 pub struct MethodCall {
1335     /// The method name and its generic arguments, e.g. `foo::<Bar, Baz>`.
1336     pub seg: PathSegment,
1337     /// The receiver, e.g. `x`.
1338     pub receiver: P<Expr>,
1339     /// The arguments, e.g. `a, b, c`.
1340     pub args: Vec<P<Expr>>,
1341     /// The span of the function, without the dot and receiver e.g. `foo::<Bar,
1342     /// Baz>(a, b, c)`.
1343     pub span: Span,
1344 }
1345
1346 #[derive(Clone, Encodable, Decodable, Debug)]
1347 pub enum StructRest {
1348     /// `..x`.
1349     Base(P<Expr>),
1350     /// `..`.
1351     Rest(Span),
1352     /// No trailing `..` or expression.
1353     None,
1354 }
1355
1356 #[derive(Clone, Encodable, Decodable, Debug)]
1357 pub struct StructExpr {
1358     pub qself: Option<P<QSelf>>,
1359     pub path: Path,
1360     pub fields: Vec<ExprField>,
1361     pub rest: StructRest,
1362 }
1363
1364 #[derive(Clone, Encodable, Decodable, Debug)]
1365 pub enum ExprKind {
1366     /// A `box x` expression.
1367     Box(P<Expr>),
1368     /// An array (`[a, b, c, d]`)
1369     Array(Vec<P<Expr>>),
1370     /// Allow anonymous constants from an inline `const` block
1371     ConstBlock(AnonConst),
1372     /// A function call
1373     ///
1374     /// The first field resolves to the function itself,
1375     /// and the second field is the list of arguments.
1376     /// This also represents calling the constructor of
1377     /// tuple-like ADTs such as tuple structs and enum variants.
1378     Call(P<Expr>, Vec<P<Expr>>),
1379     /// A method call (e.g. `x.foo::<Bar, Baz>(a, b, c)`).
1380     MethodCall(Box<MethodCall>),
1381     /// A tuple (e.g., `(a, b, c, d)`).
1382     Tup(Vec<P<Expr>>),
1383     /// A binary operation (e.g., `a + b`, `a * b`).
1384     Binary(BinOp, P<Expr>, P<Expr>),
1385     /// A unary operation (e.g., `!x`, `*x`).
1386     Unary(UnOp, P<Expr>),
1387     /// A literal (e.g., `1`, `"foo"`).
1388     Lit(token::Lit),
1389     /// A cast (e.g., `foo as f64`).
1390     Cast(P<Expr>, P<Ty>),
1391     /// A type ascription (e.g., `42: usize`).
1392     Type(P<Expr>, P<Ty>),
1393     /// A `let pat = expr` expression that is only semantically allowed in the condition
1394     /// of `if` / `while` expressions. (e.g., `if let 0 = x { .. }`).
1395     ///
1396     /// `Span` represents the whole `let pat = expr` statement.
1397     Let(P<Pat>, P<Expr>, Span),
1398     /// An `if` block, with an optional `else` block.
1399     ///
1400     /// `if expr { block } else { expr }`
1401     If(P<Expr>, P<Block>, Option<P<Expr>>),
1402     /// A while loop, with an optional label.
1403     ///
1404     /// `'label: while expr { block }`
1405     While(P<Expr>, P<Block>, Option<Label>),
1406     /// A `for` loop, with an optional label.
1407     ///
1408     /// `'label: for pat in expr { block }`
1409     ///
1410     /// This is desugared to a combination of `loop` and `match` expressions.
1411     ForLoop(P<Pat>, P<Expr>, P<Block>, Option<Label>),
1412     /// Conditionless loop (can be exited with `break`, `continue`, or `return`).
1413     ///
1414     /// `'label: loop { block }`
1415     Loop(P<Block>, Option<Label>, Span),
1416     /// A `match` block.
1417     Match(P<Expr>, Vec<Arm>),
1418     /// A closure (e.g., `move |a, b, c| a + b + c`).
1419     Closure(Box<Closure>),
1420     /// A block (`'label: { ... }`).
1421     Block(P<Block>, Option<Label>),
1422     /// An async block (`async move { ... }`).
1423     ///
1424     /// The `NodeId` is the `NodeId` for the closure that results from
1425     /// desugaring an async block, just like the NodeId field in the
1426     /// `Async::Yes` variant. This is necessary in order to create a def for the
1427     /// closure which can be used as a parent of any child defs. Defs
1428     /// created during lowering cannot be made the parent of any other
1429     /// preexisting defs.
1430     Async(CaptureBy, NodeId, P<Block>),
1431     /// An await expression (`my_future.await`).
1432     Await(P<Expr>),
1433
1434     /// A try block (`try { ... }`).
1435     TryBlock(P<Block>),
1436
1437     /// An assignment (`a = foo()`).
1438     /// The `Span` argument is the span of the `=` token.
1439     Assign(P<Expr>, P<Expr>, Span),
1440     /// An assignment with an operator.
1441     ///
1442     /// E.g., `a += 1`.
1443     AssignOp(BinOp, P<Expr>, P<Expr>),
1444     /// Access of a named (e.g., `obj.foo`) or unnamed (e.g., `obj.0`) struct field.
1445     Field(P<Expr>, Ident),
1446     /// An indexing operation (e.g., `foo[2]`).
1447     Index(P<Expr>, P<Expr>),
1448     /// A range (e.g., `1..2`, `1..`, `..2`, `1..=2`, `..=2`; and `..` in destructuring assignment).
1449     Range(Option<P<Expr>>, Option<P<Expr>>, RangeLimits),
1450     /// An underscore, used in destructuring assignment to ignore a value.
1451     Underscore,
1452
1453     /// Variable reference, possibly containing `::` and/or type
1454     /// parameters (e.g., `foo::bar::<baz>`).
1455     ///
1456     /// Optionally "qualified" (e.g., `<Vec<T> as SomeTrait>::SomeType`).
1457     Path(Option<P<QSelf>>, Path),
1458
1459     /// A referencing operation (`&a`, `&mut a`, `&raw const a` or `&raw mut a`).
1460     AddrOf(BorrowKind, Mutability, P<Expr>),
1461     /// A `break`, with an optional label to break, and an optional expression.
1462     Break(Option<Label>, Option<P<Expr>>),
1463     /// A `continue`, with an optional label.
1464     Continue(Option<Label>),
1465     /// A `return`, with an optional value to be returned.
1466     Ret(Option<P<Expr>>),
1467
1468     /// Output of the `asm!()` macro.
1469     InlineAsm(P<InlineAsm>),
1470
1471     /// A macro invocation; pre-expansion.
1472     MacCall(P<MacCall>),
1473
1474     /// A struct literal expression.
1475     ///
1476     /// E.g., `Foo {x: 1, y: 2}`, or `Foo {x: 1, .. rest}`.
1477     Struct(P<StructExpr>),
1478
1479     /// An array literal constructed from one repeated element.
1480     ///
1481     /// E.g., `[1; 5]`. The expression is the element to be
1482     /// repeated; the constant is the number of times to repeat it.
1483     Repeat(P<Expr>, AnonConst),
1484
1485     /// No-op: used solely so we can pretty-print faithfully.
1486     Paren(P<Expr>),
1487
1488     /// A try expression (`expr?`).
1489     Try(P<Expr>),
1490
1491     /// A `yield`, with an optional value to be yielded.
1492     Yield(Option<P<Expr>>),
1493
1494     /// A `do yeet` (aka `throw`/`fail`/`bail`/`raise`/whatever),
1495     /// with an optional value to be returned.
1496     Yeet(Option<P<Expr>>),
1497
1498     /// Bytes included via `include_bytes!`
1499     /// Added for optimization purposes to avoid the need to escape
1500     /// large binary blobs - should always behave like [`ExprKind::Lit`]
1501     /// with a `ByteStr` literal.
1502     IncludedBytes(Lrc<[u8]>),
1503
1504     /// A `format_args!()` expression.
1505     FormatArgs(P<FormatArgs>),
1506
1507     /// Placeholder for an expression that wasn't syntactically well formed in some way.
1508     Err,
1509 }
1510
1511 /// The explicit `Self` type in a "qualified path". The actual
1512 /// path, including the trait and the associated item, is stored
1513 /// separately. `position` represents the index of the associated
1514 /// item qualified with this `Self` type.
1515 ///
1516 /// ```ignore (only-for-syntax-highlight)
1517 /// <Vec<T> as a::b::Trait>::AssociatedItem
1518 ///  ^~~~~     ~~~~~~~~~~~~~~^
1519 ///  ty        position = 3
1520 ///
1521 /// <Vec<T>>::AssociatedItem
1522 ///  ^~~~~    ^
1523 ///  ty       position = 0
1524 /// ```
1525 #[derive(Clone, Encodable, Decodable, Debug)]
1526 pub struct QSelf {
1527     pub ty: P<Ty>,
1528
1529     /// The span of `a::b::Trait` in a path like `<Vec<T> as
1530     /// a::b::Trait>::AssociatedItem`; in the case where `position ==
1531     /// 0`, this is an empty span.
1532     pub path_span: Span,
1533     pub position: usize,
1534 }
1535
1536 /// A capture clause used in closures and `async` blocks.
1537 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
1538 pub enum CaptureBy {
1539     /// `move |x| y + x`.
1540     Value,
1541     /// `move` keyword was not specified.
1542     Ref,
1543 }
1544
1545 /// The movability of a generator / closure literal:
1546 /// whether a generator contains self-references, causing it to be `!Unpin`.
1547 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Encodable, Decodable, Debug, Copy)]
1548 #[derive(HashStable_Generic)]
1549 pub enum Movability {
1550     /// May contain self-references, `!Unpin`.
1551     Static,
1552     /// Must not contain self-references, `Unpin`.
1553     Movable,
1554 }
1555
1556 /// Closure lifetime binder, `for<'a, 'b>` in `for<'a, 'b> |_: &'a (), _: &'b ()|`.
1557 #[derive(Clone, Encodable, Decodable, Debug)]
1558 pub enum ClosureBinder {
1559     /// The binder is not present, all closure lifetimes are inferred.
1560     NotPresent,
1561     /// The binder is present.
1562     For {
1563         /// Span of the whole `for<>` clause
1564         ///
1565         /// ```text
1566         /// for<'a, 'b> |_: &'a (), _: &'b ()| { ... }
1567         /// ^^^^^^^^^^^ -- this
1568         /// ```
1569         span: Span,
1570
1571         /// Lifetimes in the `for<>` closure
1572         ///
1573         /// ```text
1574         /// for<'a, 'b> |_: &'a (), _: &'b ()| { ... }
1575         ///     ^^^^^^ -- this
1576         /// ```
1577         generic_params: P<[GenericParam]>,
1578     },
1579 }
1580
1581 /// Represents a macro invocation. The `path` indicates which macro
1582 /// is being invoked, and the `args` are arguments passed to it.
1583 #[derive(Clone, Encodable, Decodable, Debug)]
1584 pub struct MacCall {
1585     pub path: Path,
1586     pub args: P<DelimArgs>,
1587     pub prior_type_ascription: Option<(Span, bool)>,
1588 }
1589
1590 impl MacCall {
1591     pub fn span(&self) -> Span {
1592         self.path.span.to(self.args.dspan.entire())
1593     }
1594 }
1595
1596 /// Arguments passed to an attribute macro.
1597 #[derive(Clone, Encodable, Decodable, Debug)]
1598 pub enum AttrArgs {
1599     /// No arguments: `#[attr]`.
1600     Empty,
1601     /// Delimited arguments: `#[attr()/[]/{}]`.
1602     Delimited(DelimArgs),
1603     /// Arguments of a key-value attribute: `#[attr = "value"]`.
1604     Eq(
1605         /// Span of the `=` token.
1606         Span,
1607         /// The "value".
1608         AttrArgsEq,
1609     ),
1610 }
1611
1612 // The RHS of an `AttrArgs::Eq` starts out as an expression. Once macro
1613 // expansion is completed, all cases end up either as a meta item literal,
1614 // which is the form used after lowering to HIR, or as an error.
1615 #[derive(Clone, Encodable, Decodable, Debug)]
1616 pub enum AttrArgsEq {
1617     Ast(P<Expr>),
1618     Hir(MetaItemLit),
1619 }
1620
1621 impl AttrArgs {
1622     pub fn span(&self) -> Option<Span> {
1623         match self {
1624             AttrArgs::Empty => None,
1625             AttrArgs::Delimited(args) => Some(args.dspan.entire()),
1626             AttrArgs::Eq(eq_span, AttrArgsEq::Ast(expr)) => Some(eq_span.to(expr.span)),
1627             AttrArgs::Eq(_, AttrArgsEq::Hir(lit)) => {
1628                 unreachable!("in literal form when getting span: {:?}", lit);
1629             }
1630         }
1631     }
1632
1633     /// Tokens inside the delimiters or after `=`.
1634     /// Proc macros see these tokens, for example.
1635     pub fn inner_tokens(&self) -> TokenStream {
1636         match self {
1637             AttrArgs::Empty => TokenStream::default(),
1638             AttrArgs::Delimited(args) => args.tokens.clone(),
1639             AttrArgs::Eq(_, AttrArgsEq::Ast(expr)) => TokenStream::from_ast(expr),
1640             AttrArgs::Eq(_, AttrArgsEq::Hir(lit)) => {
1641                 unreachable!("in literal form when getting inner tokens: {:?}", lit)
1642             }
1643         }
1644     }
1645 }
1646
1647 impl<CTX> HashStable<CTX> for AttrArgs
1648 where
1649     CTX: crate::HashStableContext,
1650 {
1651     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
1652         mem::discriminant(self).hash_stable(ctx, hasher);
1653         match self {
1654             AttrArgs::Empty => {}
1655             AttrArgs::Delimited(args) => args.hash_stable(ctx, hasher),
1656             AttrArgs::Eq(_eq_span, AttrArgsEq::Ast(expr)) => {
1657                 unreachable!("hash_stable {:?}", expr);
1658             }
1659             AttrArgs::Eq(eq_span, AttrArgsEq::Hir(lit)) => {
1660                 eq_span.hash_stable(ctx, hasher);
1661                 lit.hash_stable(ctx, hasher);
1662             }
1663         }
1664     }
1665 }
1666
1667 /// Delimited arguments, as used in `#[attr()/[]/{}]` or `mac!()/[]/{}`.
1668 #[derive(Clone, Encodable, Decodable, Debug)]
1669 pub struct DelimArgs {
1670     pub dspan: DelimSpan,
1671     pub delim: MacDelimiter,
1672     pub tokens: TokenStream,
1673 }
1674
1675 impl DelimArgs {
1676     /// Whether a macro with these arguments needs a semicolon
1677     /// when used as a standalone item or statement.
1678     pub fn need_semicolon(&self) -> bool {
1679         !matches!(self, DelimArgs { delim: MacDelimiter::Brace, .. })
1680     }
1681 }
1682
1683 impl<CTX> HashStable<CTX> for DelimArgs
1684 where
1685     CTX: crate::HashStableContext,
1686 {
1687     fn hash_stable(&self, ctx: &mut CTX, hasher: &mut StableHasher) {
1688         let DelimArgs { dspan, delim, tokens } = self;
1689         dspan.hash_stable(ctx, hasher);
1690         delim.hash_stable(ctx, hasher);
1691         tokens.hash_stable(ctx, hasher);
1692     }
1693 }
1694
1695 #[derive(Copy, Clone, PartialEq, Eq, Encodable, Decodable, Debug, HashStable_Generic)]
1696 pub enum MacDelimiter {
1697     Parenthesis,
1698     Bracket,
1699     Brace,
1700 }
1701
1702 impl MacDelimiter {
1703     pub fn to_token(self) -> Delimiter {
1704         match self {
1705             MacDelimiter::Parenthesis => Delimiter::Parenthesis,
1706             MacDelimiter::Bracket => Delimiter::Bracket,
1707             MacDelimiter::Brace => Delimiter::Brace,
1708         }
1709     }
1710
1711     pub fn from_token(delim: Delimiter) -> Option<MacDelimiter> {
1712         match delim {
1713             Delimiter::Parenthesis => Some(MacDelimiter::Parenthesis),
1714             Delimiter::Bracket => Some(MacDelimiter::Bracket),
1715             Delimiter::Brace => Some(MacDelimiter::Brace),
1716             Delimiter::Invisible => None,
1717         }
1718     }
1719 }
1720
1721 /// Represents a macro definition.
1722 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
1723 pub struct MacroDef {
1724     pub body: P<DelimArgs>,
1725     /// `true` if macro was defined with `macro_rules`.
1726     pub macro_rules: bool,
1727 }
1728
1729 #[derive(Clone, Encodable, Decodable, Debug, Copy, Hash, Eq, PartialEq)]
1730 #[derive(HashStable_Generic)]
1731 pub enum StrStyle {
1732     /// A regular string, like `"foo"`.
1733     Cooked,
1734     /// A raw string, like `r##"foo"##`.
1735     ///
1736     /// The value is the number of `#` symbols used.
1737     Raw(u8),
1738 }
1739
1740 /// A literal in a meta item.
1741 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
1742 pub struct MetaItemLit {
1743     /// The original literal as written in the source code.
1744     pub symbol: Symbol,
1745     /// The original suffix as written in the source code.
1746     pub suffix: Option<Symbol>,
1747     /// The "semantic" representation of the literal lowered from the original tokens.
1748     /// Strings are unescaped, hexadecimal forms are eliminated, etc.
1749     pub kind: LitKind,
1750     pub span: Span,
1751 }
1752
1753 /// Similar to `MetaItemLit`, but restricted to string literals.
1754 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
1755 pub struct StrLit {
1756     /// The original literal as written in source code.
1757     pub symbol: Symbol,
1758     /// The original suffix as written in source code.
1759     pub suffix: Option<Symbol>,
1760     /// The semantic (unescaped) representation of the literal.
1761     pub symbol_unescaped: Symbol,
1762     pub style: StrStyle,
1763     pub span: Span,
1764 }
1765
1766 impl StrLit {
1767     pub fn as_token_lit(&self) -> token::Lit {
1768         let token_kind = match self.style {
1769             StrStyle::Cooked => token::Str,
1770             StrStyle::Raw(n) => token::StrRaw(n),
1771         };
1772         token::Lit::new(token_kind, self.symbol, self.suffix)
1773     }
1774 }
1775
1776 /// Type of the integer literal based on provided suffix.
1777 #[derive(Clone, Copy, Encodable, Decodable, Debug, Hash, Eq, PartialEq)]
1778 #[derive(HashStable_Generic)]
1779 pub enum LitIntType {
1780     /// e.g. `42_i32`.
1781     Signed(IntTy),
1782     /// e.g. `42_u32`.
1783     Unsigned(UintTy),
1784     /// e.g. `42`.
1785     Unsuffixed,
1786 }
1787
1788 /// Type of the float literal based on provided suffix.
1789 #[derive(Clone, Copy, Encodable, Decodable, Debug, Hash, Eq, PartialEq)]
1790 #[derive(HashStable_Generic)]
1791 pub enum LitFloatType {
1792     /// A float literal with a suffix (`1f32` or `1E10f32`).
1793     Suffixed(FloatTy),
1794     /// A float literal without a suffix (`1.0 or 1.0E10`).
1795     Unsuffixed,
1796 }
1797
1798 /// This type is used within both `ast::MetaItemLit` and `hir::Lit`.
1799 ///
1800 /// Note that the entire literal (including the suffix) is considered when
1801 /// deciding the `LitKind`. This means that float literals like `1f32` are
1802 /// classified by this type as `Float`. This is different to `token::LitKind`
1803 /// which does *not* consider the suffix.
1804 #[derive(Clone, Encodable, Decodable, Debug, Hash, Eq, PartialEq, HashStable_Generic)]
1805 pub enum LitKind {
1806     /// A string literal (`"foo"`). The symbol is unescaped, and so may differ
1807     /// from the original token's symbol.
1808     Str(Symbol, StrStyle),
1809     /// A byte string (`b"foo"`). Not stored as a symbol because it might be
1810     /// non-utf8, and symbols only allow utf8 strings.
1811     ByteStr(Lrc<[u8]>, StrStyle),
1812     /// A byte char (`b'f'`).
1813     Byte(u8),
1814     /// A character literal (`'a'`).
1815     Char(char),
1816     /// An integer literal (`1`).
1817     Int(u128, LitIntType),
1818     /// A float literal (`1.0`, `1f64` or `1E10f64`). The pre-suffix part is
1819     /// stored as a symbol rather than `f64` so that `LitKind` can impl `Eq`
1820     /// and `Hash`.
1821     Float(Symbol, LitFloatType),
1822     /// A boolean literal (`true`, `false`).
1823     Bool(bool),
1824     /// Placeholder for a literal that wasn't well-formed in some way.
1825     Err,
1826 }
1827
1828 impl LitKind {
1829     /// Returns `true` if this literal is a string.
1830     pub fn is_str(&self) -> bool {
1831         matches!(self, LitKind::Str(..))
1832     }
1833
1834     /// Returns `true` if this literal is byte literal string.
1835     pub fn is_bytestr(&self) -> bool {
1836         matches!(self, LitKind::ByteStr(..))
1837     }
1838
1839     /// Returns `true` if this is a numeric literal.
1840     pub fn is_numeric(&self) -> bool {
1841         matches!(self, LitKind::Int(..) | LitKind::Float(..))
1842     }
1843
1844     /// Returns `true` if this literal has no suffix.
1845     /// Note: this will return true for literals with prefixes such as raw strings and byte strings.
1846     pub fn is_unsuffixed(&self) -> bool {
1847         !self.is_suffixed()
1848     }
1849
1850     /// Returns `true` if this literal has a suffix.
1851     pub fn is_suffixed(&self) -> bool {
1852         match *self {
1853             // suffixed variants
1854             LitKind::Int(_, LitIntType::Signed(..) | LitIntType::Unsigned(..))
1855             | LitKind::Float(_, LitFloatType::Suffixed(..)) => true,
1856             // unsuffixed variants
1857             LitKind::Str(..)
1858             | LitKind::ByteStr(..)
1859             | LitKind::Byte(..)
1860             | LitKind::Char(..)
1861             | LitKind::Int(_, LitIntType::Unsuffixed)
1862             | LitKind::Float(_, LitFloatType::Unsuffixed)
1863             | LitKind::Bool(..)
1864             | LitKind::Err => false,
1865         }
1866     }
1867 }
1868
1869 // N.B., If you change this, you'll probably want to change the corresponding
1870 // type structure in `middle/ty.rs` as well.
1871 #[derive(Clone, Encodable, Decodable, Debug)]
1872 pub struct MutTy {
1873     pub ty: P<Ty>,
1874     pub mutbl: Mutability,
1875 }
1876
1877 /// Represents a function's signature in a trait declaration,
1878 /// trait implementation, or free function.
1879 #[derive(Clone, Encodable, Decodable, Debug)]
1880 pub struct FnSig {
1881     pub header: FnHeader,
1882     pub decl: P<FnDecl>,
1883     pub span: Span,
1884 }
1885
1886 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
1887 #[derive(Encodable, Decodable, HashStable_Generic)]
1888 pub enum FloatTy {
1889     F32,
1890     F64,
1891 }
1892
1893 impl FloatTy {
1894     pub fn name_str(self) -> &'static str {
1895         match self {
1896             FloatTy::F32 => "f32",
1897             FloatTy::F64 => "f64",
1898         }
1899     }
1900
1901     pub fn name(self) -> Symbol {
1902         match self {
1903             FloatTy::F32 => sym::f32,
1904             FloatTy::F64 => sym::f64,
1905         }
1906     }
1907 }
1908
1909 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
1910 #[derive(Encodable, Decodable, HashStable_Generic)]
1911 pub enum IntTy {
1912     Isize,
1913     I8,
1914     I16,
1915     I32,
1916     I64,
1917     I128,
1918 }
1919
1920 impl IntTy {
1921     pub fn name_str(&self) -> &'static str {
1922         match *self {
1923             IntTy::Isize => "isize",
1924             IntTy::I8 => "i8",
1925             IntTy::I16 => "i16",
1926             IntTy::I32 => "i32",
1927             IntTy::I64 => "i64",
1928             IntTy::I128 => "i128",
1929         }
1930     }
1931
1932     pub fn name(&self) -> Symbol {
1933         match *self {
1934             IntTy::Isize => sym::isize,
1935             IntTy::I8 => sym::i8,
1936             IntTy::I16 => sym::i16,
1937             IntTy::I32 => sym::i32,
1938             IntTy::I64 => sym::i64,
1939             IntTy::I128 => sym::i128,
1940         }
1941     }
1942 }
1943
1944 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, Debug)]
1945 #[derive(Encodable, Decodable, HashStable_Generic)]
1946 pub enum UintTy {
1947     Usize,
1948     U8,
1949     U16,
1950     U32,
1951     U64,
1952     U128,
1953 }
1954
1955 impl UintTy {
1956     pub fn name_str(&self) -> &'static str {
1957         match *self {
1958             UintTy::Usize => "usize",
1959             UintTy::U8 => "u8",
1960             UintTy::U16 => "u16",
1961             UintTy::U32 => "u32",
1962             UintTy::U64 => "u64",
1963             UintTy::U128 => "u128",
1964         }
1965     }
1966
1967     pub fn name(&self) -> Symbol {
1968         match *self {
1969             UintTy::Usize => sym::usize,
1970             UintTy::U8 => sym::u8,
1971             UintTy::U16 => sym::u16,
1972             UintTy::U32 => sym::u32,
1973             UintTy::U64 => sym::u64,
1974             UintTy::U128 => sym::u128,
1975         }
1976     }
1977 }
1978
1979 /// A constraint on an associated type (e.g., `A = Bar` in `Foo<A = Bar>` or
1980 /// `A: TraitA + TraitB` in `Foo<A: TraitA + TraitB>`).
1981 #[derive(Clone, Encodable, Decodable, Debug)]
1982 pub struct AssocConstraint {
1983     pub id: NodeId,
1984     pub ident: Ident,
1985     pub gen_args: Option<GenericArgs>,
1986     pub kind: AssocConstraintKind,
1987     pub span: Span,
1988 }
1989
1990 /// The kinds of an `AssocConstraint`.
1991 #[derive(Clone, Encodable, Decodable, Debug)]
1992 pub enum Term {
1993     Ty(P<Ty>),
1994     Const(AnonConst),
1995 }
1996
1997 impl From<P<Ty>> for Term {
1998     fn from(v: P<Ty>) -> Self {
1999         Term::Ty(v)
2000     }
2001 }
2002
2003 impl From<AnonConst> for Term {
2004     fn from(v: AnonConst) -> Self {
2005         Term::Const(v)
2006     }
2007 }
2008
2009 /// The kinds of an `AssocConstraint`.
2010 #[derive(Clone, Encodable, Decodable, Debug)]
2011 pub enum AssocConstraintKind {
2012     /// E.g., `A = Bar`, `A = 3` in `Foo<A = Bar>` where A is an associated type.
2013     Equality { term: Term },
2014     /// E.g. `A: TraitA + TraitB` in `Foo<A: TraitA + TraitB>`.
2015     Bound { bounds: GenericBounds },
2016 }
2017
2018 #[derive(Encodable, Decodable, Debug)]
2019 pub struct Ty {
2020     pub id: NodeId,
2021     pub kind: TyKind,
2022     pub span: Span,
2023     pub tokens: Option<LazyAttrTokenStream>,
2024 }
2025
2026 impl Clone for Ty {
2027     fn clone(&self) -> Self {
2028         ensure_sufficient_stack(|| Self {
2029             id: self.id,
2030             kind: self.kind.clone(),
2031             span: self.span,
2032             tokens: self.tokens.clone(),
2033         })
2034     }
2035 }
2036
2037 impl Ty {
2038     pub fn peel_refs(&self) -> &Self {
2039         let mut final_ty = self;
2040         while let TyKind::Ref(_, MutTy { ty, .. }) | TyKind::Ptr(MutTy { ty, .. }) = &final_ty.kind
2041         {
2042             final_ty = ty;
2043         }
2044         final_ty
2045     }
2046 }
2047
2048 #[derive(Clone, Encodable, Decodable, Debug)]
2049 pub struct BareFnTy {
2050     pub unsafety: Unsafe,
2051     pub ext: Extern,
2052     pub generic_params: Vec<GenericParam>,
2053     pub decl: P<FnDecl>,
2054     /// Span of the `fn(...) -> ...` part.
2055     pub decl_span: Span,
2056 }
2057
2058 /// The various kinds of type recognized by the compiler.
2059 #[derive(Clone, Encodable, Decodable, Debug)]
2060 pub enum TyKind {
2061     /// A variable-length slice (`[T]`).
2062     Slice(P<Ty>),
2063     /// A fixed length array (`[T; n]`).
2064     Array(P<Ty>, AnonConst),
2065     /// A raw pointer (`*const T` or `*mut T`).
2066     Ptr(MutTy),
2067     /// A reference (`&'a T` or `&'a mut T`).
2068     Ref(Option<Lifetime>, MutTy),
2069     /// A bare function (e.g., `fn(usize) -> bool`).
2070     BareFn(P<BareFnTy>),
2071     /// The never type (`!`).
2072     Never,
2073     /// A tuple (`(A, B, C, D,...)`).
2074     Tup(Vec<P<Ty>>),
2075     /// A path (`module::module::...::Type`), optionally
2076     /// "qualified", e.g., `<Vec<T> as SomeTrait>::SomeType`.
2077     ///
2078     /// Type parameters are stored in the `Path` itself.
2079     Path(Option<P<QSelf>>, Path),
2080     /// A trait object type `Bound1 + Bound2 + Bound3`
2081     /// where `Bound` is a trait or a lifetime.
2082     TraitObject(GenericBounds, TraitObjectSyntax),
2083     /// An `impl Bound1 + Bound2 + Bound3` type
2084     /// where `Bound` is a trait or a lifetime.
2085     ///
2086     /// The `NodeId` exists to prevent lowering from having to
2087     /// generate `NodeId`s on the fly, which would complicate
2088     /// the generation of opaque `type Foo = impl Trait` items significantly.
2089     ImplTrait(NodeId, GenericBounds),
2090     /// No-op; kept solely so that we can pretty-print faithfully.
2091     Paren(P<Ty>),
2092     /// Unused for now.
2093     Typeof(AnonConst),
2094     /// This means the type should be inferred instead of it having been
2095     /// specified. This can appear anywhere in a type.
2096     Infer,
2097     /// Inferred type of a `self` or `&self` argument in a method.
2098     ImplicitSelf,
2099     /// A macro in the type position.
2100     MacCall(P<MacCall>),
2101     /// Placeholder for a kind that has failed to be defined.
2102     Err,
2103     /// Placeholder for a `va_list`.
2104     CVarArgs,
2105 }
2106
2107 impl TyKind {
2108     pub fn is_implicit_self(&self) -> bool {
2109         matches!(self, TyKind::ImplicitSelf)
2110     }
2111
2112     pub fn is_unit(&self) -> bool {
2113         matches!(self, TyKind::Tup(tys) if tys.is_empty())
2114     }
2115
2116     pub fn is_simple_path(&self) -> Option<Symbol> {
2117         if let TyKind::Path(None, Path { segments, .. }) = &self
2118             && let [segment] = &segments[..]
2119             && segment.args.is_none()
2120         {
2121             Some(segment.ident.name)
2122         } else {
2123             None
2124         }
2125     }
2126 }
2127
2128 /// Syntax used to declare a trait object.
2129 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
2130 pub enum TraitObjectSyntax {
2131     Dyn,
2132     DynStar,
2133     None,
2134 }
2135
2136 /// Inline assembly operand explicit register or register class.
2137 ///
2138 /// E.g., `"eax"` as in `asm!("mov eax, 2", out("eax") result)`.
2139 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
2140 pub enum InlineAsmRegOrRegClass {
2141     Reg(Symbol),
2142     RegClass(Symbol),
2143 }
2144
2145 bitflags::bitflags! {
2146     #[derive(Encodable, Decodable, HashStable_Generic)]
2147     pub struct InlineAsmOptions: u16 {
2148         const PURE            = 1 << 0;
2149         const NOMEM           = 1 << 1;
2150         const READONLY        = 1 << 2;
2151         const PRESERVES_FLAGS = 1 << 3;
2152         const NORETURN        = 1 << 4;
2153         const NOSTACK         = 1 << 5;
2154         const ATT_SYNTAX      = 1 << 6;
2155         const RAW             = 1 << 7;
2156         const MAY_UNWIND      = 1 << 8;
2157     }
2158 }
2159
2160 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Hash, HashStable_Generic)]
2161 pub enum InlineAsmTemplatePiece {
2162     String(String),
2163     Placeholder { operand_idx: usize, modifier: Option<char>, span: Span },
2164 }
2165
2166 impl fmt::Display for InlineAsmTemplatePiece {
2167     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2168         match self {
2169             Self::String(s) => {
2170                 for c in s.chars() {
2171                     match c {
2172                         '{' => f.write_str("{{")?,
2173                         '}' => f.write_str("}}")?,
2174                         _ => c.fmt(f)?,
2175                     }
2176                 }
2177                 Ok(())
2178             }
2179             Self::Placeholder { operand_idx, modifier: Some(modifier), .. } => {
2180                 write!(f, "{{{operand_idx}:{modifier}}}")
2181             }
2182             Self::Placeholder { operand_idx, modifier: None, .. } => {
2183                 write!(f, "{{{operand_idx}}}")
2184             }
2185         }
2186     }
2187 }
2188
2189 impl InlineAsmTemplatePiece {
2190     /// Rebuilds the asm template string from its pieces.
2191     pub fn to_string(s: &[Self]) -> String {
2192         use fmt::Write;
2193         let mut out = String::new();
2194         for p in s.iter() {
2195             let _ = write!(out, "{p}");
2196         }
2197         out
2198     }
2199 }
2200
2201 /// Inline assembly symbol operands get their own AST node that is somewhat
2202 /// similar to `AnonConst`.
2203 ///
2204 /// The main difference is that we specifically don't assign it `DefId` in
2205 /// `DefCollector`. Instead this is deferred until AST lowering where we
2206 /// lower it to an `AnonConst` (for functions) or a `Path` (for statics)
2207 /// depending on what the path resolves to.
2208 #[derive(Clone, Encodable, Decodable, Debug)]
2209 pub struct InlineAsmSym {
2210     pub id: NodeId,
2211     pub qself: Option<P<QSelf>>,
2212     pub path: Path,
2213 }
2214
2215 /// Inline assembly operand.
2216 ///
2217 /// E.g., `out("eax") result` as in `asm!("mov eax, 2", out("eax") result)`.
2218 #[derive(Clone, Encodable, Decodable, Debug)]
2219 pub enum InlineAsmOperand {
2220     In {
2221         reg: InlineAsmRegOrRegClass,
2222         expr: P<Expr>,
2223     },
2224     Out {
2225         reg: InlineAsmRegOrRegClass,
2226         late: bool,
2227         expr: Option<P<Expr>>,
2228     },
2229     InOut {
2230         reg: InlineAsmRegOrRegClass,
2231         late: bool,
2232         expr: P<Expr>,
2233     },
2234     SplitInOut {
2235         reg: InlineAsmRegOrRegClass,
2236         late: bool,
2237         in_expr: P<Expr>,
2238         out_expr: Option<P<Expr>>,
2239     },
2240     Const {
2241         anon_const: AnonConst,
2242     },
2243     Sym {
2244         sym: InlineAsmSym,
2245     },
2246 }
2247
2248 /// Inline assembly.
2249 ///
2250 /// E.g., `asm!("NOP");`.
2251 #[derive(Clone, Encodable, Decodable, Debug)]
2252 pub struct InlineAsm {
2253     pub template: Vec<InlineAsmTemplatePiece>,
2254     pub template_strs: Box<[(Symbol, Option<Symbol>, Span)]>,
2255     pub operands: Vec<(InlineAsmOperand, Span)>,
2256     pub clobber_abis: Vec<(Symbol, Span)>,
2257     pub options: InlineAsmOptions,
2258     pub line_spans: Vec<Span>,
2259 }
2260
2261 /// A parameter in a function header.
2262 ///
2263 /// E.g., `bar: usize` as in `fn foo(bar: usize)`.
2264 #[derive(Clone, Encodable, Decodable, Debug)]
2265 pub struct Param {
2266     pub attrs: AttrVec,
2267     pub ty: P<Ty>,
2268     pub pat: P<Pat>,
2269     pub id: NodeId,
2270     pub span: Span,
2271     pub is_placeholder: bool,
2272 }
2273
2274 /// Alternative representation for `Arg`s describing `self` parameter of methods.
2275 ///
2276 /// E.g., `&mut self` as in `fn foo(&mut self)`.
2277 #[derive(Clone, Encodable, Decodable, Debug)]
2278 pub enum SelfKind {
2279     /// `self`, `mut self`
2280     Value(Mutability),
2281     /// `&'lt self`, `&'lt mut self`
2282     Region(Option<Lifetime>, Mutability),
2283     /// `self: TYPE`, `mut self: TYPE`
2284     Explicit(P<Ty>, Mutability),
2285 }
2286
2287 pub type ExplicitSelf = Spanned<SelfKind>;
2288
2289 impl Param {
2290     /// Attempts to cast parameter to `ExplicitSelf`.
2291     pub fn to_self(&self) -> Option<ExplicitSelf> {
2292         if let PatKind::Ident(BindingAnnotation(ByRef::No, mutbl), ident, _) = self.pat.kind {
2293             if ident.name == kw::SelfLower {
2294                 return match self.ty.kind {
2295                     TyKind::ImplicitSelf => Some(respan(self.pat.span, SelfKind::Value(mutbl))),
2296                     TyKind::Ref(lt, MutTy { ref ty, mutbl }) if ty.kind.is_implicit_self() => {
2297                         Some(respan(self.pat.span, SelfKind::Region(lt, mutbl)))
2298                     }
2299                     _ => Some(respan(
2300                         self.pat.span.to(self.ty.span),
2301                         SelfKind::Explicit(self.ty.clone(), mutbl),
2302                     )),
2303                 };
2304             }
2305         }
2306         None
2307     }
2308
2309     /// Returns `true` if parameter is `self`.
2310     pub fn is_self(&self) -> bool {
2311         if let PatKind::Ident(_, ident, _) = self.pat.kind {
2312             ident.name == kw::SelfLower
2313         } else {
2314             false
2315         }
2316     }
2317
2318     /// Builds a `Param` object from `ExplicitSelf`.
2319     pub fn from_self(attrs: AttrVec, eself: ExplicitSelf, eself_ident: Ident) -> Param {
2320         let span = eself.span.to(eself_ident.span);
2321         let infer_ty = P(Ty { id: DUMMY_NODE_ID, kind: TyKind::ImplicitSelf, span, tokens: None });
2322         let (mutbl, ty) = match eself.node {
2323             SelfKind::Explicit(ty, mutbl) => (mutbl, ty),
2324             SelfKind::Value(mutbl) => (mutbl, infer_ty),
2325             SelfKind::Region(lt, mutbl) => (
2326                 Mutability::Not,
2327                 P(Ty {
2328                     id: DUMMY_NODE_ID,
2329                     kind: TyKind::Ref(lt, MutTy { ty: infer_ty, mutbl }),
2330                     span,
2331                     tokens: None,
2332                 }),
2333             ),
2334         };
2335         Param {
2336             attrs,
2337             pat: P(Pat {
2338                 id: DUMMY_NODE_ID,
2339                 kind: PatKind::Ident(BindingAnnotation(ByRef::No, mutbl), eself_ident, None),
2340                 span,
2341                 tokens: None,
2342             }),
2343             span,
2344             ty,
2345             id: DUMMY_NODE_ID,
2346             is_placeholder: false,
2347         }
2348     }
2349 }
2350
2351 /// A signature (not the body) of a function declaration.
2352 ///
2353 /// E.g., `fn foo(bar: baz)`.
2354 ///
2355 /// Please note that it's different from `FnHeader` structure
2356 /// which contains metadata about function safety, asyncness, constness and ABI.
2357 #[derive(Clone, Encodable, Decodable, Debug)]
2358 pub struct FnDecl {
2359     pub inputs: Vec<Param>,
2360     pub output: FnRetTy,
2361 }
2362
2363 impl FnDecl {
2364     pub fn has_self(&self) -> bool {
2365         self.inputs.get(0).map_or(false, Param::is_self)
2366     }
2367     pub fn c_variadic(&self) -> bool {
2368         self.inputs.last().map_or(false, |arg| matches!(arg.ty.kind, TyKind::CVarArgs))
2369     }
2370 }
2371
2372 /// Is the trait definition an auto trait?
2373 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
2374 pub enum IsAuto {
2375     Yes,
2376     No,
2377 }
2378
2379 #[derive(Copy, Clone, PartialEq, Eq, Hash, Encodable, Decodable, Debug)]
2380 #[derive(HashStable_Generic)]
2381 pub enum Unsafe {
2382     Yes(Span),
2383     No,
2384 }
2385
2386 #[derive(Copy, Clone, Encodable, Decodable, Debug)]
2387 pub enum Async {
2388     Yes { span: Span, closure_id: NodeId, return_impl_trait_id: NodeId },
2389     No,
2390 }
2391
2392 impl Async {
2393     pub fn is_async(self) -> bool {
2394         matches!(self, Async::Yes { .. })
2395     }
2396
2397     /// In this case this is an `async` return, the `NodeId` for the generated `impl Trait` item.
2398     pub fn opt_return_id(self) -> Option<(NodeId, Span)> {
2399         match self {
2400             Async::Yes { return_impl_trait_id, span, .. } => Some((return_impl_trait_id, span)),
2401             Async::No => None,
2402         }
2403     }
2404 }
2405
2406 #[derive(Copy, Clone, PartialEq, Eq, Hash, Encodable, Decodable, Debug)]
2407 #[derive(HashStable_Generic)]
2408 pub enum Const {
2409     Yes(Span),
2410     No,
2411 }
2412
2413 /// Item defaultness.
2414 /// For details see the [RFC #2532](https://github.com/rust-lang/rfcs/pull/2532).
2415 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
2416 pub enum Defaultness {
2417     Default(Span),
2418     Final,
2419 }
2420
2421 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, HashStable_Generic)]
2422 pub enum ImplPolarity {
2423     /// `impl Trait for Type`
2424     Positive,
2425     /// `impl !Trait for Type`
2426     Negative(Span),
2427 }
2428
2429 impl fmt::Debug for ImplPolarity {
2430     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2431         match *self {
2432             ImplPolarity::Positive => "positive".fmt(f),
2433             ImplPolarity::Negative(_) => "negative".fmt(f),
2434         }
2435     }
2436 }
2437
2438 #[derive(Clone, Encodable, Decodable, Debug)]
2439 pub enum FnRetTy {
2440     /// Returns type is not specified.
2441     ///
2442     /// Functions default to `()` and closures default to inference.
2443     /// Span points to where return type would be inserted.
2444     Default(Span),
2445     /// Everything else.
2446     Ty(P<Ty>),
2447 }
2448
2449 impl FnRetTy {
2450     pub fn span(&self) -> Span {
2451         match self {
2452             &FnRetTy::Default(span) => span,
2453             FnRetTy::Ty(ty) => ty.span,
2454         }
2455     }
2456 }
2457
2458 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug)]
2459 pub enum Inline {
2460     Yes,
2461     No,
2462 }
2463
2464 /// Module item kind.
2465 #[derive(Clone, Encodable, Decodable, Debug)]
2466 pub enum ModKind {
2467     /// Module with inlined definition `mod foo { ... }`,
2468     /// or with definition outlined to a separate file `mod foo;` and already loaded from it.
2469     /// The inner span is from the first token past `{` to the last token until `}`,
2470     /// or from the first to the last token in the loaded file.
2471     Loaded(Vec<P<Item>>, Inline, ModSpans),
2472     /// Module with definition outlined to a separate file `mod foo;` but not yet loaded from it.
2473     Unloaded,
2474 }
2475
2476 #[derive(Copy, Clone, Encodable, Decodable, Debug, Default)]
2477 pub struct ModSpans {
2478     /// `inner_span` covers the body of the module; for a file module, its the whole file.
2479     /// For an inline module, its the span inside the `{ ... }`, not including the curly braces.
2480     pub inner_span: Span,
2481     pub inject_use_span: Span,
2482 }
2483
2484 /// Foreign module declaration.
2485 ///
2486 /// E.g., `extern { .. }` or `extern "C" { .. }`.
2487 #[derive(Clone, Encodable, Decodable, Debug)]
2488 pub struct ForeignMod {
2489     /// `unsafe` keyword accepted syntactically for macro DSLs, but not
2490     /// semantically by Rust.
2491     pub unsafety: Unsafe,
2492     pub abi: Option<StrLit>,
2493     pub items: Vec<P<ForeignItem>>,
2494 }
2495
2496 #[derive(Clone, Encodable, Decodable, Debug)]
2497 pub struct EnumDef {
2498     pub variants: Vec<Variant>,
2499 }
2500 /// Enum variant.
2501 #[derive(Clone, Encodable, Decodable, Debug)]
2502 pub struct Variant {
2503     /// Attributes of the variant.
2504     pub attrs: AttrVec,
2505     /// Id of the variant (not the constructor, see `VariantData::ctor_id()`).
2506     pub id: NodeId,
2507     /// Span
2508     pub span: Span,
2509     /// The visibility of the variant. Syntactically accepted but not semantically.
2510     pub vis: Visibility,
2511     /// Name of the variant.
2512     pub ident: Ident,
2513
2514     /// Fields and constructor id of the variant.
2515     pub data: VariantData,
2516     /// Explicit discriminant, e.g., `Foo = 1`.
2517     pub disr_expr: Option<AnonConst>,
2518     /// Is a macro placeholder
2519     pub is_placeholder: bool,
2520 }
2521
2522 /// Part of `use` item to the right of its prefix.
2523 #[derive(Clone, Encodable, Decodable, Debug)]
2524 pub enum UseTreeKind {
2525     /// `use prefix` or `use prefix as rename`
2526     Simple(Option<Ident>),
2527     /// `use prefix::{...}`
2528     Nested(Vec<(UseTree, NodeId)>),
2529     /// `use prefix::*`
2530     Glob,
2531 }
2532
2533 /// A tree of paths sharing common prefixes.
2534 /// Used in `use` items both at top-level and inside of braces in import groups.
2535 #[derive(Clone, Encodable, Decodable, Debug)]
2536 pub struct UseTree {
2537     pub prefix: Path,
2538     pub kind: UseTreeKind,
2539     pub span: Span,
2540 }
2541
2542 impl UseTree {
2543     pub fn ident(&self) -> Ident {
2544         match self.kind {
2545             UseTreeKind::Simple(Some(rename)) => rename,
2546             UseTreeKind::Simple(None) => {
2547                 self.prefix.segments.last().expect("empty prefix in a simple import").ident
2548             }
2549             _ => panic!("`UseTree::ident` can only be used on a simple import"),
2550         }
2551     }
2552 }
2553
2554 /// Distinguishes between `Attribute`s that decorate items and Attributes that
2555 /// are contained as statements within items. These two cases need to be
2556 /// distinguished for pretty-printing.
2557 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy, HashStable_Generic)]
2558 pub enum AttrStyle {
2559     Outer,
2560     Inner,
2561 }
2562
2563 rustc_index::newtype_index! {
2564     #[custom_encodable]
2565     #[debug_format = "AttrId({})]"]
2566     pub struct AttrId {}
2567 }
2568
2569 impl<S: Encoder> Encodable<S> for AttrId {
2570     fn encode(&self, _s: &mut S) {}
2571 }
2572
2573 impl<D: Decoder> Decodable<D> for AttrId {
2574     default fn decode(_: &mut D) -> AttrId {
2575         panic!("cannot decode `AttrId` with `{}`", std::any::type_name::<D>());
2576     }
2577 }
2578
2579 /// A list of attributes.
2580 pub type AttrVec = ThinVec<Attribute>;
2581
2582 /// A syntax-level representation of an attribute.
2583 #[derive(Clone, Encodable, Decodable, Debug)]
2584 pub struct Attribute {
2585     pub kind: AttrKind,
2586     pub id: AttrId,
2587     /// Denotes if the attribute decorates the following construct (outer)
2588     /// or the construct this attribute is contained within (inner).
2589     pub style: AttrStyle,
2590     pub span: Span,
2591 }
2592
2593 #[derive(Clone, Encodable, Decodable, Debug)]
2594 pub enum AttrKind {
2595     /// A normal attribute.
2596     Normal(P<NormalAttr>),
2597
2598     /// A doc comment (e.g. `/// ...`, `//! ...`, `/** ... */`, `/*! ... */`).
2599     /// Doc attributes (e.g. `#[doc="..."]`) are represented with the `Normal`
2600     /// variant (which is much less compact and thus more expensive).
2601     DocComment(CommentKind, Symbol),
2602 }
2603
2604 #[derive(Clone, Encodable, Decodable, Debug)]
2605 pub struct NormalAttr {
2606     pub item: AttrItem,
2607     pub tokens: Option<LazyAttrTokenStream>,
2608 }
2609
2610 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
2611 pub struct AttrItem {
2612     pub path: Path,
2613     pub args: AttrArgs,
2614     pub tokens: Option<LazyAttrTokenStream>,
2615 }
2616
2617 /// `TraitRef`s appear in impls.
2618 ///
2619 /// Resolution maps each `TraitRef`'s `ref_id` to its defining trait; that's all
2620 /// that the `ref_id` is for. The `impl_id` maps to the "self type" of this impl.
2621 /// If this impl is an `ItemKind::Impl`, the `impl_id` is redundant (it could be the
2622 /// same as the impl's `NodeId`).
2623 #[derive(Clone, Encodable, Decodable, Debug)]
2624 pub struct TraitRef {
2625     pub path: Path,
2626     pub ref_id: NodeId,
2627 }
2628
2629 #[derive(Clone, Encodable, Decodable, Debug)]
2630 pub struct PolyTraitRef {
2631     /// The `'a` in `for<'a> Foo<&'a T>`.
2632     pub bound_generic_params: Vec<GenericParam>,
2633
2634     /// The `Foo<&'a T>` in `<'a> Foo<&'a T>`.
2635     pub trait_ref: TraitRef,
2636
2637     pub span: Span,
2638 }
2639
2640 impl PolyTraitRef {
2641     pub fn new(generic_params: Vec<GenericParam>, path: Path, span: Span) -> Self {
2642         PolyTraitRef {
2643             bound_generic_params: generic_params,
2644             trait_ref: TraitRef { path, ref_id: DUMMY_NODE_ID },
2645             span,
2646         }
2647     }
2648 }
2649
2650 #[derive(Clone, Encodable, Decodable, Debug)]
2651 pub struct Visibility {
2652     pub kind: VisibilityKind,
2653     pub span: Span,
2654     pub tokens: Option<LazyAttrTokenStream>,
2655 }
2656
2657 #[derive(Clone, Encodable, Decodable, Debug)]
2658 pub enum VisibilityKind {
2659     Public,
2660     Restricted { path: P<Path>, id: NodeId, shorthand: bool },
2661     Inherited,
2662 }
2663
2664 impl VisibilityKind {
2665     pub fn is_pub(&self) -> bool {
2666         matches!(self, VisibilityKind::Public)
2667     }
2668 }
2669
2670 /// Field definition in a struct, variant or union.
2671 ///
2672 /// E.g., `bar: usize` as in `struct Foo { bar: usize }`.
2673 #[derive(Clone, Encodable, Decodable, Debug)]
2674 pub struct FieldDef {
2675     pub attrs: AttrVec,
2676     pub id: NodeId,
2677     pub span: Span,
2678     pub vis: Visibility,
2679     pub ident: Option<Ident>,
2680
2681     pub ty: P<Ty>,
2682     pub is_placeholder: bool,
2683 }
2684
2685 /// Fields and constructor ids of enum variants and structs.
2686 #[derive(Clone, Encodable, Decodable, Debug)]
2687 pub enum VariantData {
2688     /// Struct variant.
2689     ///
2690     /// E.g., `Bar { .. }` as in `enum Foo { Bar { .. } }`.
2691     Struct(Vec<FieldDef>, bool),
2692     /// Tuple variant.
2693     ///
2694     /// E.g., `Bar(..)` as in `enum Foo { Bar(..) }`.
2695     Tuple(Vec<FieldDef>, NodeId),
2696     /// Unit variant.
2697     ///
2698     /// E.g., `Bar = ..` as in `enum Foo { Bar = .. }`.
2699     Unit(NodeId),
2700 }
2701
2702 impl VariantData {
2703     /// Return the fields of this variant.
2704     pub fn fields(&self) -> &[FieldDef] {
2705         match self {
2706             VariantData::Struct(fields, ..) | VariantData::Tuple(fields, _) => fields,
2707             _ => &[],
2708         }
2709     }
2710
2711     /// Return the `NodeId` of this variant's constructor, if it has one.
2712     pub fn ctor_node_id(&self) -> Option<NodeId> {
2713         match *self {
2714             VariantData::Struct(..) => None,
2715             VariantData::Tuple(_, id) | VariantData::Unit(id) => Some(id),
2716         }
2717     }
2718 }
2719
2720 /// An item definition.
2721 #[derive(Clone, Encodable, Decodable, Debug)]
2722 pub struct Item<K = ItemKind> {
2723     pub attrs: AttrVec,
2724     pub id: NodeId,
2725     pub span: Span,
2726     pub vis: Visibility,
2727     /// The name of the item.
2728     /// It might be a dummy name in case of anonymous items.
2729     pub ident: Ident,
2730
2731     pub kind: K,
2732
2733     /// Original tokens this item was parsed from. This isn't necessarily
2734     /// available for all items, although over time more and more items should
2735     /// have this be `Some`. Right now this is primarily used for procedural
2736     /// macros, notably custom attributes.
2737     ///
2738     /// Note that the tokens here do not include the outer attributes, but will
2739     /// include inner attributes.
2740     pub tokens: Option<LazyAttrTokenStream>,
2741 }
2742
2743 impl Item {
2744     /// Return the span that encompasses the attributes.
2745     pub fn span_with_attributes(&self) -> Span {
2746         self.attrs.iter().fold(self.span, |acc, attr| acc.to(attr.span))
2747     }
2748 }
2749
2750 /// `extern` qualifier on a function item or function type.
2751 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
2752 pub enum Extern {
2753     /// No explicit extern keyword was used
2754     ///
2755     /// E.g. `fn foo() {}`
2756     None,
2757     /// An explicit extern keyword was used, but with implicit ABI
2758     ///
2759     /// E.g. `extern fn foo() {}`
2760     ///
2761     /// This is just `extern "C"` (see `rustc_target::spec::abi::Abi::FALLBACK`)
2762     Implicit(Span),
2763     /// An explicit extern keyword was used with an explicit ABI
2764     ///
2765     /// E.g. `extern "C" fn foo() {}`
2766     Explicit(StrLit, Span),
2767 }
2768
2769 impl Extern {
2770     pub fn from_abi(abi: Option<StrLit>, span: Span) -> Extern {
2771         match abi {
2772             Some(name) => Extern::Explicit(name, span),
2773             None => Extern::Implicit(span),
2774         }
2775     }
2776 }
2777
2778 /// A function header.
2779 ///
2780 /// All the information between the visibility and the name of the function is
2781 /// included in this struct (e.g., `async unsafe fn` or `const extern "C" fn`).
2782 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
2783 pub struct FnHeader {
2784     /// The `unsafe` keyword, if any
2785     pub unsafety: Unsafe,
2786     /// The `async` keyword, if any
2787     pub asyncness: Async,
2788     /// The `const` keyword, if any
2789     pub constness: Const,
2790     /// The `extern` keyword and corresponding ABI string, if any
2791     pub ext: Extern,
2792 }
2793
2794 impl FnHeader {
2795     /// Does this function header have any qualifiers or is it empty?
2796     pub fn has_qualifiers(&self) -> bool {
2797         let Self { unsafety, asyncness, constness, ext } = self;
2798         matches!(unsafety, Unsafe::Yes(_))
2799             || asyncness.is_async()
2800             || matches!(constness, Const::Yes(_))
2801             || !matches!(ext, Extern::None)
2802     }
2803 }
2804
2805 impl Default for FnHeader {
2806     fn default() -> FnHeader {
2807         FnHeader {
2808             unsafety: Unsafe::No,
2809             asyncness: Async::No,
2810             constness: Const::No,
2811             ext: Extern::None,
2812         }
2813     }
2814 }
2815
2816 #[derive(Clone, Encodable, Decodable, Debug)]
2817 pub struct Trait {
2818     pub unsafety: Unsafe,
2819     pub is_auto: IsAuto,
2820     pub generics: Generics,
2821     pub bounds: GenericBounds,
2822     pub items: Vec<P<AssocItem>>,
2823 }
2824
2825 /// The location of a where clause on a `TyAlias` (`Span`) and whether there was
2826 /// a `where` keyword (`bool`). This is split out from `WhereClause`, since there
2827 /// are two locations for where clause on type aliases, but their predicates
2828 /// are concatenated together.
2829 ///
2830 /// Take this example:
2831 /// ```ignore (only-for-syntax-highlight)
2832 /// trait Foo {
2833 ///   type Assoc<'a, 'b> where Self: 'a, Self: 'b;
2834 /// }
2835 /// impl Foo for () {
2836 ///   type Assoc<'a, 'b> where Self: 'a = () where Self: 'b;
2837 ///   //                 ^^^^^^^^^^^^^^ first where clause
2838 ///   //                                     ^^^^^^^^^^^^^^ second where clause
2839 /// }
2840 /// ```
2841 ///
2842 /// If there is no where clause, then this is `false` with `DUMMY_SP`.
2843 #[derive(Copy, Clone, Encodable, Decodable, Debug, Default)]
2844 pub struct TyAliasWhereClause(pub bool, pub Span);
2845
2846 #[derive(Clone, Encodable, Decodable, Debug)]
2847 pub struct TyAlias {
2848     pub defaultness: Defaultness,
2849     pub generics: Generics,
2850     /// The span information for the two where clauses (before equals, after equals)
2851     pub where_clauses: (TyAliasWhereClause, TyAliasWhereClause),
2852     /// The index in `generics.where_clause.predicates` that would split into
2853     /// predicates from the where clause before the equals and the predicates
2854     /// from the where clause after the equals
2855     pub where_predicates_split: usize,
2856     pub bounds: GenericBounds,
2857     pub ty: Option<P<Ty>>,
2858 }
2859
2860 #[derive(Clone, Encodable, Decodable, Debug)]
2861 pub struct Impl {
2862     pub defaultness: Defaultness,
2863     pub unsafety: Unsafe,
2864     pub generics: Generics,
2865     pub constness: Const,
2866     pub polarity: ImplPolarity,
2867     /// The trait being implemented, if any.
2868     pub of_trait: Option<TraitRef>,
2869     pub self_ty: P<Ty>,
2870     pub items: Vec<P<AssocItem>>,
2871 }
2872
2873 #[derive(Clone, Encodable, Decodable, Debug)]
2874 pub struct Fn {
2875     pub defaultness: Defaultness,
2876     pub generics: Generics,
2877     pub sig: FnSig,
2878     pub body: Option<P<Block>>,
2879 }
2880
2881 #[derive(Clone, Encodable, Decodable, Debug)]
2882 pub enum ItemKind {
2883     /// An `extern crate` item, with the optional *original* crate name if the crate was renamed.
2884     ///
2885     /// E.g., `extern crate foo` or `extern crate foo_bar as foo`.
2886     ExternCrate(Option<Symbol>),
2887     /// A use declaration item (`use`).
2888     ///
2889     /// E.g., `use foo;`, `use foo::bar;` or `use foo::bar as FooBar;`.
2890     Use(UseTree),
2891     /// A static item (`static`).
2892     ///
2893     /// E.g., `static FOO: i32 = 42;` or `static FOO: &'static str = "bar";`.
2894     Static(P<Ty>, Mutability, Option<P<Expr>>),
2895     /// A constant item (`const`).
2896     ///
2897     /// E.g., `const FOO: i32 = 42;`.
2898     Const(Defaultness, P<Ty>, Option<P<Expr>>),
2899     /// A function declaration (`fn`).
2900     ///
2901     /// E.g., `fn foo(bar: usize) -> usize { .. }`.
2902     Fn(Box<Fn>),
2903     /// A module declaration (`mod`).
2904     ///
2905     /// E.g., `mod foo;` or `mod foo { .. }`.
2906     /// `unsafe` keyword on modules is accepted syntactically for macro DSLs, but not
2907     /// semantically by Rust.
2908     Mod(Unsafe, ModKind),
2909     /// An external module (`extern`).
2910     ///
2911     /// E.g., `extern {}` or `extern "C" {}`.
2912     ForeignMod(ForeignMod),
2913     /// Module-level inline assembly (from `global_asm!()`).
2914     GlobalAsm(Box<InlineAsm>),
2915     /// A type alias (`type`).
2916     ///
2917     /// E.g., `type Foo = Bar<u8>;`.
2918     TyAlias(Box<TyAlias>),
2919     /// An enum definition (`enum`).
2920     ///
2921     /// E.g., `enum Foo<A, B> { C<A>, D<B> }`.
2922     Enum(EnumDef, Generics),
2923     /// A struct definition (`struct`).
2924     ///
2925     /// E.g., `struct Foo<A> { x: A }`.
2926     Struct(VariantData, Generics),
2927     /// A union definition (`union`).
2928     ///
2929     /// E.g., `union Foo<A, B> { x: A, y: B }`.
2930     Union(VariantData, Generics),
2931     /// A trait declaration (`trait`).
2932     ///
2933     /// E.g., `trait Foo { .. }`, `trait Foo<T> { .. }` or `auto trait Foo {}`.
2934     Trait(Box<Trait>),
2935     /// Trait alias
2936     ///
2937     /// E.g., `trait Foo = Bar + Quux;`.
2938     TraitAlias(Generics, GenericBounds),
2939     /// An implementation.
2940     ///
2941     /// E.g., `impl<A> Foo<A> { .. }` or `impl<A> Trait for Foo<A> { .. }`.
2942     Impl(Box<Impl>),
2943     /// A macro invocation.
2944     ///
2945     /// E.g., `foo!(..)`.
2946     MacCall(P<MacCall>),
2947
2948     /// A macro definition.
2949     MacroDef(MacroDef),
2950 }
2951
2952 impl ItemKind {
2953     pub fn article(&self) -> &str {
2954         use ItemKind::*;
2955         match self {
2956             Use(..) | Static(..) | Const(..) | Fn(..) | Mod(..) | GlobalAsm(..) | TyAlias(..)
2957             | Struct(..) | Union(..) | Trait(..) | TraitAlias(..) | MacroDef(..) => "a",
2958             ExternCrate(..) | ForeignMod(..) | MacCall(..) | Enum(..) | Impl { .. } => "an",
2959         }
2960     }
2961
2962     pub fn descr(&self) -> &str {
2963         match self {
2964             ItemKind::ExternCrate(..) => "extern crate",
2965             ItemKind::Use(..) => "`use` import",
2966             ItemKind::Static(..) => "static item",
2967             ItemKind::Const(..) => "constant item",
2968             ItemKind::Fn(..) => "function",
2969             ItemKind::Mod(..) => "module",
2970             ItemKind::ForeignMod(..) => "extern block",
2971             ItemKind::GlobalAsm(..) => "global asm item",
2972             ItemKind::TyAlias(..) => "type alias",
2973             ItemKind::Enum(..) => "enum",
2974             ItemKind::Struct(..) => "struct",
2975             ItemKind::Union(..) => "union",
2976             ItemKind::Trait(..) => "trait",
2977             ItemKind::TraitAlias(..) => "trait alias",
2978             ItemKind::MacCall(..) => "item macro invocation",
2979             ItemKind::MacroDef(..) => "macro definition",
2980             ItemKind::Impl { .. } => "implementation",
2981         }
2982     }
2983
2984     pub fn generics(&self) -> Option<&Generics> {
2985         match self {
2986             Self::Fn(box Fn { generics, .. })
2987             | Self::TyAlias(box TyAlias { generics, .. })
2988             | Self::Enum(_, generics)
2989             | Self::Struct(_, generics)
2990             | Self::Union(_, generics)
2991             | Self::Trait(box Trait { generics, .. })
2992             | Self::TraitAlias(generics, _)
2993             | Self::Impl(box Impl { generics, .. }) => Some(generics),
2994             _ => None,
2995         }
2996     }
2997 }
2998
2999 /// Represents associated items.
3000 /// These include items in `impl` and `trait` definitions.
3001 pub type AssocItem = Item<AssocItemKind>;
3002
3003 /// Represents associated item kinds.
3004 ///
3005 /// The term "provided" in the variants below refers to the item having a default
3006 /// definition / body. Meanwhile, a "required" item lacks a definition / body.
3007 /// In an implementation, all items must be provided.
3008 /// The `Option`s below denote the bodies, where `Some(_)`
3009 /// means "provided" and conversely `None` means "required".
3010 #[derive(Clone, Encodable, Decodable, Debug)]
3011 pub enum AssocItemKind {
3012     /// An associated constant, `const $ident: $ty $def?;` where `def ::= "=" $expr? ;`.
3013     /// If `def` is parsed, then the constant is provided, and otherwise required.
3014     Const(Defaultness, P<Ty>, Option<P<Expr>>),
3015     /// An associated function.
3016     Fn(Box<Fn>),
3017     /// An associated type.
3018     Type(Box<TyAlias>),
3019     /// A macro expanding to associated items.
3020     MacCall(P<MacCall>),
3021 }
3022
3023 impl AssocItemKind {
3024     pub fn defaultness(&self) -> Defaultness {
3025         match *self {
3026             Self::Const(defaultness, ..)
3027             | Self::Fn(box Fn { defaultness, .. })
3028             | Self::Type(box TyAlias { defaultness, .. }) => defaultness,
3029             Self::MacCall(..) => Defaultness::Final,
3030         }
3031     }
3032 }
3033
3034 impl From<AssocItemKind> for ItemKind {
3035     fn from(assoc_item_kind: AssocItemKind) -> ItemKind {
3036         match assoc_item_kind {
3037             AssocItemKind::Const(a, b, c) => ItemKind::Const(a, b, c),
3038             AssocItemKind::Fn(fn_kind) => ItemKind::Fn(fn_kind),
3039             AssocItemKind::Type(ty_alias_kind) => ItemKind::TyAlias(ty_alias_kind),
3040             AssocItemKind::MacCall(a) => ItemKind::MacCall(a),
3041         }
3042     }
3043 }
3044
3045 impl TryFrom<ItemKind> for AssocItemKind {
3046     type Error = ItemKind;
3047
3048     fn try_from(item_kind: ItemKind) -> Result<AssocItemKind, ItemKind> {
3049         Ok(match item_kind {
3050             ItemKind::Const(a, b, c) => AssocItemKind::Const(a, b, c),
3051             ItemKind::Fn(fn_kind) => AssocItemKind::Fn(fn_kind),
3052             ItemKind::TyAlias(ty_kind) => AssocItemKind::Type(ty_kind),
3053             ItemKind::MacCall(a) => AssocItemKind::MacCall(a),
3054             _ => return Err(item_kind),
3055         })
3056     }
3057 }
3058
3059 /// An item in `extern` block.
3060 #[derive(Clone, Encodable, Decodable, Debug)]
3061 pub enum ForeignItemKind {
3062     /// A foreign static item (`static FOO: u8`).
3063     Static(P<Ty>, Mutability, Option<P<Expr>>),
3064     /// An foreign function.
3065     Fn(Box<Fn>),
3066     /// An foreign type.
3067     TyAlias(Box<TyAlias>),
3068     /// A macro expanding to foreign items.
3069     MacCall(P<MacCall>),
3070 }
3071
3072 impl From<ForeignItemKind> for ItemKind {
3073     fn from(foreign_item_kind: ForeignItemKind) -> ItemKind {
3074         match foreign_item_kind {
3075             ForeignItemKind::Static(a, b, c) => ItemKind::Static(a, b, c),
3076             ForeignItemKind::Fn(fn_kind) => ItemKind::Fn(fn_kind),
3077             ForeignItemKind::TyAlias(ty_alias_kind) => ItemKind::TyAlias(ty_alias_kind),
3078             ForeignItemKind::MacCall(a) => ItemKind::MacCall(a),
3079         }
3080     }
3081 }
3082
3083 impl TryFrom<ItemKind> for ForeignItemKind {
3084     type Error = ItemKind;
3085
3086     fn try_from(item_kind: ItemKind) -> Result<ForeignItemKind, ItemKind> {
3087         Ok(match item_kind {
3088             ItemKind::Static(a, b, c) => ForeignItemKind::Static(a, b, c),
3089             ItemKind::Fn(fn_kind) => ForeignItemKind::Fn(fn_kind),
3090             ItemKind::TyAlias(ty_alias_kind) => ForeignItemKind::TyAlias(ty_alias_kind),
3091             ItemKind::MacCall(a) => ForeignItemKind::MacCall(a),
3092             _ => return Err(item_kind),
3093         })
3094     }
3095 }
3096
3097 pub type ForeignItem = Item<ForeignItemKind>;
3098
3099 // Some nodes are used a lot. Make sure they don't unintentionally get bigger.
3100 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
3101 mod size_asserts {
3102     use super::*;
3103     use rustc_data_structures::static_assert_size;
3104     // tidy-alphabetical-start
3105     static_assert_size!(AssocItem, 104);
3106     static_assert_size!(AssocItemKind, 32);
3107     static_assert_size!(Attribute, 32);
3108     static_assert_size!(Block, 48);
3109     static_assert_size!(Expr, 72);
3110     static_assert_size!(ExprKind, 40);
3111     static_assert_size!(Fn, 184);
3112     static_assert_size!(ForeignItem, 96);
3113     static_assert_size!(ForeignItemKind, 24);
3114     static_assert_size!(GenericArg, 24);
3115     static_assert_size!(GenericBound, 72);
3116     static_assert_size!(Generics, 72);
3117     static_assert_size!(Impl, 184);
3118     static_assert_size!(Item, 184);
3119     static_assert_size!(ItemKind, 112);
3120     static_assert_size!(LitKind, 24);
3121     static_assert_size!(Local, 72);
3122     static_assert_size!(MetaItemLit, 40);
3123     static_assert_size!(Param, 40);
3124     static_assert_size!(Pat, 88);
3125     static_assert_size!(Path, 24);
3126     static_assert_size!(PathSegment, 24);
3127     static_assert_size!(PatKind, 64);
3128     static_assert_size!(Stmt, 32);
3129     static_assert_size!(StmtKind, 16);
3130     static_assert_size!(Ty, 64);
3131     static_assert_size!(TyKind, 40);
3132     // tidy-alphabetical-end
3133 }