1 //! The Rust abstract syntax tree module.
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).
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 //! - [`Lit`] 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.
21 pub use crate::util::parser::ExprPrecedence;
22 pub use GenericArgs::*;
23 pub use UnsafeSource::*;
26 use crate::token::{self, CommentKind, DelimToken, Token};
27 use crate::tokenstream::{DelimSpan, LazyTokenStream, TokenStream, TokenTree};
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_data_structures::thin_vec::ThinVec;
33 use rustc_macros::HashStable_Generic;
34 use rustc_serialize::{self, Decoder, Encoder};
35 use rustc_span::source_map::{respan, Spanned};
36 use rustc_span::symbol::{kw, sym, Ident, Symbol};
37 use rustc_span::{Span, DUMMY_SP};
39 use std::cmp::Ordering;
40 use std::convert::TryFrom;
46 /// A "Label" is an identifier of some point in sources,
47 /// e.g. in the following code:
55 /// `'outer` is a label.
56 #[derive(Clone, Encodable, Decodable, Copy, HashStable_Generic)]
61 impl fmt::Debug for Label {
62 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
63 write!(f, "label({:?})", self.ident)
67 /// A "Lifetime" is an annotation of the scope in which variable
68 /// can be used, e.g. `'a` in `&'a i32`.
69 #[derive(Clone, Encodable, Decodable, Copy)]
75 impl fmt::Debug for Lifetime {
76 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
77 write!(f, "lifetime({}: {})", self.id, self)
81 impl fmt::Display for Lifetime {
82 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
83 write!(f, "{}", self.ident.name)
87 /// A "Path" is essentially Rust's notion of a name.
89 /// It's represented as a sequence of identifiers,
90 /// along with a bunch of supporting information.
92 /// E.g., `std::cmp::PartialEq`.
93 #[derive(Clone, Encodable, Decodable, Debug)]
96 /// The segments in the path: the things separated by `::`.
97 /// Global paths begin with `kw::PathRoot`.
98 pub segments: Vec<PathSegment>,
99 pub tokens: Option<LazyTokenStream>,
102 impl PartialEq<Symbol> for Path {
104 fn eq(&self, symbol: &Symbol) -> bool {
105 self.segments.len() == 1 && { self.segments[0].ident.name == *symbol }
109 impl<CTX> HashStable<CTX> for Path {
110 fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher) {
111 self.segments.len().hash_stable(hcx, hasher);
112 for segment in &self.segments {
113 segment.ident.name.hash_stable(hcx, hasher);
119 // Convert a span and an identifier to the corresponding
121 pub fn from_ident(ident: Ident) -> Path {
122 Path { segments: vec![PathSegment::from_ident(ident)], span: ident.span, tokens: None }
125 pub fn is_global(&self) -> bool {
126 !self.segments.is_empty() && self.segments[0].ident.name == kw::PathRoot
130 /// A segment of a path: an identifier, an optional lifetime, and a set of types.
132 /// E.g., `std`, `String` or `Box<T>`.
133 #[derive(Clone, Encodable, Decodable, Debug)]
134 pub struct PathSegment {
135 /// The identifier portion of this path segment.
140 /// Type/lifetime parameters attached to this path. They come in
141 /// two flavors: `Path<A,B,C>` and `Path(A,B) -> C`.
142 /// `None` means that no parameter list is supplied (`Path`),
143 /// `Some` means that parameter list is supplied (`Path<X, Y>`)
144 /// but it can be empty (`Path<>`).
145 /// `P` is used as a size optimization for the common case with no parameters.
146 pub args: Option<P<GenericArgs>>,
150 pub fn from_ident(ident: Ident) -> Self {
151 PathSegment { ident, id: DUMMY_NODE_ID, args: None }
154 pub fn path_root(span: Span) -> Self {
155 PathSegment::from_ident(Ident::new(kw::PathRoot, span))
158 pub fn span(&self) -> Span {
160 Some(args) => self.ident.span.to(args.span()),
161 None => self.ident.span,
166 /// The arguments of a path segment.
168 /// E.g., `<A, B>` as in `Foo<A, B>` or `(A, B)` as in `Foo(A, B)`.
169 #[derive(Clone, Encodable, Decodable, Debug)]
170 pub enum GenericArgs {
171 /// The `<'a, A, B, C>` in `foo::bar::baz::<'a, A, B, C>`.
172 AngleBracketed(AngleBracketedArgs),
173 /// The `(A, B)` and `C` in `Foo(A, B) -> C`.
174 Parenthesized(ParenthesizedArgs),
178 pub fn is_angle_bracketed(&self) -> bool {
179 matches!(self, AngleBracketed(..))
182 pub fn span(&self) -> Span {
184 AngleBracketed(ref data) => data.span,
185 Parenthesized(ref data) => data.span,
190 /// Concrete argument in the sequence of generic args.
191 #[derive(Clone, Encodable, Decodable, Debug)]
192 pub enum GenericArg {
193 /// `'a` in `Foo<'a>`
195 /// `Bar` in `Foo<Bar>`
202 pub fn span(&self) -> Span {
204 GenericArg::Lifetime(lt) => lt.ident.span,
205 GenericArg::Type(ty) => ty.span,
206 GenericArg::Const(ct) => ct.value.span,
211 /// A path like `Foo<'a, T>`.
212 #[derive(Clone, Encodable, Decodable, Debug, Default)]
213 pub struct AngleBracketedArgs {
214 /// The overall span.
216 /// The comma separated parts in the `<...>`.
217 pub args: Vec<AngleBracketedArg>,
220 /// Either an argument for a parameter e.g., `'a`, `Vec<u8>`, `0`,
221 /// or a constraint on an associated item, e.g., `Item = String` or `Item: Bound`.
222 #[derive(Clone, Encodable, Decodable, Debug)]
223 pub enum AngleBracketedArg {
224 /// Argument for a generic parameter.
226 /// Constraint for an associated item.
227 Constraint(AssocTyConstraint),
230 impl AngleBracketedArg {
231 pub fn span(&self) -> Span {
233 AngleBracketedArg::Arg(arg) => arg.span(),
234 AngleBracketedArg::Constraint(constraint) => constraint.span,
239 impl Into<Option<P<GenericArgs>>> for AngleBracketedArgs {
240 fn into(self) -> Option<P<GenericArgs>> {
241 Some(P(GenericArgs::AngleBracketed(self)))
245 impl Into<Option<P<GenericArgs>>> for ParenthesizedArgs {
246 fn into(self) -> Option<P<GenericArgs>> {
247 Some(P(GenericArgs::Parenthesized(self)))
251 /// A path like `Foo(A, B) -> C`.
252 #[derive(Clone, Encodable, Decodable, Debug)]
253 pub struct ParenthesizedArgs {
261 pub inputs: Vec<P<Ty>>,
267 pub inputs_span: Span,
273 impl ParenthesizedArgs {
274 pub fn as_angle_bracketed_args(&self) -> AngleBracketedArgs {
279 .map(|input| AngleBracketedArg::Arg(GenericArg::Type(input)))
281 AngleBracketedArgs { span: self.inputs_span, args }
285 pub use crate::node_id::{NodeId, CRATE_NODE_ID, DUMMY_NODE_ID};
287 /// A modifier on a bound, e.g., `?Sized` or `~const Trait`.
289 /// Negative bounds should also be handled here.
290 #[derive(Copy, Clone, PartialEq, Eq, Encodable, Decodable, Debug)]
291 pub enum TraitBoundModifier {
303 // This parses but will be rejected during AST validation.
307 /// The AST represents all type param bounds as types.
308 /// `typeck::collect::compute_bounds` matches these against
309 /// the "special" built-in traits (see `middle::lang_items`) and
310 /// detects `Copy`, `Send` and `Sync`.
311 #[derive(Clone, Encodable, Decodable, Debug)]
312 pub enum GenericBound {
313 Trait(PolyTraitRef, TraitBoundModifier),
318 pub fn span(&self) -> Span {
320 GenericBound::Trait(ref t, ..) => t.span,
321 GenericBound::Outlives(ref l) => l.ident.span,
326 pub type GenericBounds = Vec<GenericBound>;
328 /// Specifies the enforced ordering for generic parameters. In the future,
329 /// if we wanted to relax this order, we could override `PartialEq` and
330 /// `PartialOrd`, to allow the kinds to be unordered.
331 #[derive(Hash, Clone, Copy)]
332 pub enum ParamKindOrd {
335 // `unordered` is only `true` if `sess.unordered_const_ty_params()`
336 // returns true. Specifically, if it's only `min_const_generics`, it will still require
337 // ordering consts after types.
338 Const { unordered: bool },
339 // `Infer` is not actually constructed directly from the AST, but is implicitly constructed
340 // during HIR lowering, and `ParamKindOrd` will implicitly order inferred variables last.
344 impl Ord for ParamKindOrd {
345 fn cmp(&self, other: &Self) -> Ordering {
347 let to_int = |v| match v {
349 Infer | Type | Const { unordered: true } => 1,
350 // technically both consts should be ordered equally,
351 // but only one is ever encountered at a time, so this is
353 Const { unordered: false } => 2,
356 to_int(*self).cmp(&to_int(*other))
359 impl PartialOrd for ParamKindOrd {
360 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
361 Some(self.cmp(other))
364 impl PartialEq for ParamKindOrd {
365 fn eq(&self, other: &Self) -> bool {
366 self.cmp(other) == Ordering::Equal
369 impl Eq for ParamKindOrd {}
371 impl fmt::Display for ParamKindOrd {
372 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
374 ParamKindOrd::Lifetime => "lifetime".fmt(f),
375 ParamKindOrd::Type => "type".fmt(f),
376 ParamKindOrd::Const { .. } => "const".fmt(f),
377 ParamKindOrd::Infer => "infer".fmt(f),
382 #[derive(Clone, Encodable, Decodable, Debug)]
383 pub enum GenericParamKind {
384 /// A lifetime definition (e.g., `'a: 'b + 'c + 'd`).
387 default: Option<P<Ty>>,
391 /// Span of the `const` keyword.
393 /// Optional default value for the const generic param
394 default: Option<AnonConst>,
398 #[derive(Clone, Encodable, Decodable, Debug)]
399 pub struct GenericParam {
403 pub bounds: GenericBounds,
404 pub is_placeholder: bool,
405 pub kind: GenericParamKind,
408 /// Represents lifetime, type and const parameters attached to a declaration of
409 /// a function, enum, trait, etc.
410 #[derive(Clone, Encodable, Decodable, Debug)]
411 pub struct Generics {
412 pub params: Vec<GenericParam>,
413 pub where_clause: WhereClause,
417 impl Default for Generics {
418 /// Creates an instance of `Generics`.
419 fn default() -> Generics {
422 where_clause: WhereClause {
423 has_where_token: false,
424 predicates: Vec::new(),
432 /// A where-clause in a definition.
433 #[derive(Clone, Encodable, Decodable, Debug)]
434 pub struct WhereClause {
435 /// `true` if we ate a `where` token: this can happen
436 /// if we parsed no predicates (e.g. `struct Foo where {}`).
437 /// This allows us to accurately pretty-print
438 /// in `nt_to_tokenstream`
439 pub has_where_token: bool,
440 pub predicates: Vec<WherePredicate>,
444 /// A single predicate in a where-clause.
445 #[derive(Clone, Encodable, Decodable, Debug)]
446 pub enum WherePredicate {
447 /// A type binding (e.g., `for<'c> Foo: Send + Clone + 'c`).
448 BoundPredicate(WhereBoundPredicate),
449 /// A lifetime predicate (e.g., `'a: 'b + 'c`).
450 RegionPredicate(WhereRegionPredicate),
451 /// An equality predicate (unsupported).
452 EqPredicate(WhereEqPredicate),
455 impl WherePredicate {
456 pub fn span(&self) -> Span {
458 WherePredicate::BoundPredicate(p) => p.span,
459 WherePredicate::RegionPredicate(p) => p.span,
460 WherePredicate::EqPredicate(p) => p.span,
467 /// E.g., `for<'c> Foo: Send + Clone + 'c`.
468 #[derive(Clone, Encodable, Decodable, Debug)]
469 pub struct WhereBoundPredicate {
471 /// Any generics from a `for` binding.
472 pub bound_generic_params: Vec<GenericParam>,
473 /// The type being bounded.
474 pub bounded_ty: P<Ty>,
475 /// Trait and lifetime bounds (`Clone + Send + 'static`).
476 pub bounds: GenericBounds,
479 /// A lifetime predicate.
481 /// E.g., `'a: 'b + 'c`.
482 #[derive(Clone, Encodable, Decodable, Debug)]
483 pub struct WhereRegionPredicate {
485 pub lifetime: Lifetime,
486 pub bounds: GenericBounds,
489 /// An equality predicate (unsupported).
492 #[derive(Clone, Encodable, Decodable, Debug)]
493 pub struct WhereEqPredicate {
500 #[derive(Clone, Encodable, Decodable, Debug)]
502 pub attrs: Vec<Attribute>,
503 pub items: Vec<P<Item>>,
505 /// The order of items in the HIR is unrelated to the order of
506 /// items in the AST. However, we generate proc macro harnesses
507 /// based on the AST order, and later refer to these harnesses
508 /// from the HIR. This field keeps track of the order in which
509 /// we generated proc macros harnesses, so that we can map
510 /// HIR proc macros items back to their harness items.
511 pub proc_macros: Vec<NodeId>,
514 /// Possible values inside of compile-time attribute lists.
516 /// E.g., the '..' in `#[name(..)]`.
517 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
518 pub enum NestedMetaItem {
519 /// A full MetaItem, for recursive meta items.
523 /// E.g., `"foo"`, `64`, `true`.
527 /// A spanned compile-time attribute item.
529 /// E.g., `#[test]`, `#[derive(..)]`, `#[rustfmt::skip]` or `#[feature = "foo"]`.
530 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
531 pub struct MetaItem {
533 pub kind: MetaItemKind,
537 /// A compile-time attribute item.
539 /// E.g., `#[test]`, `#[derive(..)]` or `#[feature = "foo"]`.
540 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
541 pub enum MetaItemKind {
544 /// E.g., `test` as in `#[test]`.
548 /// E.g., `derive(..)` as in `#[derive(..)]`.
549 List(Vec<NestedMetaItem>),
550 /// Name value meta item.
552 /// E.g., `feature = "foo"` as in `#[feature = "foo"]`.
556 /// A block (`{ .. }`).
558 /// E.g., `{ .. }` as in `fn foo() { .. }`.
559 #[derive(Clone, Encodable, Decodable, Debug)]
561 /// The statements in the block.
562 pub stmts: Vec<Stmt>,
564 /// Distinguishes between `unsafe { ... }` and `{ ... }`.
565 pub rules: BlockCheckMode,
567 pub tokens: Option<LazyTokenStream>,
572 /// Patterns appear in match statements and some other contexts, such as `let` and `if let`.
573 #[derive(Clone, Encodable, Decodable, Debug)]
578 pub tokens: Option<LazyTokenStream>,
582 /// Attempt reparsing the pattern as a type.
583 /// This is intended for use by diagnostics.
584 pub fn to_ty(&self) -> Option<P<Ty>> {
585 let kind = match &self.kind {
586 // In a type expression `_` is an inference variable.
587 PatKind::Wild => TyKind::Infer,
588 // An IDENT pattern with no binding mode would be valid as path to a type. E.g. `u32`.
589 PatKind::Ident(BindingMode::ByValue(Mutability::Not), ident, None) => {
590 TyKind::Path(None, Path::from_ident(*ident))
592 PatKind::Path(qself, path) => TyKind::Path(qself.clone(), path.clone()),
593 PatKind::MacCall(mac) => TyKind::MacCall(mac.clone()),
594 // `&mut? P` can be reinterpreted as `&mut? T` where `T` is `P` reparsed as a type.
595 PatKind::Ref(pat, mutbl) => {
596 pat.to_ty().map(|ty| TyKind::Rptr(None, MutTy { ty, mutbl: *mutbl }))?
598 // A slice/array pattern `[P]` can be reparsed as `[T]`, an unsized array,
599 // when `P` can be reparsed as a type `T`.
600 PatKind::Slice(pats) if pats.len() == 1 => pats[0].to_ty().map(TyKind::Slice)?,
601 // A tuple pattern `(P0, .., Pn)` can be reparsed as `(T0, .., Tn)`
602 // assuming `T0` to `Tn` are all syntactically valid as types.
603 PatKind::Tuple(pats) => {
604 let mut tys = Vec::with_capacity(pats.len());
605 // FIXME(#48994) - could just be collected into an Option<Vec>
607 tys.push(pat.to_ty()?);
614 Some(P(Ty { kind, id: self.id, span: self.span, tokens: None }))
617 /// Walk top-down and call `it` in each place where a pattern occurs
618 /// starting with the root pattern `walk` is called on. If `it` returns
619 /// false then we will descend no further but siblings will be processed.
620 pub fn walk(&self, it: &mut impl FnMut(&Pat) -> bool) {
626 // Walk into the pattern associated with `Ident` (if any).
627 PatKind::Ident(_, _, Some(p)) => p.walk(it),
629 // Walk into each field of struct.
630 PatKind::Struct(_, _, fields, _) => fields.iter().for_each(|field| field.pat.walk(it)),
632 // Sequence of patterns.
633 PatKind::TupleStruct(_, _, s)
636 | PatKind::Or(s) => s.iter().for_each(|p| p.walk(it)),
638 // Trivial wrappers over inner patterns.
639 PatKind::Box(s) | PatKind::Ref(s, _) | PatKind::Paren(s) => s.walk(it),
641 // These patterns do not contain subpatterns, skip.
648 | PatKind::MacCall(_) => {}
652 /// Is this a `..` pattern?
653 pub fn is_rest(&self) -> bool {
654 matches!(self.kind, PatKind::Rest)
658 /// A single field in a struct pattern.
660 /// Patterns like the fields of `Foo { x, ref y, ref mut z }`
661 /// are treated the same as `x: x, y: ref y, z: ref mut z`,
662 /// except when `is_shorthand` is true.
663 #[derive(Clone, Encodable, Decodable, Debug)]
664 pub struct PatField {
665 /// The identifier for the field.
667 /// The pattern the field is destructured to.
669 pub is_shorthand: bool,
673 pub is_placeholder: bool,
676 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy)]
677 pub enum BindingMode {
682 #[derive(Clone, Encodable, Decodable, Debug)]
685 Included(RangeSyntax),
690 #[derive(Clone, Encodable, Decodable, Debug)]
691 pub enum RangeSyntax {
698 /// All the different flavors of pattern that Rust recognizes.
699 #[derive(Clone, Encodable, Decodable, Debug)]
701 /// Represents a wildcard pattern (`_`).
704 /// A `PatKind::Ident` may either be a new bound variable (`ref mut binding @ OPT_SUBPATTERN`),
705 /// or a unit struct/variant pattern, or a const pattern (in the last two cases the third
706 /// field must be `None`). Disambiguation cannot be done with parser alone, so it happens
707 /// during name resolution.
708 Ident(BindingMode, Ident, Option<P<Pat>>),
710 /// A struct or struct variant pattern (e.g., `Variant {x, y, ..}`).
711 /// The `bool` is `true` in the presence of a `..`.
712 Struct(Option<QSelf>, Path, Vec<PatField>, /* recovered */ bool),
714 /// A tuple struct/variant pattern (`Variant(x, y, .., z)`).
715 TupleStruct(Option<QSelf>, Path, Vec<P<Pat>>),
717 /// An or-pattern `A | B | C`.
718 /// Invariant: `pats.len() >= 2`.
721 /// A possibly qualified path pattern.
722 /// Unqualified path patterns `A::B::C` can legally refer to variants, structs, constants
723 /// or associated constants. Qualified path patterns `<A>::B::C`/`<A as Trait>::B::C` can
724 /// only legally refer to associated constants.
725 Path(Option<QSelf>, Path),
727 /// A tuple pattern (`(a, b)`).
733 /// A reference pattern (e.g., `&mut (a, b)`).
734 Ref(P<Pat>, Mutability),
739 /// A range pattern (e.g., `1...2`, `1..2`, `1..`, `..2`, `1..=2`, `..=2`).
740 Range(Option<P<Expr>>, Option<P<Expr>>, Spanned<RangeEnd>),
742 /// A slice pattern `[a, b, c]`.
745 /// A rest pattern `..`.
747 /// Syntactically it is valid anywhere.
749 /// Semantically however, it only has meaning immediately inside:
750 /// - a slice pattern: `[a, .., b]`,
751 /// - a binding pattern immediately inside a slice pattern: `[a, r @ ..]`,
752 /// - a tuple pattern: `(a, .., b)`,
753 /// - a tuple struct/variant pattern: `$path(a, .., b)`.
755 /// In all of these cases, an additional restriction applies,
756 /// only one rest pattern may occur in the pattern sequences.
759 /// Parentheses in patterns used for grouping (i.e., `(PAT)`).
762 /// A macro pattern; pre-expansion.
766 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, Copy)]
767 #[derive(HashStable_Generic, Encodable, Decodable)]
768 pub enum Mutability {
774 pub fn invert(self) -> Self {
776 Mutability::Mut => Mutability::Not,
777 Mutability::Not => Mutability::Mut,
781 pub fn prefix_str(&self) -> &'static str {
783 Mutability::Mut => "mut ",
784 Mutability::Not => "",
789 /// The kind of borrow in an `AddrOf` expression,
790 /// e.g., `&place` or `&raw const place`.
791 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
792 #[derive(Encodable, Decodable, HashStable_Generic)]
793 pub enum BorrowKind {
794 /// A normal borrow, `&$expr` or `&mut $expr`.
795 /// The resulting type is either `&'a T` or `&'a mut T`
796 /// where `T = typeof($expr)` and `'a` is some lifetime.
798 /// A raw borrow, `&raw const $expr` or `&raw mut $expr`.
799 /// The resulting type is either `*const T` or `*mut T`
800 /// where `T = typeof($expr)`.
804 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy)]
806 /// The `+` operator (addition)
808 /// The `-` operator (subtraction)
810 /// The `*` operator (multiplication)
812 /// The `/` operator (division)
814 /// The `%` operator (modulus)
816 /// The `&&` operator (logical and)
818 /// The `||` operator (logical or)
820 /// The `^` operator (bitwise xor)
822 /// The `&` operator (bitwise and)
824 /// The `|` operator (bitwise or)
826 /// The `<<` operator (shift left)
828 /// The `>>` operator (shift right)
830 /// The `==` operator (equality)
832 /// The `<` operator (less than)
834 /// The `<=` operator (less than or equal to)
836 /// The `!=` operator (not equal to)
838 /// The `>=` operator (greater than or equal to)
840 /// The `>` operator (greater than)
845 pub fn to_string(&self) -> &'static str {
868 pub fn lazy(&self) -> bool {
869 matches!(self, BinOpKind::And | BinOpKind::Or)
872 pub fn is_comparison(&self) -> bool {
874 // Note for developers: please keep this as is;
875 // we want compilation to fail if another variant is added.
877 Eq | Lt | Le | Ne | Gt | Ge => true,
878 And | Or | Add | Sub | Mul | Div | Rem | BitXor | BitAnd | BitOr | Shl | Shr => false,
883 pub type BinOp = Spanned<BinOpKind>;
887 /// Note that `&data` is not an operator, it's an `AddrOf` expression.
888 #[derive(Clone, Encodable, Decodable, Debug, Copy)]
890 /// The `*` operator for dereferencing
892 /// The `!` operator for logical inversion
894 /// The `-` operator for negation
899 pub fn to_string(op: UnOp) -> &'static str {
909 #[derive(Clone, Encodable, Decodable, Debug)]
917 pub fn tokens(&self) -> Option<&LazyTokenStream> {
919 StmtKind::Local(ref local) => local.tokens.as_ref(),
920 StmtKind::Item(ref item) => item.tokens.as_ref(),
921 StmtKind::Expr(ref expr) | StmtKind::Semi(ref expr) => expr.tokens.as_ref(),
922 StmtKind::Empty => None,
923 StmtKind::MacCall(ref mac) => mac.tokens.as_ref(),
927 pub fn has_trailing_semicolon(&self) -> bool {
929 StmtKind::Semi(_) => true,
930 StmtKind::MacCall(mac) => matches!(mac.style, MacStmtStyle::Semicolon),
935 /// Converts a parsed `Stmt` to a `Stmt` with
936 /// a trailing semicolon.
938 /// This only modifies the parsed AST struct, not the attached
939 /// `LazyTokenStream`. The parser is responsible for calling
940 /// `CreateTokenStream::add_trailing_semi` when there is actually
941 /// a semicolon in the tokenstream.
942 pub fn add_trailing_semicolon(mut self) -> Self {
943 self.kind = match self.kind {
944 StmtKind::Expr(expr) => StmtKind::Semi(expr),
945 StmtKind::MacCall(mac) => {
946 StmtKind::MacCall(mac.map(|MacCallStmt { mac, style: _, attrs, tokens }| {
947 MacCallStmt { mac, style: MacStmtStyle::Semicolon, attrs, tokens }
956 pub fn is_item(&self) -> bool {
957 matches!(self.kind, StmtKind::Item(_))
960 pub fn is_expr(&self) -> bool {
961 matches!(self.kind, StmtKind::Expr(_))
965 #[derive(Clone, Encodable, Decodable, Debug)]
967 /// A local (let) binding.
969 /// An item definition.
971 /// Expr without trailing semi-colon.
973 /// Expr with a trailing semi-colon.
975 /// Just a trailing semi-colon.
978 MacCall(P<MacCallStmt>),
981 #[derive(Clone, Encodable, Decodable, Debug)]
982 pub struct MacCallStmt {
984 pub style: MacStmtStyle,
986 pub tokens: Option<LazyTokenStream>,
989 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug)]
990 pub enum MacStmtStyle {
991 /// The macro statement had a trailing semicolon (e.g., `foo! { ... };`
992 /// `foo!(...);`, `foo![...];`).
994 /// The macro statement had braces (e.g., `foo! { ... }`).
996 /// The macro statement had parentheses or brackets and no semicolon (e.g.,
997 /// `foo!(...)`). All of these will end up being converted into macro
1002 /// Local represents a `let` statement, e.g., `let <pat>:<ty> = <expr>;`.
1003 #[derive(Clone, Encodable, Decodable, Debug)]
1007 pub ty: Option<P<Ty>>,
1008 pub kind: LocalKind,
1011 pub tokens: Option<LazyTokenStream>,
1014 #[derive(Clone, Encodable, Decodable, Debug)]
1015 pub enum LocalKind {
1016 /// Local declaration.
1017 /// Example: `let x;`
1019 /// Local declaration with an initializer.
1020 /// Example: `let x = y;`
1022 /// Local declaration with an initializer and an `else` clause.
1023 /// Example: `let Some(x) = y else { return };`
1024 InitElse(P<Expr>, P<Block>),
1028 pub fn init(&self) -> Option<&Expr> {
1031 Self::Init(i) | Self::InitElse(i, _) => Some(i),
1035 pub fn init_else_opt(&self) -> Option<(&Expr, Option<&Block>)> {
1038 Self::Init(init) => Some((init, None)),
1039 Self::InitElse(init, els) => Some((init, Some(els))),
1044 /// An arm of a 'match'.
1046 /// E.g., `0..=10 => { println!("match!") }` as in
1050 /// 0..=10 => { println!("match!") },
1051 /// _ => { println!("no match!") },
1054 #[derive(Clone, Encodable, Decodable, Debug)]
1057 /// Match arm pattern, e.g. `10` in `match foo { 10 => {}, _ => {} }`
1059 /// Match arm guard, e.g. `n > 10` in `match foo { n if n > 10 => {}, _ => {} }`
1060 pub guard: Option<P<Expr>>,
1065 pub is_placeholder: bool,
1068 /// A single field in a struct expression, e.g. `x: value` and `y` in `Foo { x: value, y }`.
1069 #[derive(Clone, Encodable, Decodable, Debug)]
1070 pub struct ExprField {
1076 pub is_shorthand: bool,
1077 pub is_placeholder: bool,
1080 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy)]
1081 pub enum BlockCheckMode {
1083 Unsafe(UnsafeSource),
1086 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy)]
1087 pub enum UnsafeSource {
1092 /// A constant (expression) that's not an item or associated item,
1093 /// but needs its own `DefId` for type-checking, const-eval, etc.
1094 /// These are usually found nested inside types (e.g., array lengths)
1095 /// or expressions (e.g., repeat counts), and also used to define
1096 /// explicit discriminant values for enum variants.
1097 #[derive(Clone, Encodable, Decodable, Debug)]
1098 pub struct AnonConst {
1104 #[derive(Clone, Encodable, Decodable, Debug)]
1110 pub tokens: Option<LazyTokenStream>,
1113 // `Expr` is used a lot. Make sure it doesn't unintentionally get bigger.
1114 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
1115 rustc_data_structures::static_assert_size!(Expr, 104);
1118 /// Returns `true` if this expression would be valid somewhere that expects a value;
1119 /// for example, an `if` condition.
1120 pub fn returns(&self) -> bool {
1121 if let ExprKind::Block(ref block, _) = self.kind {
1122 match block.stmts.last().map(|last_stmt| &last_stmt.kind) {
1124 Some(StmtKind::Expr(_)) => true,
1125 // Last statement is an explicit return?
1126 Some(StmtKind::Semi(expr)) => matches!(expr.kind, ExprKind::Ret(_)),
1127 // This is a block that doesn't end in either an implicit or explicit return.
1131 // This is not a block, it is a value.
1136 /// Is this expr either `N`, or `{ N }`.
1138 /// If this is not the case, name resolution does not resolve `N` when using
1139 /// `min_const_generics` as more complex expressions are not supported.
1140 pub fn is_potential_trivial_const_param(&self) -> bool {
1141 let this = if let ExprKind::Block(ref block, None) = self.kind {
1142 if block.stmts.len() == 1 {
1143 if let StmtKind::Expr(ref expr) = block.stmts[0].kind { expr } else { self }
1151 if let ExprKind::Path(None, ref path) = this.kind {
1152 if path.segments.len() == 1 && path.segments[0].args.is_none() {
1160 pub fn to_bound(&self) -> Option<GenericBound> {
1162 ExprKind::Path(None, path) => Some(GenericBound::Trait(
1163 PolyTraitRef::new(Vec::new(), path.clone(), self.span),
1164 TraitBoundModifier::None,
1170 pub fn peel_parens(&self) -> &Expr {
1171 let mut expr = self;
1172 while let ExprKind::Paren(inner) = &expr.kind {
1178 /// Attempts to reparse as `Ty` (for diagnostic purposes).
1179 pub fn to_ty(&self) -> Option<P<Ty>> {
1180 let kind = match &self.kind {
1181 // Trivial conversions.
1182 ExprKind::Path(qself, path) => TyKind::Path(qself.clone(), path.clone()),
1183 ExprKind::MacCall(mac) => TyKind::MacCall(mac.clone()),
1185 ExprKind::Paren(expr) => expr.to_ty().map(TyKind::Paren)?,
1187 ExprKind::AddrOf(BorrowKind::Ref, mutbl, expr) => {
1188 expr.to_ty().map(|ty| TyKind::Rptr(None, MutTy { ty, mutbl: *mutbl }))?
1191 ExprKind::Repeat(expr, expr_len) => {
1192 expr.to_ty().map(|ty| TyKind::Array(ty, expr_len.clone()))?
1195 ExprKind::Array(exprs) if exprs.len() == 1 => exprs[0].to_ty().map(TyKind::Slice)?,
1197 ExprKind::Tup(exprs) => {
1198 let tys = exprs.iter().map(|expr| expr.to_ty()).collect::<Option<Vec<_>>>()?;
1202 // If binary operator is `Add` and both `lhs` and `rhs` are trait bounds,
1203 // then type of result is trait object.
1204 // Otherwise we don't assume the result type.
1205 ExprKind::Binary(binop, lhs, rhs) if binop.node == BinOpKind::Add => {
1206 if let (Some(lhs), Some(rhs)) = (lhs.to_bound(), rhs.to_bound()) {
1207 TyKind::TraitObject(vec![lhs, rhs], TraitObjectSyntax::None)
1213 // This expression doesn't look like a type syntactically.
1217 Some(P(Ty { kind, id: self.id, span: self.span, tokens: None }))
1220 pub fn precedence(&self) -> ExprPrecedence {
1222 ExprKind::Box(_) => ExprPrecedence::Box,
1223 ExprKind::Array(_) => ExprPrecedence::Array,
1224 ExprKind::ConstBlock(_) => ExprPrecedence::ConstBlock,
1225 ExprKind::Call(..) => ExprPrecedence::Call,
1226 ExprKind::MethodCall(..) => ExprPrecedence::MethodCall,
1227 ExprKind::Tup(_) => ExprPrecedence::Tup,
1228 ExprKind::Binary(op, ..) => ExprPrecedence::Binary(op.node),
1229 ExprKind::Unary(..) => ExprPrecedence::Unary,
1230 ExprKind::Lit(_) => ExprPrecedence::Lit,
1231 ExprKind::Type(..) | ExprKind::Cast(..) => ExprPrecedence::Cast,
1232 ExprKind::Let(..) => ExprPrecedence::Let,
1233 ExprKind::If(..) => ExprPrecedence::If,
1234 ExprKind::While(..) => ExprPrecedence::While,
1235 ExprKind::ForLoop(..) => ExprPrecedence::ForLoop,
1236 ExprKind::Loop(..) => ExprPrecedence::Loop,
1237 ExprKind::Match(..) => ExprPrecedence::Match,
1238 ExprKind::Closure(..) => ExprPrecedence::Closure,
1239 ExprKind::Block(..) => ExprPrecedence::Block,
1240 ExprKind::TryBlock(..) => ExprPrecedence::TryBlock,
1241 ExprKind::Async(..) => ExprPrecedence::Async,
1242 ExprKind::Await(..) => ExprPrecedence::Await,
1243 ExprKind::Assign(..) => ExprPrecedence::Assign,
1244 ExprKind::AssignOp(..) => ExprPrecedence::AssignOp,
1245 ExprKind::Field(..) => ExprPrecedence::Field,
1246 ExprKind::Index(..) => ExprPrecedence::Index,
1247 ExprKind::Range(..) => ExprPrecedence::Range,
1248 ExprKind::Underscore => ExprPrecedence::Path,
1249 ExprKind::Path(..) => ExprPrecedence::Path,
1250 ExprKind::AddrOf(..) => ExprPrecedence::AddrOf,
1251 ExprKind::Break(..) => ExprPrecedence::Break,
1252 ExprKind::Continue(..) => ExprPrecedence::Continue,
1253 ExprKind::Ret(..) => ExprPrecedence::Ret,
1254 ExprKind::InlineAsm(..) | ExprKind::LlvmInlineAsm(..) => ExprPrecedence::InlineAsm,
1255 ExprKind::MacCall(..) => ExprPrecedence::Mac,
1256 ExprKind::Struct(..) => ExprPrecedence::Struct,
1257 ExprKind::Repeat(..) => ExprPrecedence::Repeat,
1258 ExprKind::Paren(..) => ExprPrecedence::Paren,
1259 ExprKind::Try(..) => ExprPrecedence::Try,
1260 ExprKind::Yield(..) => ExprPrecedence::Yield,
1261 ExprKind::Err => ExprPrecedence::Err,
1266 /// Limit types of a range (inclusive or exclusive)
1267 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, Debug)]
1268 pub enum RangeLimits {
1269 /// Inclusive at the beginning, exclusive at the end
1271 /// Inclusive at the beginning and end
1275 #[derive(Clone, Encodable, Decodable, Debug)]
1276 pub enum StructRest {
1281 /// No trailing `..` or expression.
1285 #[derive(Clone, Encodable, Decodable, Debug)]
1286 pub struct StructExpr {
1287 pub qself: Option<QSelf>,
1289 pub fields: Vec<ExprField>,
1290 pub rest: StructRest,
1293 #[derive(Clone, Encodable, Decodable, Debug)]
1295 /// A `box x` expression.
1297 /// An array (`[a, b, c, d]`)
1298 Array(Vec<P<Expr>>),
1299 /// Allow anonymous constants from an inline `const` block
1300 ConstBlock(AnonConst),
1303 /// The first field resolves to the function itself,
1304 /// and the second field is the list of arguments.
1305 /// This also represents calling the constructor of
1306 /// tuple-like ADTs such as tuple structs and enum variants.
1307 Call(P<Expr>, Vec<P<Expr>>),
1308 /// A method call (`x.foo::<'static, Bar, Baz>(a, b, c, d)`)
1310 /// The `PathSegment` represents the method name and its generic arguments
1311 /// (within the angle brackets).
1312 /// The first element of the vector of an `Expr` is the expression that evaluates
1313 /// to the object on which the method is being called on (the receiver),
1314 /// and the remaining elements are the rest of the arguments.
1315 /// Thus, `x.foo::<Bar, Baz>(a, b, c, d)` is represented as
1316 /// `ExprKind::MethodCall(PathSegment { foo, [Bar, Baz] }, [x, a, b, c, d])`.
1317 /// This `Span` is the span of the function, without the dot and receiver
1318 /// (e.g. `foo(a, b)` in `x.foo(a, b)`
1319 MethodCall(PathSegment, Vec<P<Expr>>, Span),
1320 /// A tuple (e.g., `(a, b, c, d)`).
1322 /// A binary operation (e.g., `a + b`, `a * b`).
1323 Binary(BinOp, P<Expr>, P<Expr>),
1324 /// A unary operation (e.g., `!x`, `*x`).
1325 Unary(UnOp, P<Expr>),
1326 /// A literal (e.g., `1`, `"foo"`).
1328 /// A cast (e.g., `foo as f64`).
1329 Cast(P<Expr>, P<Ty>),
1330 /// A type ascription (e.g., `42: usize`).
1331 Type(P<Expr>, P<Ty>),
1332 /// A `let pat = expr` expression that is only semantically allowed in the condition
1333 /// of `if` / `while` expressions. (e.g., `if let 0 = x { .. }`).
1335 /// `Span` represents the whole `let pat = expr` statement.
1336 Let(P<Pat>, P<Expr>, Span),
1337 /// An `if` block, with an optional `else` block.
1339 /// `if expr { block } else { expr }`
1340 If(P<Expr>, P<Block>, Option<P<Expr>>),
1341 /// A while loop, with an optional label.
1343 /// `'label: while expr { block }`
1344 While(P<Expr>, P<Block>, Option<Label>),
1345 /// A `for` loop, with an optional label.
1347 /// `'label: for pat in expr { block }`
1349 /// This is desugared to a combination of `loop` and `match` expressions.
1350 ForLoop(P<Pat>, P<Expr>, P<Block>, Option<Label>),
1351 /// Conditionless loop (can be exited with `break`, `continue`, or `return`).
1353 /// `'label: loop { block }`
1354 Loop(P<Block>, Option<Label>),
1355 /// A `match` block.
1356 Match(P<Expr>, Vec<Arm>),
1357 /// A closure (e.g., `move |a, b, c| a + b + c`).
1359 /// The final span is the span of the argument block `|...|`.
1360 Closure(CaptureBy, Async, Movability, P<FnDecl>, P<Expr>, Span),
1361 /// A block (`'label: { ... }`).
1362 Block(P<Block>, Option<Label>),
1363 /// An async block (`async move { ... }`).
1365 /// The `NodeId` is the `NodeId` for the closure that results from
1366 /// desugaring an async block, just like the NodeId field in the
1367 /// `Async::Yes` variant. This is necessary in order to create a def for the
1368 /// closure which can be used as a parent of any child defs. Defs
1369 /// created during lowering cannot be made the parent of any other
1370 /// preexisting defs.
1371 Async(CaptureBy, NodeId, P<Block>),
1372 /// An await expression (`my_future.await`).
1375 /// A try block (`try { ... }`).
1378 /// An assignment (`a = foo()`).
1379 /// The `Span` argument is the span of the `=` token.
1380 Assign(P<Expr>, P<Expr>, Span),
1381 /// An assignment with an operator.
1384 AssignOp(BinOp, P<Expr>, P<Expr>),
1385 /// Access of a named (e.g., `obj.foo`) or unnamed (e.g., `obj.0`) struct field.
1386 Field(P<Expr>, Ident),
1387 /// An indexing operation (e.g., `foo[2]`).
1388 Index(P<Expr>, P<Expr>),
1389 /// A range (e.g., `1..2`, `1..`, `..2`, `1..=2`, `..=2`; and `..` in destructuring assignment).
1390 Range(Option<P<Expr>>, Option<P<Expr>>, RangeLimits),
1391 /// An underscore, used in destructuring assignment to ignore a value.
1394 /// Variable reference, possibly containing `::` and/or type
1395 /// parameters (e.g., `foo::bar::<baz>`).
1397 /// Optionally "qualified" (e.g., `<Vec<T> as SomeTrait>::SomeType`).
1398 Path(Option<QSelf>, Path),
1400 /// A referencing operation (`&a`, `&mut a`, `&raw const a` or `&raw mut a`).
1401 AddrOf(BorrowKind, Mutability, P<Expr>),
1402 /// A `break`, with an optional label to break, and an optional expression.
1403 Break(Option<Label>, Option<P<Expr>>),
1404 /// A `continue`, with an optional label.
1405 Continue(Option<Label>),
1406 /// A `return`, with an optional value to be returned.
1407 Ret(Option<P<Expr>>),
1409 /// Output of the `asm!()` macro.
1410 InlineAsm(P<InlineAsm>),
1411 /// Output of the `llvm_asm!()` macro.
1412 LlvmInlineAsm(P<LlvmInlineAsm>),
1414 /// A macro invocation; pre-expansion.
1417 /// A struct literal expression.
1419 /// E.g., `Foo {x: 1, y: 2}`, or `Foo {x: 1, .. rest}`.
1420 Struct(P<StructExpr>),
1422 /// An array literal constructed from one repeated element.
1424 /// E.g., `[1; 5]`. The expression is the element to be
1425 /// repeated; the constant is the number of times to repeat it.
1426 Repeat(P<Expr>, AnonConst),
1428 /// No-op: used solely so we can pretty-print faithfully.
1431 /// A try expression (`expr?`).
1434 /// A `yield`, with an optional value to be yielded.
1435 Yield(Option<P<Expr>>),
1437 /// Placeholder for an expression that wasn't syntactically well formed in some way.
1441 /// The explicit `Self` type in a "qualified path". The actual
1442 /// path, including the trait and the associated item, is stored
1443 /// separately. `position` represents the index of the associated
1444 /// item qualified with this `Self` type.
1446 /// ```ignore (only-for-syntax-highlight)
1447 /// <Vec<T> as a::b::Trait>::AssociatedItem
1448 /// ^~~~~ ~~~~~~~~~~~~~~^
1451 /// <Vec<T>>::AssociatedItem
1455 #[derive(Clone, Encodable, Decodable, Debug)]
1459 /// The span of `a::b::Trait` in a path like `<Vec<T> as
1460 /// a::b::Trait>::AssociatedItem`; in the case where `position ==
1461 /// 0`, this is an empty span.
1462 pub path_span: Span,
1463 pub position: usize,
1466 /// A capture clause used in closures and `async` blocks.
1467 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
1468 pub enum CaptureBy {
1469 /// `move |x| y + x`.
1471 /// `move` keyword was not specified.
1475 /// The movability of a generator / closure literal:
1476 /// whether a generator contains self-references, causing it to be `!Unpin`.
1477 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Encodable, Decodable, Debug, Copy)]
1478 #[derive(HashStable_Generic)]
1479 pub enum Movability {
1480 /// May contain self-references, `!Unpin`.
1482 /// Must not contain self-references, `Unpin`.
1486 /// Represents a macro invocation. The `path` indicates which macro
1487 /// is being invoked, and the `args` are arguments passed to it.
1488 #[derive(Clone, Encodable, Decodable, Debug)]
1489 pub struct MacCall {
1491 pub args: P<MacArgs>,
1492 pub prior_type_ascription: Option<(Span, bool)>,
1496 pub fn span(&self) -> Span {
1497 self.path.span.to(self.args.span().unwrap_or(self.path.span))
1501 /// Arguments passed to an attribute or a function-like macro.
1502 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
1504 /// No arguments - `#[attr]`.
1506 /// Delimited arguments - `#[attr()/[]/{}]` or `mac!()/[]/{}`.
1507 Delimited(DelimSpan, MacDelimiter, TokenStream),
1508 /// Arguments of a key-value attribute - `#[attr = "value"]`.
1510 /// Span of the `=` token.
1512 /// "value" as a nonterminal token.
1518 pub fn delim(&self) -> DelimToken {
1520 MacArgs::Delimited(_, delim, _) => delim.to_token(),
1521 MacArgs::Empty | MacArgs::Eq(..) => token::NoDelim,
1525 pub fn span(&self) -> Option<Span> {
1527 MacArgs::Empty => None,
1528 MacArgs::Delimited(dspan, ..) => Some(dspan.entire()),
1529 MacArgs::Eq(eq_span, token) => Some(eq_span.to(token.span)),
1533 /// Tokens inside the delimiters or after `=`.
1534 /// Proc macros see these tokens, for example.
1535 pub fn inner_tokens(&self) -> TokenStream {
1537 MacArgs::Empty => TokenStream::default(),
1538 MacArgs::Delimited(.., tokens) => tokens.clone(),
1539 MacArgs::Eq(.., token) => TokenTree::Token(token.clone()).into(),
1543 /// Whether a macro with these arguments needs a semicolon
1544 /// when used as a standalone item or statement.
1545 pub fn need_semicolon(&self) -> bool {
1546 !matches!(self, MacArgs::Delimited(_, MacDelimiter::Brace, _))
1550 #[derive(Copy, Clone, PartialEq, Eq, Encodable, Decodable, Debug, HashStable_Generic)]
1551 pub enum MacDelimiter {
1558 pub fn to_token(self) -> DelimToken {
1560 MacDelimiter::Parenthesis => DelimToken::Paren,
1561 MacDelimiter::Bracket => DelimToken::Bracket,
1562 MacDelimiter::Brace => DelimToken::Brace,
1566 pub fn from_token(delim: DelimToken) -> Option<MacDelimiter> {
1568 token::Paren => Some(MacDelimiter::Parenthesis),
1569 token::Bracket => Some(MacDelimiter::Bracket),
1570 token::Brace => Some(MacDelimiter::Brace),
1571 token::NoDelim => None,
1576 /// Represents a macro definition.
1577 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
1578 pub struct MacroDef {
1579 pub body: P<MacArgs>,
1580 /// `true` if macro was defined with `macro_rules`.
1581 pub macro_rules: bool,
1584 #[derive(Clone, Encodable, Decodable, Debug, Copy, Hash, Eq, PartialEq)]
1585 #[derive(HashStable_Generic)]
1587 /// A regular string, like `"foo"`.
1589 /// A raw string, like `r##"foo"##`.
1591 /// The value is the number of `#` symbols used.
1596 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
1598 /// The original literal token as written in source code.
1599 pub token: token::Lit,
1600 /// The "semantic" representation of the literal lowered from the original tokens.
1601 /// Strings are unescaped, hexadecimal forms are eliminated, etc.
1602 /// FIXME: Remove this and only create the semantic representation during lowering to HIR.
1607 /// Same as `Lit`, but restricted to string literals.
1608 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
1610 /// The original literal token as written in source code.
1611 pub style: StrStyle,
1613 pub suffix: Option<Symbol>,
1615 /// The unescaped "semantic" representation of the literal lowered from the original token.
1616 /// FIXME: Remove this and only create the semantic representation during lowering to HIR.
1617 pub symbol_unescaped: Symbol,
1621 pub fn as_lit(&self) -> Lit {
1622 let token_kind = match self.style {
1623 StrStyle::Cooked => token::Str,
1624 StrStyle::Raw(n) => token::StrRaw(n),
1627 token: token::Lit::new(token_kind, self.symbol, self.suffix),
1629 kind: LitKind::Str(self.symbol_unescaped, self.style),
1634 /// Type of the integer literal based on provided suffix.
1635 #[derive(Clone, Copy, Encodable, Decodable, Debug, Hash, Eq, PartialEq)]
1636 #[derive(HashStable_Generic)]
1637 pub enum LitIntType {
1646 /// Type of the float literal based on provided suffix.
1647 #[derive(Clone, Copy, Encodable, Decodable, Debug, Hash, Eq, PartialEq)]
1648 #[derive(HashStable_Generic)]
1649 pub enum LitFloatType {
1650 /// A float literal with a suffix (`1f32` or `1E10f32`).
1652 /// A float literal without a suffix (`1.0 or 1.0E10`).
1658 /// E.g., `"foo"`, `42`, `12.34`, or `bool`.
1659 #[derive(Clone, Encodable, Decodable, Debug, Hash, Eq, PartialEq, HashStable_Generic)]
1661 /// A string literal (`"foo"`).
1662 Str(Symbol, StrStyle),
1663 /// A byte string (`b"foo"`).
1665 /// A byte char (`b'f'`).
1667 /// A character literal (`'a'`).
1669 /// An integer literal (`1`).
1670 Int(u128, LitIntType),
1671 /// A float literal (`1f64` or `1E10f64`).
1672 Float(Symbol, LitFloatType),
1673 /// A boolean literal.
1675 /// Placeholder for a literal that wasn't well-formed in some way.
1680 /// Returns `true` if this literal is a string.
1681 pub fn is_str(&self) -> bool {
1682 matches!(self, LitKind::Str(..))
1685 /// Returns `true` if this literal is byte literal string.
1686 pub fn is_bytestr(&self) -> bool {
1687 matches!(self, LitKind::ByteStr(_))
1690 /// Returns `true` if this is a numeric literal.
1691 pub fn is_numeric(&self) -> bool {
1692 matches!(self, LitKind::Int(..) | LitKind::Float(..))
1695 /// Returns `true` if this literal has no suffix.
1696 /// Note: this will return true for literals with prefixes such as raw strings and byte strings.
1697 pub fn is_unsuffixed(&self) -> bool {
1701 /// Returns `true` if this literal has a suffix.
1702 pub fn is_suffixed(&self) -> bool {
1704 // suffixed variants
1705 LitKind::Int(_, LitIntType::Signed(..) | LitIntType::Unsigned(..))
1706 | LitKind::Float(_, LitFloatType::Suffixed(..)) => true,
1707 // unsuffixed variants
1709 | LitKind::ByteStr(..)
1712 | LitKind::Int(_, LitIntType::Unsuffixed)
1713 | LitKind::Float(_, LitFloatType::Unsuffixed)
1715 | LitKind::Err(..) => false,
1720 // N.B., If you change this, you'll probably want to change the corresponding
1721 // type structure in `middle/ty.rs` as well.
1722 #[derive(Clone, Encodable, Decodable, Debug)]
1725 pub mutbl: Mutability,
1728 /// Represents a function's signature in a trait declaration,
1729 /// trait implementation, or free function.
1730 #[derive(Clone, Encodable, Decodable, Debug)]
1732 pub header: FnHeader,
1733 pub decl: P<FnDecl>,
1737 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
1738 #[derive(Encodable, Decodable, HashStable_Generic)]
1745 pub fn name_str(self) -> &'static str {
1747 FloatTy::F32 => "f32",
1748 FloatTy::F64 => "f64",
1752 pub fn name(self) -> Symbol {
1754 FloatTy::F32 => sym::f32,
1755 FloatTy::F64 => sym::f64,
1760 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
1761 #[derive(Encodable, Decodable, HashStable_Generic)]
1772 pub fn name_str(&self) -> &'static str {
1774 IntTy::Isize => "isize",
1776 IntTy::I16 => "i16",
1777 IntTy::I32 => "i32",
1778 IntTy::I64 => "i64",
1779 IntTy::I128 => "i128",
1783 pub fn name(&self) -> Symbol {
1785 IntTy::Isize => sym::isize,
1786 IntTy::I8 => sym::i8,
1787 IntTy::I16 => sym::i16,
1788 IntTy::I32 => sym::i32,
1789 IntTy::I64 => sym::i64,
1790 IntTy::I128 => sym::i128,
1795 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Copy, Debug)]
1796 #[derive(Encodable, Decodable, HashStable_Generic)]
1807 pub fn name_str(&self) -> &'static str {
1809 UintTy::Usize => "usize",
1811 UintTy::U16 => "u16",
1812 UintTy::U32 => "u32",
1813 UintTy::U64 => "u64",
1814 UintTy::U128 => "u128",
1818 pub fn name(&self) -> Symbol {
1820 UintTy::Usize => sym::usize,
1821 UintTy::U8 => sym::u8,
1822 UintTy::U16 => sym::u16,
1823 UintTy::U32 => sym::u32,
1824 UintTy::U64 => sym::u64,
1825 UintTy::U128 => sym::u128,
1830 /// A constraint on an associated type (e.g., `A = Bar` in `Foo<A = Bar>` or
1831 /// `A: TraitA + TraitB` in `Foo<A: TraitA + TraitB>`).
1832 #[derive(Clone, Encodable, Decodable, Debug)]
1833 pub struct AssocTyConstraint {
1836 pub gen_args: Option<GenericArgs>,
1837 pub kind: AssocTyConstraintKind,
1841 /// The kinds of an `AssocTyConstraint`.
1842 #[derive(Clone, Encodable, Decodable, Debug)]
1843 pub enum AssocTyConstraintKind {
1844 /// E.g., `A = Bar` in `Foo<A = Bar>`.
1845 Equality { ty: P<Ty> },
1846 /// E.g. `A: TraitA + TraitB` in `Foo<A: TraitA + TraitB>`.
1847 Bound { bounds: GenericBounds },
1850 #[derive(Encodable, Decodable, Debug)]
1855 pub tokens: Option<LazyTokenStream>,
1859 fn clone(&self) -> Self {
1860 ensure_sufficient_stack(|| Self {
1862 kind: self.kind.clone(),
1864 tokens: self.tokens.clone(),
1870 pub fn peel_refs(&self) -> &Self {
1871 let mut final_ty = self;
1872 while let TyKind::Rptr(_, MutTy { ty, .. }) = &final_ty.kind {
1879 #[derive(Clone, Encodable, Decodable, Debug)]
1880 pub struct BareFnTy {
1881 pub unsafety: Unsafe,
1883 pub generic_params: Vec<GenericParam>,
1884 pub decl: P<FnDecl>,
1887 /// The various kinds of type recognized by the compiler.
1888 #[derive(Clone, Encodable, Decodable, Debug)]
1890 /// A variable-length slice (`[T]`).
1892 /// A fixed length array (`[T; n]`).
1893 Array(P<Ty>, AnonConst),
1894 /// A raw pointer (`*const T` or `*mut T`).
1896 /// A reference (`&'a T` or `&'a mut T`).
1897 Rptr(Option<Lifetime>, MutTy),
1898 /// A bare function (e.g., `fn(usize) -> bool`).
1899 BareFn(P<BareFnTy>),
1900 /// The never type (`!`).
1902 /// A tuple (`(A, B, C, D,...)`).
1904 /// An anonymous struct type i.e. `struct { foo: Type }`
1905 AnonymousStruct(Vec<FieldDef>, bool),
1906 /// An anonymous union type i.e. `union { bar: Type }`
1907 AnonymousUnion(Vec<FieldDef>, bool),
1908 /// A path (`module::module::...::Type`), optionally
1909 /// "qualified", e.g., `<Vec<T> as SomeTrait>::SomeType`.
1911 /// Type parameters are stored in the `Path` itself.
1912 Path(Option<QSelf>, Path),
1913 /// A trait object type `Bound1 + Bound2 + Bound3`
1914 /// where `Bound` is a trait or a lifetime.
1915 TraitObject(GenericBounds, TraitObjectSyntax),
1916 /// An `impl Bound1 + Bound2 + Bound3` type
1917 /// where `Bound` is a trait or a lifetime.
1919 /// The `NodeId` exists to prevent lowering from having to
1920 /// generate `NodeId`s on the fly, which would complicate
1921 /// the generation of opaque `type Foo = impl Trait` items significantly.
1922 ImplTrait(NodeId, GenericBounds),
1923 /// No-op; kept solely so that we can pretty-print faithfully.
1927 /// This means the type should be inferred instead of it having been
1928 /// specified. This can appear anywhere in a type.
1930 /// Inferred type of a `self` or `&self` argument in a method.
1932 /// A macro in the type position.
1934 /// Placeholder for a kind that has failed to be defined.
1936 /// Placeholder for a `va_list`.
1941 pub fn is_implicit_self(&self) -> bool {
1942 matches!(self, TyKind::ImplicitSelf)
1945 pub fn is_unit(&self) -> bool {
1946 matches!(self, TyKind::Tup(tys) if tys.is_empty())
1950 /// Syntax used to declare a trait object.
1951 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
1952 pub enum TraitObjectSyntax {
1957 /// Inline assembly operand explicit register or register class.
1959 /// E.g., `"eax"` as in `asm!("mov eax, 2", out("eax") result)`.
1960 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
1961 pub enum InlineAsmRegOrRegClass {
1966 bitflags::bitflags! {
1967 #[derive(Encodable, Decodable, HashStable_Generic)]
1968 pub struct InlineAsmOptions: u8 {
1969 const PURE = 1 << 0;
1970 const NOMEM = 1 << 1;
1971 const READONLY = 1 << 2;
1972 const PRESERVES_FLAGS = 1 << 3;
1973 const NORETURN = 1 << 4;
1974 const NOSTACK = 1 << 5;
1975 const ATT_SYNTAX = 1 << 6;
1980 #[derive(Clone, PartialEq, PartialOrd, Encodable, Decodable, Debug, Hash, HashStable_Generic)]
1981 pub enum InlineAsmTemplatePiece {
1983 Placeholder { operand_idx: usize, modifier: Option<char>, span: Span },
1986 impl fmt::Display for InlineAsmTemplatePiece {
1987 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1989 Self::String(s) => {
1990 for c in s.chars() {
1992 '{' => f.write_str("{{")?,
1993 '}' => f.write_str("}}")?,
1999 Self::Placeholder { operand_idx, modifier: Some(modifier), .. } => {
2000 write!(f, "{{{}:{}}}", operand_idx, modifier)
2002 Self::Placeholder { operand_idx, modifier: None, .. } => {
2003 write!(f, "{{{}}}", operand_idx)
2009 impl InlineAsmTemplatePiece {
2010 /// Rebuilds the asm template string from its pieces.
2011 pub fn to_string(s: &[Self]) -> String {
2013 let mut out = String::new();
2015 let _ = write!(out, "{}", p);
2021 /// Inline assembly operand.
2023 /// E.g., `out("eax") result` as in `asm!("mov eax, 2", out("eax") result)`.
2024 #[derive(Clone, Encodable, Decodable, Debug)]
2025 pub enum InlineAsmOperand {
2027 reg: InlineAsmRegOrRegClass,
2031 reg: InlineAsmRegOrRegClass,
2033 expr: Option<P<Expr>>,
2036 reg: InlineAsmRegOrRegClass,
2041 reg: InlineAsmRegOrRegClass,
2044 out_expr: Option<P<Expr>>,
2047 anon_const: AnonConst,
2054 /// Inline assembly.
2056 /// E.g., `asm!("NOP");`.
2057 #[derive(Clone, Encodable, Decodable, Debug)]
2058 pub struct InlineAsm {
2059 pub template: Vec<InlineAsmTemplatePiece>,
2060 pub template_strs: Box<[(Symbol, Option<Symbol>, Span)]>,
2061 pub operands: Vec<(InlineAsmOperand, Span)>,
2062 pub clobber_abi: Option<(Symbol, Span)>,
2063 pub options: InlineAsmOptions,
2064 pub line_spans: Vec<Span>,
2067 /// Inline assembly dialect.
2069 /// E.g., `"intel"` as in `llvm_asm!("mov eax, 2" : "={eax}"(result) : : : "intel")`.
2070 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy, Hash, HashStable_Generic)]
2071 pub enum LlvmAsmDialect {
2076 /// LLVM-style inline assembly.
2078 /// E.g., `"={eax}"(result)` as in `llvm_asm!("mov eax, 2" : "={eax}"(result) : : : "intel")`.
2079 #[derive(Clone, Encodable, Decodable, Debug)]
2080 pub struct LlvmInlineAsmOutput {
2081 pub constraint: Symbol,
2084 pub is_indirect: bool,
2087 /// LLVM-style inline assembly.
2089 /// E.g., `llvm_asm!("NOP");`.
2090 #[derive(Clone, Encodable, Decodable, Debug)]
2091 pub struct LlvmInlineAsm {
2093 pub asm_str_style: StrStyle,
2094 pub outputs: Vec<LlvmInlineAsmOutput>,
2095 pub inputs: Vec<(Symbol, P<Expr>)>,
2096 pub clobbers: Vec<Symbol>,
2098 pub alignstack: bool,
2099 pub dialect: LlvmAsmDialect,
2102 /// A parameter in a function header.
2104 /// E.g., `bar: usize` as in `fn foo(bar: usize)`.
2105 #[derive(Clone, Encodable, Decodable, Debug)]
2112 pub is_placeholder: bool,
2115 /// Alternative representation for `Arg`s describing `self` parameter of methods.
2117 /// E.g., `&mut self` as in `fn foo(&mut self)`.
2118 #[derive(Clone, Encodable, Decodable, Debug)]
2120 /// `self`, `mut self`
2122 /// `&'lt self`, `&'lt mut self`
2123 Region(Option<Lifetime>, Mutability),
2124 /// `self: TYPE`, `mut self: TYPE`
2125 Explicit(P<Ty>, Mutability),
2128 pub type ExplicitSelf = Spanned<SelfKind>;
2131 /// Attempts to cast parameter to `ExplicitSelf`.
2132 pub fn to_self(&self) -> Option<ExplicitSelf> {
2133 if let PatKind::Ident(BindingMode::ByValue(mutbl), ident, _) = self.pat.kind {
2134 if ident.name == kw::SelfLower {
2135 return match self.ty.kind {
2136 TyKind::ImplicitSelf => Some(respan(self.pat.span, SelfKind::Value(mutbl))),
2137 TyKind::Rptr(lt, MutTy { ref ty, mutbl }) if ty.kind.is_implicit_self() => {
2138 Some(respan(self.pat.span, SelfKind::Region(lt, mutbl)))
2141 self.pat.span.to(self.ty.span),
2142 SelfKind::Explicit(self.ty.clone(), mutbl),
2150 /// Returns `true` if parameter is `self`.
2151 pub fn is_self(&self) -> bool {
2152 if let PatKind::Ident(_, ident, _) = self.pat.kind {
2153 ident.name == kw::SelfLower
2159 /// Builds a `Param` object from `ExplicitSelf`.
2160 pub fn from_self(attrs: AttrVec, eself: ExplicitSelf, eself_ident: Ident) -> Param {
2161 let span = eself.span.to(eself_ident.span);
2162 let infer_ty = P(Ty { id: DUMMY_NODE_ID, kind: TyKind::ImplicitSelf, span, tokens: None });
2163 let param = |mutbl, ty| Param {
2167 kind: PatKind::Ident(BindingMode::ByValue(mutbl), eself_ident, None),
2174 is_placeholder: false,
2177 SelfKind::Explicit(ty, mutbl) => param(mutbl, ty),
2178 SelfKind::Value(mutbl) => param(mutbl, infer_ty),
2179 SelfKind::Region(lt, mutbl) => param(
2183 kind: TyKind::Rptr(lt, MutTy { ty: infer_ty, mutbl }),
2192 /// A signature (not the body) of a function declaration.
2194 /// E.g., `fn foo(bar: baz)`.
2196 /// Please note that it's different from `FnHeader` structure
2197 /// which contains metadata about function safety, asyncness, constness and ABI.
2198 #[derive(Clone, Encodable, Decodable, Debug)]
2200 pub inputs: Vec<Param>,
2201 pub output: FnRetTy,
2205 pub fn has_self(&self) -> bool {
2206 self.inputs.get(0).map_or(false, Param::is_self)
2208 pub fn c_variadic(&self) -> bool {
2209 self.inputs.last().map_or(false, |arg| matches!(arg.ty.kind, TyKind::CVarArgs))
2213 /// Is the trait definition an auto trait?
2214 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
2220 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Encodable, Decodable, Debug)]
2221 #[derive(HashStable_Generic)]
2227 #[derive(Copy, Clone, Encodable, Decodable, Debug)]
2229 Yes { span: Span, closure_id: NodeId, return_impl_trait_id: NodeId },
2234 pub fn is_async(self) -> bool {
2235 matches!(self, Async::Yes { .. })
2238 /// In this case this is an `async` return, the `NodeId` for the generated `impl Trait` item.
2239 pub fn opt_return_id(self) -> Option<NodeId> {
2241 Async::Yes { return_impl_trait_id, .. } => Some(return_impl_trait_id),
2247 #[derive(Copy, Clone, PartialEq, Eq, Hash, Encodable, Decodable, Debug)]
2248 #[derive(HashStable_Generic)]
2254 /// Item defaultness.
2255 /// For details see the [RFC #2532](https://github.com/rust-lang/rfcs/pull/2532).
2256 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, Debug, HashStable_Generic)]
2257 pub enum Defaultness {
2262 #[derive(Copy, Clone, PartialEq, Encodable, Decodable, HashStable_Generic)]
2263 pub enum ImplPolarity {
2264 /// `impl Trait for Type`
2266 /// `impl !Trait for Type`
2270 impl fmt::Debug for ImplPolarity {
2271 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
2273 ImplPolarity::Positive => "positive".fmt(f),
2274 ImplPolarity::Negative(_) => "negative".fmt(f),
2279 #[derive(Clone, Encodable, Decodable, Debug)]
2281 /// Returns type is not specified.
2283 /// Functions default to `()` and closures default to inference.
2284 /// Span points to where return type would be inserted.
2286 /// Everything else.
2291 pub fn span(&self) -> Span {
2293 FnRetTy::Default(span) => span,
2294 FnRetTy::Ty(ref ty) => ty.span,
2299 #[derive(Clone, Copy, PartialEq, Encodable, Decodable, Debug)]
2305 /// Module item kind.
2306 #[derive(Clone, Encodable, Decodable, Debug)]
2308 /// Module with inlined definition `mod foo { ... }`,
2309 /// or with definition outlined to a separate file `mod foo;` and already loaded from it.
2310 /// The inner span is from the first token past `{` to the last token until `}`,
2311 /// or from the first to the last token in the loaded file.
2312 Loaded(Vec<P<Item>>, Inline, Span),
2313 /// Module with definition outlined to a separate file `mod foo;` but not yet loaded from it.
2317 /// Foreign module declaration.
2319 /// E.g., `extern { .. }` or `extern "C" { .. }`.
2320 #[derive(Clone, Encodable, Decodable, Debug)]
2321 pub struct ForeignMod {
2322 /// `unsafe` keyword accepted syntactically for macro DSLs, but not
2323 /// semantically by Rust.
2324 pub unsafety: Unsafe,
2325 pub abi: Option<StrLit>,
2326 pub items: Vec<P<ForeignItem>>,
2329 #[derive(Clone, Encodable, Decodable, Debug)]
2330 pub struct EnumDef {
2331 pub variants: Vec<Variant>,
2334 #[derive(Clone, Encodable, Decodable, Debug)]
2335 pub struct Variant {
2336 /// Attributes of the variant.
2338 /// Id of the variant (not the constructor, see `VariantData::ctor_id()`).
2342 /// The visibility of the variant. Syntactically accepted but not semantically.
2343 pub vis: Visibility,
2344 /// Name of the variant.
2347 /// Fields and constructor id of the variant.
2348 pub data: VariantData,
2349 /// Explicit discriminant, e.g., `Foo = 1`.
2350 pub disr_expr: Option<AnonConst>,
2351 /// Is a macro placeholder
2352 pub is_placeholder: bool,
2355 /// Part of `use` item to the right of its prefix.
2356 #[derive(Clone, Encodable, Decodable, Debug)]
2357 pub enum UseTreeKind {
2358 /// `use prefix` or `use prefix as rename`
2360 /// The extra `NodeId`s are for HIR lowering, when additional statements are created for each
2362 Simple(Option<Ident>, NodeId, NodeId),
2363 /// `use prefix::{...}`
2364 Nested(Vec<(UseTree, NodeId)>),
2369 /// A tree of paths sharing common prefixes.
2370 /// Used in `use` items both at top-level and inside of braces in import groups.
2371 #[derive(Clone, Encodable, Decodable, Debug)]
2372 pub struct UseTree {
2374 pub kind: UseTreeKind,
2379 pub fn ident(&self) -> Ident {
2381 UseTreeKind::Simple(Some(rename), ..) => rename,
2382 UseTreeKind::Simple(None, ..) => {
2383 self.prefix.segments.last().expect("empty prefix in a simple import").ident
2385 _ => panic!("`UseTree::ident` can only be used on a simple import"),
2390 /// Distinguishes between `Attribute`s that decorate items and Attributes that
2391 /// are contained as statements within items. These two cases need to be
2392 /// distinguished for pretty-printing.
2393 #[derive(Clone, PartialEq, Encodable, Decodable, Debug, Copy, HashStable_Generic)]
2394 pub enum AttrStyle {
2399 rustc_index::newtype_index! {
2402 DEBUG_FORMAT = "AttrId({})"
2406 impl<S: Encoder> rustc_serialize::Encodable<S> for AttrId {
2407 fn encode(&self, s: &mut S) -> Result<(), S::Error> {
2412 impl<D: Decoder> rustc_serialize::Decodable<D> for AttrId {
2413 fn decode(d: &mut D) -> Result<AttrId, D::Error> {
2414 d.read_nil().map(|_| crate::attr::mk_attr_id())
2418 #[derive(Clone, Encodable, Decodable, Debug, HashStable_Generic)]
2419 pub struct AttrItem {
2422 pub tokens: Option<LazyTokenStream>,
2425 /// A list of attributes.
2426 pub type AttrVec = ThinVec<Attribute>;
2428 /// Metadata associated with an item.
2429 #[derive(Clone, Encodable, Decodable, Debug)]
2430 pub struct Attribute {
2433 /// Denotes if the attribute decorates the following construct (outer)
2434 /// or the construct this attribute is contained within (inner).
2435 pub style: AttrStyle,
2439 #[derive(Clone, Encodable, Decodable, Debug)]
2441 /// A normal attribute.
2442 Normal(AttrItem, Option<LazyTokenStream>),
2444 /// A doc comment (e.g. `/// ...`, `//! ...`, `/** ... */`, `/*! ... */`).
2445 /// Doc attributes (e.g. `#[doc="..."]`) are represented with the `Normal`
2446 /// variant (which is much less compact and thus more expensive).
2447 DocComment(CommentKind, Symbol),
2450 /// `TraitRef`s appear in impls.
2452 /// Resolution maps each `TraitRef`'s `ref_id` to its defining trait; that's all
2453 /// that the `ref_id` is for. The `impl_id` maps to the "self type" of this impl.
2454 /// If this impl is an `ItemKind::Impl`, the `impl_id` is redundant (it could be the
2455 /// same as the impl's `NodeId`).
2456 #[derive(Clone, Encodable, Decodable, Debug)]
2457 pub struct TraitRef {
2462 #[derive(Clone, Encodable, Decodable, Debug)]
2463 pub struct PolyTraitRef {
2464 /// The `'a` in `<'a> Foo<&'a T>`.
2465 pub bound_generic_params: Vec<GenericParam>,
2467 /// The `Foo<&'a T>` in `<'a> Foo<&'a T>`.
2468 pub trait_ref: TraitRef,
2474 pub fn new(generic_params: Vec<GenericParam>, path: Path, span: Span) -> Self {
2476 bound_generic_params: generic_params,
2477 trait_ref: TraitRef { path, ref_id: DUMMY_NODE_ID },
2483 #[derive(Copy, Clone, Encodable, Decodable, Debug, HashStable_Generic)]
2484 pub enum CrateSugar {
2485 /// Source is `pub(crate)`.
2488 /// Source is (just) `crate`.
2492 #[derive(Clone, Encodable, Decodable, Debug)]
2493 pub struct Visibility {
2494 pub kind: VisibilityKind,
2496 pub tokens: Option<LazyTokenStream>,
2499 #[derive(Clone, Encodable, Decodable, Debug)]
2500 pub enum VisibilityKind {
2503 Restricted { path: P<Path>, id: NodeId },
2507 impl VisibilityKind {
2508 pub fn is_pub(&self) -> bool {
2509 matches!(self, VisibilityKind::Public)
2513 /// Field definition in a struct, variant or union.
2515 /// E.g., `bar: usize` as in `struct Foo { bar: usize }`.
2516 #[derive(Clone, Encodable, Decodable, Debug)]
2517 pub struct FieldDef {
2521 pub vis: Visibility,
2522 pub ident: Option<Ident>,
2525 pub is_placeholder: bool,
2528 /// Fields and constructor ids of enum variants and structs.
2529 #[derive(Clone, Encodable, Decodable, Debug)]
2530 pub enum VariantData {
2533 /// E.g., `Bar { .. }` as in `enum Foo { Bar { .. } }`.
2534 Struct(Vec<FieldDef>, bool),
2537 /// E.g., `Bar(..)` as in `enum Foo { Bar(..) }`.
2538 Tuple(Vec<FieldDef>, NodeId),
2541 /// E.g., `Bar = ..` as in `enum Foo { Bar = .. }`.
2546 /// Return the fields of this variant.
2547 pub fn fields(&self) -> &[FieldDef] {
2549 VariantData::Struct(ref fields, ..) | VariantData::Tuple(ref fields, _) => fields,
2554 /// Return the `NodeId` of this variant's constructor, if it has one.
2555 pub fn ctor_id(&self) -> Option<NodeId> {
2557 VariantData::Struct(..) => None,
2558 VariantData::Tuple(_, id) | VariantData::Unit(id) => Some(id),
2563 /// An item definition.
2564 #[derive(Clone, Encodable, Decodable, Debug)]
2565 pub struct Item<K = ItemKind> {
2566 pub attrs: Vec<Attribute>,
2569 pub vis: Visibility,
2570 /// The name of the item.
2571 /// It might be a dummy name in case of anonymous items.
2576 /// Original tokens this item was parsed from. This isn't necessarily
2577 /// available for all items, although over time more and more items should
2578 /// have this be `Some`. Right now this is primarily used for procedural
2579 /// macros, notably custom attributes.
2581 /// Note that the tokens here do not include the outer attributes, but will
2582 /// include inner attributes.
2583 pub tokens: Option<LazyTokenStream>,
2587 /// Return the span that encompasses the attributes.
2588 pub fn span_with_attributes(&self) -> Span {
2589 self.attrs.iter().fold(self.span, |acc, attr| acc.to(attr.span))
2593 impl<K: Into<ItemKind>> Item<K> {
2594 pub fn into_item(self) -> Item {
2595 let Item { attrs, id, span, vis, ident, kind, tokens } = self;
2596 Item { attrs, id, span, vis, ident, kind: kind.into(), tokens }
2600 /// `extern` qualifier on a function item or function type.
2601 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
2609 pub fn from_abi(abi: Option<StrLit>) -> Extern {
2610 abi.map_or(Extern::Implicit, Extern::Explicit)
2614 /// A function header.
2616 /// All the information between the visibility and the name of the function is
2617 /// included in this struct (e.g., `async unsafe fn` or `const extern "C" fn`).
2618 #[derive(Clone, Copy, Encodable, Decodable, Debug)]
2619 pub struct FnHeader {
2620 pub unsafety: Unsafe,
2621 pub asyncness: Async,
2622 pub constness: Const,
2627 /// Does this function header have any qualifiers or is it empty?
2628 pub fn has_qualifiers(&self) -> bool {
2629 let Self { unsafety, asyncness, constness, ext } = self;
2630 matches!(unsafety, Unsafe::Yes(_))
2631 || asyncness.is_async()
2632 || matches!(constness, Const::Yes(_))
2633 || !matches!(ext, Extern::None)
2637 impl Default for FnHeader {
2638 fn default() -> FnHeader {
2640 unsafety: Unsafe::No,
2641 asyncness: Async::No,
2642 constness: Const::No,
2648 #[derive(Clone, Encodable, Decodable, Debug)]
2649 pub struct TraitKind(
2654 pub Vec<P<AssocItem>>,
2657 #[derive(Clone, Encodable, Decodable, Debug)]
2658 pub struct TyAliasKind(pub Defaultness, pub Generics, pub GenericBounds, pub Option<P<Ty>>);
2660 #[derive(Clone, Encodable, Decodable, Debug)]
2661 pub struct ImplKind {
2662 pub unsafety: Unsafe,
2663 pub polarity: ImplPolarity,
2664 pub defaultness: Defaultness,
2665 pub constness: Const,
2666 pub generics: Generics,
2668 /// The trait being implemented, if any.
2669 pub of_trait: Option<TraitRef>,
2672 pub items: Vec<P<AssocItem>>,
2675 #[derive(Clone, Encodable, Decodable, Debug)]
2676 pub struct FnKind(pub Defaultness, pub FnSig, pub Generics, pub Option<P<Block>>);
2678 #[derive(Clone, Encodable, Decodable, Debug)]
2680 /// An `extern crate` item, with the optional *original* crate name if the crate was renamed.
2682 /// E.g., `extern crate foo` or `extern crate foo_bar as foo`.
2683 ExternCrate(Option<Symbol>),
2684 /// A use declaration item (`use`).
2686 /// E.g., `use foo;`, `use foo::bar;` or `use foo::bar as FooBar;`.
2688 /// A static item (`static`).
2690 /// E.g., `static FOO: i32 = 42;` or `static FOO: &'static str = "bar";`.
2691 Static(P<Ty>, Mutability, Option<P<Expr>>),
2692 /// A constant item (`const`).
2694 /// E.g., `const FOO: i32 = 42;`.
2695 Const(Defaultness, P<Ty>, Option<P<Expr>>),
2696 /// A function declaration (`fn`).
2698 /// E.g., `fn foo(bar: usize) -> usize { .. }`.
2700 /// A module declaration (`mod`).
2702 /// E.g., `mod foo;` or `mod foo { .. }`.
2703 /// `unsafe` keyword on modules is accepted syntactically for macro DSLs, but not
2704 /// semantically by Rust.
2705 Mod(Unsafe, ModKind),
2706 /// An external module (`extern`).
2708 /// E.g., `extern {}` or `extern "C" {}`.
2709 ForeignMod(ForeignMod),
2710 /// Module-level inline assembly (from `global_asm!()`).
2711 GlobalAsm(InlineAsm),
2712 /// A type alias (`type`).
2714 /// E.g., `type Foo = Bar<u8>;`.
2715 TyAlias(Box<TyAliasKind>),
2716 /// An enum definition (`enum`).
2718 /// E.g., `enum Foo<A, B> { C<A>, D<B> }`.
2719 Enum(EnumDef, Generics),
2720 /// A struct definition (`struct`).
2722 /// E.g., `struct Foo<A> { x: A }`.
2723 Struct(VariantData, Generics),
2724 /// A union definition (`union`).
2726 /// E.g., `union Foo<A, B> { x: A, y: B }`.
2727 Union(VariantData, Generics),
2728 /// A trait declaration (`trait`).
2730 /// E.g., `trait Foo { .. }`, `trait Foo<T> { .. }` or `auto trait Foo {}`.
2731 Trait(Box<TraitKind>),
2734 /// E.g., `trait Foo = Bar + Quux;`.
2735 TraitAlias(Generics, GenericBounds),
2736 /// An implementation.
2738 /// E.g., `impl<A> Foo<A> { .. }` or `impl<A> Trait for Foo<A> { .. }`.
2739 Impl(Box<ImplKind>),
2740 /// A macro invocation.
2742 /// E.g., `foo!(..)`.
2745 /// A macro definition.
2749 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2750 rustc_data_structures::static_assert_size!(ItemKind, 112);
2753 pub fn article(&self) -> &str {
2756 Use(..) | Static(..) | Const(..) | Fn(..) | Mod(..) | GlobalAsm(..) | TyAlias(..)
2757 | Struct(..) | Union(..) | Trait(..) | TraitAlias(..) | MacroDef(..) => "a",
2758 ExternCrate(..) | ForeignMod(..) | MacCall(..) | Enum(..) | Impl { .. } => "an",
2762 pub fn descr(&self) -> &str {
2764 ItemKind::ExternCrate(..) => "extern crate",
2765 ItemKind::Use(..) => "`use` import",
2766 ItemKind::Static(..) => "static item",
2767 ItemKind::Const(..) => "constant item",
2768 ItemKind::Fn(..) => "function",
2769 ItemKind::Mod(..) => "module",
2770 ItemKind::ForeignMod(..) => "extern block",
2771 ItemKind::GlobalAsm(..) => "global asm item",
2772 ItemKind::TyAlias(..) => "type alias",
2773 ItemKind::Enum(..) => "enum",
2774 ItemKind::Struct(..) => "struct",
2775 ItemKind::Union(..) => "union",
2776 ItemKind::Trait(..) => "trait",
2777 ItemKind::TraitAlias(..) => "trait alias",
2778 ItemKind::MacCall(..) => "item macro invocation",
2779 ItemKind::MacroDef(..) => "macro definition",
2780 ItemKind::Impl { .. } => "implementation",
2784 pub fn generics(&self) -> Option<&Generics> {
2786 Self::Fn(box FnKind(_, _, generics, _))
2787 | Self::TyAlias(box TyAliasKind(_, generics, ..))
2788 | Self::Enum(_, generics)
2789 | Self::Struct(_, generics)
2790 | Self::Union(_, generics)
2791 | Self::Trait(box TraitKind(_, _, generics, ..))
2792 | Self::TraitAlias(generics, _)
2793 | Self::Impl(box ImplKind { generics, .. }) => Some(generics),
2799 /// Represents associated items.
2800 /// These include items in `impl` and `trait` definitions.
2801 pub type AssocItem = Item<AssocItemKind>;
2803 /// Represents associated item kinds.
2805 /// The term "provided" in the variants below refers to the item having a default
2806 /// definition / body. Meanwhile, a "required" item lacks a definition / body.
2807 /// In an implementation, all items must be provided.
2808 /// The `Option`s below denote the bodies, where `Some(_)`
2809 /// means "provided" and conversely `None` means "required".
2810 #[derive(Clone, Encodable, Decodable, Debug)]
2811 pub enum AssocItemKind {
2812 /// An associated constant, `const $ident: $ty $def?;` where `def ::= "=" $expr? ;`.
2813 /// If `def` is parsed, then the constant is provided, and otherwise required.
2814 Const(Defaultness, P<Ty>, Option<P<Expr>>),
2815 /// An associated function.
2817 /// An associated type.
2818 TyAlias(Box<TyAliasKind>),
2819 /// A macro expanding to associated items.
2823 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2824 rustc_data_structures::static_assert_size!(AssocItemKind, 72);
2826 impl AssocItemKind {
2827 pub fn defaultness(&self) -> Defaultness {
2829 Self::Const(def, ..)
2830 | Self::Fn(box FnKind(def, ..))
2831 | Self::TyAlias(box TyAliasKind(def, ..)) => def,
2832 Self::MacCall(..) => Defaultness::Final,
2837 impl From<AssocItemKind> for ItemKind {
2838 fn from(assoc_item_kind: AssocItemKind) -> ItemKind {
2839 match assoc_item_kind {
2840 AssocItemKind::Const(a, b, c) => ItemKind::Const(a, b, c),
2841 AssocItemKind::Fn(fn_kind) => ItemKind::Fn(fn_kind),
2842 AssocItemKind::TyAlias(ty_alias_kind) => ItemKind::TyAlias(ty_alias_kind),
2843 AssocItemKind::MacCall(a) => ItemKind::MacCall(a),
2848 impl TryFrom<ItemKind> for AssocItemKind {
2849 type Error = ItemKind;
2851 fn try_from(item_kind: ItemKind) -> Result<AssocItemKind, ItemKind> {
2852 Ok(match item_kind {
2853 ItemKind::Const(a, b, c) => AssocItemKind::Const(a, b, c),
2854 ItemKind::Fn(fn_kind) => AssocItemKind::Fn(fn_kind),
2855 ItemKind::TyAlias(ty_alias_kind) => AssocItemKind::TyAlias(ty_alias_kind),
2856 ItemKind::MacCall(a) => AssocItemKind::MacCall(a),
2857 _ => return Err(item_kind),
2862 /// An item in `extern` block.
2863 #[derive(Clone, Encodable, Decodable, Debug)]
2864 pub enum ForeignItemKind {
2865 /// A foreign static item (`static FOO: u8`).
2866 Static(P<Ty>, Mutability, Option<P<Expr>>),
2867 /// An foreign function.
2869 /// An foreign type.
2870 TyAlias(Box<TyAliasKind>),
2871 /// A macro expanding to foreign items.
2875 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
2876 rustc_data_structures::static_assert_size!(ForeignItemKind, 72);
2878 impl From<ForeignItemKind> for ItemKind {
2879 fn from(foreign_item_kind: ForeignItemKind) -> ItemKind {
2880 match foreign_item_kind {
2881 ForeignItemKind::Static(a, b, c) => ItemKind::Static(a, b, c),
2882 ForeignItemKind::Fn(fn_kind) => ItemKind::Fn(fn_kind),
2883 ForeignItemKind::TyAlias(ty_alias_kind) => ItemKind::TyAlias(ty_alias_kind),
2884 ForeignItemKind::MacCall(a) => ItemKind::MacCall(a),
2889 impl TryFrom<ItemKind> for ForeignItemKind {
2890 type Error = ItemKind;
2892 fn try_from(item_kind: ItemKind) -> Result<ForeignItemKind, ItemKind> {
2893 Ok(match item_kind {
2894 ItemKind::Static(a, b, c) => ForeignItemKind::Static(a, b, c),
2895 ItemKind::Fn(fn_kind) => ForeignItemKind::Fn(fn_kind),
2896 ItemKind::TyAlias(ty_alias_kind) => ForeignItemKind::TyAlias(ty_alias_kind),
2897 ItemKind::MacCall(a) => ForeignItemKind::MacCall(a),
2898 _ => return Err(item_kind),
2903 pub type ForeignItem = Item<ForeignItemKind>;