compiler/rustc_middle/src/ty/sty.rs

   1 //! This module contains `TyKind` and its major components.
   2
   3 #![allow(rustc::usage_of_ty_tykind)]
   4
   5 use self::TyKind::*;
   6
   7 use crate::infer::canonical::Canonical;
   8 use crate::ty::fold::ValidateBoundVars;
   9 use crate::ty::subst::{GenericArg, InternalSubsts, Subst, SubstsRef};
  10 use crate::ty::InferTy::{self, *};
  11 use crate::ty::{
  12     self, AdtDef, DefIdTree, Discr, Term, Ty, TyCtxt, TypeFlags, TypeFoldable, TypeVisitor,
  13 };
  14 use crate::ty::{DelaySpanBugEmitted, List, ParamEnv};
  15 use polonius_engine::Atom;
  16 use rustc_data_structures::captures::Captures;
  17 use rustc_data_structures::intern::Interned;
  18 use rustc_hir as hir;
  19 use rustc_hir::def_id::DefId;
  20 use rustc_index::vec::Idx;
  21 use rustc_macros::HashStable;
  22 use rustc_span::symbol::{kw, Symbol};
  23 use rustc_target::abi::VariantIdx;
  24 use rustc_target::spec::abi;
  25 use std::borrow::Cow;
  26 use std::cmp::Ordering;
  27 use std::fmt;
  28 use std::marker::PhantomData;
  29 use std::ops::{ControlFlow, Deref, Range};
  30 use ty::util::IntTypeExt;
  31
  32 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
  33 #[derive(HashStable, TypeFoldable, Lift)]
  34 pub struct TypeAndMut<'tcx> {
  35     pub ty: Ty<'tcx>,
  36     pub mutbl: hir::Mutability,
  37 }
  38
  39 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
  40 #[derive(HashStable)]
  41 /// A "free" region `fr` can be interpreted as "some region
  42 /// at least as big as the scope `fr.scope`".
  43 pub struct FreeRegion {
  44     pub scope: DefId,
  45     pub bound_region: BoundRegionKind,
  46 }
  47
  48 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
  49 #[derive(HashStable)]
  50 pub enum BoundRegionKind {
  51     /// An anonymous region parameter for a given fn (&T)
  52     BrAnon(u32),
  53
  54     /// Named region parameters for functions (a in &'a T)
  55     ///
  56     /// The `DefId` is needed to distinguish free regions in
  57     /// the event of shadowing.
  58     BrNamed(DefId, Symbol),
  59
  60     /// Anonymous region for the implicit env pointer parameter
  61     /// to a closure
  62     BrEnv,
  63 }
  64
  65 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable, Debug, PartialOrd, Ord)]
  66 #[derive(HashStable)]
  67 pub struct BoundRegion {
  68     pub var: BoundVar,
  69     pub kind: BoundRegionKind,
  70 }
  71
  72 impl BoundRegionKind {
  73     pub fn is_named(&self) -> bool {
  74         match *self {
  75             BoundRegionKind::BrNamed(_, name) => name != kw::UnderscoreLifetime,
  76             _ => false,
  77         }
  78     }
  79 }
  80
  81 /// Defines the kinds of types used by the type system.
  82 ///
  83 /// Types written by the user start out as [hir::TyKind](rustc_hir::TyKind) and get
  84 /// converted to this representation using `AstConv::ast_ty_to_ty`.
  85 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable, Debug)]
  86 #[derive(HashStable)]
  87 #[rustc_diagnostic_item = "TyKind"]
  88 pub enum TyKind<'tcx> {
  89     /// The primitive boolean type. Written as `bool`.
  90     Bool,
  91
  92     /// The primitive character type; holds a Unicode scalar value
  93     /// (a non-surrogate code point). Written as `char`.
  94     Char,
  95
  96     /// A primitive signed integer type. For example, `i32`.
  97     Int(ty::IntTy),
  98
  99     /// A primitive unsigned integer type. For example, `u32`.
 100     Uint(ty::UintTy),
 101
 102     /// A primitive floating-point type. For example, `f64`.
 103     Float(ty::FloatTy),
 104
 105     /// Algebraic data types (ADT). For example: structures, enumerations and unions.
 106     ///
 107     /// For example, the type `List<i32>` would be represented using the `AdtDef`
 108     /// for `struct List<T>` and the substs `[i32]`.
 109     ///
 110     /// Note that generic parameters in fields only get lazily substituted
 111     /// by using something like `adt_def.all_fields().map(|field| field.ty(tcx, substs))`.
 112     Adt(&'tcx AdtDef, SubstsRef<'tcx>),
 113
 114     /// An unsized FFI type that is opaque to Rust. Written as `extern type T`.
 115     Foreign(DefId),
 116
 117     /// The pointee of a string slice. Written as `str`.
 118     Str,
 119
 120     /// An array with the given length. Written as `[T; N]`.
 121     Array(Ty<'tcx>, ty::Const<'tcx>),
 122
 123     /// The pointee of an array slice. Written as `[T]`.
 124     Slice(Ty<'tcx>),
 125
 126     /// A raw pointer. Written as `*mut T` or `*const T`
 127     RawPtr(TypeAndMut<'tcx>),
 128
 129     /// A reference; a pointer with an associated lifetime. Written as
 130     /// `&'a mut T` or `&'a T`.
 131     Ref(Region<'tcx>, Ty<'tcx>, hir::Mutability),
 132
 133     /// The anonymous type of a function declaration/definition. Each
 134     /// function has a unique type.
 135     ///
 136     /// For the function `fn foo() -> i32 { 3 }` this type would be
 137     /// shown to the user as `fn() -> i32 {foo}`.
 138     ///
 139     /// For example the type of `bar` here:
 140     /// ```rust
 141     /// fn foo() -> i32 { 1 }
 142     /// let bar = foo; // bar: fn() -> i32 {foo}
 143     /// ```
 144     FnDef(DefId, SubstsRef<'tcx>),
 145
 146     /// A pointer to a function. Written as `fn() -> i32`.
 147     ///
 148     /// Note that both functions and closures start out as either
 149     /// [FnDef] or [Closure] which can be then be coerced to this variant.
 150     ///
 151     /// For example the type of `bar` here:
 152     ///
 153     /// ```rust
 154     /// fn foo() -> i32 { 1 }
 155     /// let bar: fn() -> i32 = foo;
 156     /// ```
 157     FnPtr(PolyFnSig<'tcx>),
 158
 159     /// A trait object. Written as `dyn for<'b> Trait<'b, Assoc = u32> + Send + 'a`.
 160     Dynamic(&'tcx List<Binder<'tcx, ExistentialPredicate<'tcx>>>, ty::Region<'tcx>),
 161
 162     /// The anonymous type of a closure. Used to represent the type of `|a| a`.
 163     ///
 164     /// Closure substs contain both the - potentially substituted - generic parameters
 165     /// of its parent and some synthetic parameters. See the documentation for
 166     /// [ClosureSubsts] for more details.
 167     Closure(DefId, SubstsRef<'tcx>),
 168
 169     /// The anonymous type of a generator. Used to represent the type of
 170     /// `|a| yield a`.
 171     ///
 172     /// For more info about generator substs, visit the documentation for
 173     /// [GeneratorSubsts].
 174     Generator(DefId, SubstsRef<'tcx>, hir::Movability),
 175
 176     /// A type representing the types stored inside a generator.
 177     /// This should only appear as part of the [GeneratorSubsts].
 178     ///
 179     /// Note that the captured variables for generators are stored separately
 180     /// using a tuple in the same way as for closures.
 181     ///
 182     /// Unlike upvars, the witness can reference lifetimes from
 183     /// inside of the generator itself. To deal with them in
 184     /// the type of the generator, we convert them to higher ranked
 185     /// lifetimes bound by the witness itself.
 186     ///
 187     /// Looking at the following example, the witness for this generator
 188     /// may end up as something like `for<'a> [Vec<i32>, &'a Vec<i32>]`:
 189     ///
 190     /// ```rust
 191     /// |a| {
 192     ///     let x = &vec![3];
 193     ///     yield a;
 194     ///     yield x[0];
 195     /// }
 196     /// ```
 197     GeneratorWitness(Binder<'tcx, &'tcx List<Ty<'tcx>>>),
 198
 199     /// The never type `!`.
 200     Never,
 201
 202     /// A tuple type. For example, `(i32, bool)`.
 203     Tuple(&'tcx List<Ty<'tcx>>),
 204
 205     /// The projection of an associated type. For example,
 206     /// `<T as Trait<..>>::N`.
 207     Projection(ProjectionTy<'tcx>),
 208
 209     /// Opaque (`impl Trait`) type found in a return type.
 210     ///
 211     /// The `DefId` comes either from
 212     /// * the `impl Trait` ast::Ty node,
 213     /// * or the `type Foo = impl Trait` declaration
 214     ///
 215     /// For RPIT the substitutions are for the generics of the function,
 216     /// while for TAIT it is used for the generic parameters of the alias.
 217     ///
 218     /// During codegen, `tcx.type_of(def_id)` can be used to get the underlying type.
 219     Opaque(DefId, SubstsRef<'tcx>),
 220
 221     /// A type parameter; for example, `T` in `fn f<T>(x: T) {}`.
 222     Param(ParamTy),
 223
 224     /// Bound type variable, used to represent the `'a` in `for<'a> fn(&'a ())`.
 225     ///
 226     /// For canonical queries, we replace inference variables with bound variables,
 227     /// so e.g. when checking whether `&'_ (): Trait<_>` holds, we canonicalize that to
 228     /// `for<'a, T> &'a (): Trait<T>` and then convert the introduced bound variables
 229     /// back to inference variables in a new inference context when inside of the query.
 230     ///
 231     /// See the `rustc-dev-guide` for more details about
 232     /// [higher-ranked trait bounds][1] and [canonical queries][2].
 233     ///
 234     /// [1]: https://rustc-dev-guide.rust-lang.org/traits/hrtb.html
 235     /// [2]: https://rustc-dev-guide.rust-lang.org/traits/canonical-queries.html
 236     Bound(ty::DebruijnIndex, BoundTy),
 237
 238     /// A placeholder type, used during higher ranked subtyping to instantiate
 239     /// bound variables.
 240     Placeholder(ty::PlaceholderType),
 241
 242     /// A type variable used during type checking.
 243     ///
 244     /// Similar to placeholders, inference variables also live in a universe to
 245     /// correctly deal with higher ranked types. Though unlike placeholders,
 246     /// that universe is stored in the `InferCtxt` instead of directly
 247     /// inside of the type.
 248     Infer(InferTy),
 249
 250     /// A placeholder for a type which could not be computed; this is
 251     /// propagated to avoid useless error messages.
 252     Error(DelaySpanBugEmitted),
 253 }
 254
 255 impl<'tcx> TyKind<'tcx> {
 256     #[inline]
 257     pub fn is_primitive(&self) -> bool {
 258         matches!(self, Bool | Char | Int(_) | Uint(_) | Float(_))
 259     }
 260
 261     /// Get the article ("a" or "an") to use with this type.
 262     pub fn article(&self) -> &'static str {
 263         match self {
 264             Int(_) | Float(_) | Array(_, _) => "an",
 265             Adt(def, _) if def.is_enum() => "an",
 266             // This should never happen, but ICEing and causing the user's code
 267             // to not compile felt too harsh.
 268             Error(_) => "a",
 269             _ => "a",
 270         }
 271     }
 272 }
 273
 274 // `TyKind` is used a lot. Make sure it doesn't unintentionally get bigger.
 275 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
 276 static_assert_size!(TyKind<'_>, 32);
 277
 278 /// A closure can be modeled as a struct that looks like:
 279 ///
 280 ///     struct Closure<'l0...'li, T0...Tj, CK, CS, U>(...U);
 281 ///
 282 /// where:
 283 ///
 284 /// - 'l0...'li and T0...Tj are the generic parameters
 285 ///   in scope on the function that defined the closure,
 286 /// - CK represents the *closure kind* (Fn vs FnMut vs FnOnce). This
 287 ///   is rather hackily encoded via a scalar type. See
 288 ///   `Ty::to_opt_closure_kind` for details.
 289 /// - CS represents the *closure signature*, representing as a `fn()`
 290 ///   type. For example, `fn(u32, u32) -> u32` would mean that the closure
 291 ///   implements `CK<(u32, u32), Output = u32>`, where `CK` is the trait
 292 ///   specified above.
 293 /// - U is a type parameter representing the types of its upvars, tupled up
 294 ///   (borrowed, if appropriate; that is, if a U field represents a by-ref upvar,
 295 ///    and the up-var has the type `Foo`, then that field of U will be `&Foo`).
 296 ///
 297 /// So, for example, given this function:
 298 ///
 299 ///     fn foo<'a, T>(data: &'a mut T) {
 300 ///          do(|| data.count += 1)
 301 ///     }
 302 ///
 303 /// the type of the closure would be something like:
 304 ///
 305 ///     struct Closure<'a, T, U>(...U);
 306 ///
 307 /// Note that the type of the upvar is not specified in the struct.
 308 /// You may wonder how the impl would then be able to use the upvar,
 309 /// if it doesn't know it's type? The answer is that the impl is
 310 /// (conceptually) not fully generic over Closure but rather tied to
 311 /// instances with the expected upvar types:
 312 ///
 313 ///     impl<'b, 'a, T> FnMut() for Closure<'a, T, (&'b mut &'a mut T,)> {
 314 ///         ...
 315 ///     }
 316 ///
 317 /// You can see that the *impl* fully specified the type of the upvar
 318 /// and thus knows full well that `data` has type `&'b mut &'a mut T`.
 319 /// (Here, I am assuming that `data` is mut-borrowed.)
 320 ///
 321 /// Now, the last question you may ask is: Why include the upvar types
 322 /// in an extra type parameter? The reason for this design is that the
 323 /// upvar types can reference lifetimes that are internal to the
 324 /// creating function. In my example above, for example, the lifetime
 325 /// `'b` represents the scope of the closure itself; this is some
 326 /// subset of `foo`, probably just the scope of the call to the to
 327 /// `do()`. If we just had the lifetime/type parameters from the
 328 /// enclosing function, we couldn't name this lifetime `'b`. Note that
 329 /// there can also be lifetimes in the types of the upvars themselves,
 330 /// if one of them happens to be a reference to something that the
 331 /// creating fn owns.
 332 ///
 333 /// OK, you say, so why not create a more minimal set of parameters
 334 /// that just includes the extra lifetime parameters? The answer is
 335 /// primarily that it would be hard --- we don't know at the time when
 336 /// we create the closure type what the full types of the upvars are,
 337 /// nor do we know which are borrowed and which are not. In this
 338 /// design, we can just supply a fresh type parameter and figure that
 339 /// out later.
 340 ///
 341 /// All right, you say, but why include the type parameters from the
 342 /// original function then? The answer is that codegen may need them
 343 /// when monomorphizing, and they may not appear in the upvars. A
 344 /// closure could capture no variables but still make use of some
 345 /// in-scope type parameter with a bound (e.g., if our example above
 346 /// had an extra `U: Default`, and the closure called `U::default()`).
 347 ///
 348 /// There is another reason. This design (implicitly) prohibits
 349 /// closures from capturing themselves (except via a trait
 350 /// object). This simplifies closure inference considerably, since it
 351 /// means that when we infer the kind of a closure or its upvars, we
 352 /// don't have to handle cycles where the decisions we make for
 353 /// closure C wind up influencing the decisions we ought to make for
 354 /// closure C (which would then require fixed point iteration to
 355 /// handle). Plus it fixes an ICE. :P
 356 ///
 357 /// ## Generators
 358 ///
 359 /// Generators are handled similarly in `GeneratorSubsts`.  The set of
 360 /// type parameters is similar, but `CK` and `CS` are replaced by the
 361 /// following type parameters:
 362 ///
 363 /// * `GS`: The generator's "resume type", which is the type of the
 364 ///   argument passed to `resume`, and the type of `yield` expressions
 365 ///   inside the generator.
 366 /// * `GY`: The "yield type", which is the type of values passed to
 367 ///   `yield` inside the generator.
 368 /// * `GR`: The "return type", which is the type of value returned upon
 369 ///   completion of the generator.
 370 /// * `GW`: The "generator witness".
 371 #[derive(Copy, Clone, Debug, TypeFoldable)]
 372 pub struct ClosureSubsts<'tcx> {
 373     /// Lifetime and type parameters from the enclosing function,
 374     /// concatenated with a tuple containing the types of the upvars.
 375     ///
 376     /// These are separated out because codegen wants to pass them around
 377     /// when monomorphizing.
 378     pub substs: SubstsRef<'tcx>,
 379 }
 380
 381 /// Struct returned by `split()`.
 382 pub struct ClosureSubstsParts<'tcx, T> {
 383     pub parent_substs: &'tcx [GenericArg<'tcx>],
 384     pub closure_kind_ty: T,
 385     pub closure_sig_as_fn_ptr_ty: T,
 386     pub tupled_upvars_ty: T,
 387 }
 388
 389 impl<'tcx> ClosureSubsts<'tcx> {
 390     /// Construct `ClosureSubsts` from `ClosureSubstsParts`, containing `Substs`
 391     /// for the closure parent, alongside additional closure-specific components.
 392     pub fn new(
 393         tcx: TyCtxt<'tcx>,
 394         parts: ClosureSubstsParts<'tcx, Ty<'tcx>>,
 395     ) -> ClosureSubsts<'tcx> {
 396         ClosureSubsts {
 397             substs: tcx.mk_substs(
 398                 parts.parent_substs.iter().copied().chain(
 399                     [parts.closure_kind_ty, parts.closure_sig_as_fn_ptr_ty, parts.tupled_upvars_ty]
 400                         .iter()
 401                         .map(|&ty| ty.into()),
 402                 ),
 403             ),
 404         }
 405     }
 406
 407     /// Divides the closure substs into their respective components.
 408     /// The ordering assumed here must match that used by `ClosureSubsts::new` above.
 409     fn split(self) -> ClosureSubstsParts<'tcx, GenericArg<'tcx>> {
 410         match self.substs[..] {
 411             [
 412                 ref parent_substs @ ..,
 413                 closure_kind_ty,
 414                 closure_sig_as_fn_ptr_ty,
 415                 tupled_upvars_ty,
 416             ] => ClosureSubstsParts {
 417                 parent_substs,
 418                 closure_kind_ty,
 419                 closure_sig_as_fn_ptr_ty,
 420                 tupled_upvars_ty,
 421             },
 422             _ => bug!("closure substs missing synthetics"),
 423         }
 424     }
 425
 426     /// Returns `true` only if enough of the synthetic types are known to
 427     /// allow using all of the methods on `ClosureSubsts` without panicking.
 428     ///
 429     /// Used primarily by `ty::print::pretty` to be able to handle closure
 430     /// types that haven't had their synthetic types substituted in.
 431     pub fn is_valid(self) -> bool {
 432         self.substs.len() >= 3
 433             && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
 434     }
 435
 436     /// Returns the substitutions of the closure's parent.
 437     pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
 438         self.split().parent_substs
 439     }
 440
 441     /// Returns an iterator over the list of types of captured paths by the closure.
 442     /// In case there was a type error in figuring out the types of the captured path, an
 443     /// empty iterator is returned.
 444     #[inline]
 445     pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
 446         match self.tupled_upvars_ty().kind() {
 447             TyKind::Error(_) => None,
 448             TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
 449             TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
 450             ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
 451         }
 452         .into_iter()
 453         .flatten()
 454     }
 455
 456     /// Returns the tuple type representing the upvars for this closure.
 457     #[inline]
 458     pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
 459         self.split().tupled_upvars_ty.expect_ty()
 460     }
 461
 462     /// Returns the closure kind for this closure; may return a type
 463     /// variable during inference. To get the closure kind during
 464     /// inference, use `infcx.closure_kind(substs)`.
 465     pub fn kind_ty(self) -> Ty<'tcx> {
 466         self.split().closure_kind_ty.expect_ty()
 467     }
 468
 469     /// Returns the `fn` pointer type representing the closure signature for this
 470     /// closure.
 471     // FIXME(eddyb) this should be unnecessary, as the shallowly resolved
 472     // type is known at the time of the creation of `ClosureSubsts`,
 473     // see `rustc_typeck::check::closure`.
 474     pub fn sig_as_fn_ptr_ty(self) -> Ty<'tcx> {
 475         self.split().closure_sig_as_fn_ptr_ty.expect_ty()
 476     }
 477
 478     /// Returns the closure kind for this closure; only usable outside
 479     /// of an inference context, because in that context we know that
 480     /// there are no type variables.
 481     ///
 482     /// If you have an inference context, use `infcx.closure_kind()`.
 483     pub fn kind(self) -> ty::ClosureKind {
 484         self.kind_ty().to_opt_closure_kind().unwrap()
 485     }
 486
 487     /// Extracts the signature from the closure.
 488     pub fn sig(self) -> ty::PolyFnSig<'tcx> {
 489         let ty = self.sig_as_fn_ptr_ty();
 490         match ty.kind() {
 491             ty::FnPtr(sig) => *sig,
 492             _ => bug!("closure_sig_as_fn_ptr_ty is not a fn-ptr: {:?}", ty.kind()),
 493         }
 494     }
 495 }
 496
 497 /// Similar to `ClosureSubsts`; see the above documentation for more.
 498 #[derive(Copy, Clone, Debug, TypeFoldable)]
 499 pub struct GeneratorSubsts<'tcx> {
 500     pub substs: SubstsRef<'tcx>,
 501 }
 502
 503 pub struct GeneratorSubstsParts<'tcx, T> {
 504     pub parent_substs: &'tcx [GenericArg<'tcx>],
 505     pub resume_ty: T,
 506     pub yield_ty: T,
 507     pub return_ty: T,
 508     pub witness: T,
 509     pub tupled_upvars_ty: T,
 510 }
 511
 512 impl<'tcx> GeneratorSubsts<'tcx> {
 513     /// Construct `GeneratorSubsts` from `GeneratorSubstsParts`, containing `Substs`
 514     /// for the generator parent, alongside additional generator-specific components.
 515     pub fn new(
 516         tcx: TyCtxt<'tcx>,
 517         parts: GeneratorSubstsParts<'tcx, Ty<'tcx>>,
 518     ) -> GeneratorSubsts<'tcx> {
 519         GeneratorSubsts {
 520             substs: tcx.mk_substs(
 521                 parts.parent_substs.iter().copied().chain(
 522                     [
 523                         parts.resume_ty,
 524                         parts.yield_ty,
 525                         parts.return_ty,
 526                         parts.witness,
 527                         parts.tupled_upvars_ty,
 528                     ]
 529                     .iter()
 530                     .map(|&ty| ty.into()),
 531                 ),
 532             ),
 533         }
 534     }
 535
 536     /// Divides the generator substs into their respective components.
 537     /// The ordering assumed here must match that used by `GeneratorSubsts::new` above.
 538     fn split(self) -> GeneratorSubstsParts<'tcx, GenericArg<'tcx>> {
 539         match self.substs[..] {
 540             [ref parent_substs @ .., resume_ty, yield_ty, return_ty, witness, tupled_upvars_ty] => {
 541                 GeneratorSubstsParts {
 542                     parent_substs,
 543                     resume_ty,
 544                     yield_ty,
 545                     return_ty,
 546                     witness,
 547                     tupled_upvars_ty,
 548                 }
 549             }
 550             _ => bug!("generator substs missing synthetics"),
 551         }
 552     }
 553
 554     /// Returns `true` only if enough of the synthetic types are known to
 555     /// allow using all of the methods on `GeneratorSubsts` without panicking.
 556     ///
 557     /// Used primarily by `ty::print::pretty` to be able to handle generator
 558     /// types that haven't had their synthetic types substituted in.
 559     pub fn is_valid(self) -> bool {
 560         self.substs.len() >= 5
 561             && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
 562     }
 563
 564     /// Returns the substitutions of the generator's parent.
 565     pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
 566         self.split().parent_substs
 567     }
 568
 569     /// This describes the types that can be contained in a generator.
 570     /// It will be a type variable initially and unified in the last stages of typeck of a body.
 571     /// It contains a tuple of all the types that could end up on a generator frame.
 572     /// The state transformation MIR pass may only produce layouts which mention types
 573     /// in this tuple. Upvars are not counted here.
 574     pub fn witness(self) -> Ty<'tcx> {
 575         self.split().witness.expect_ty()
 576     }
 577
 578     /// Returns an iterator over the list of types of captured paths by the generator.
 579     /// In case there was a type error in figuring out the types of the captured path, an
 580     /// empty iterator is returned.
 581     #[inline]
 582     pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
 583         match self.tupled_upvars_ty().kind() {
 584             TyKind::Error(_) => None,
 585             TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
 586             TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
 587             ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
 588         }
 589         .into_iter()
 590         .flatten()
 591     }
 592
 593     /// Returns the tuple type representing the upvars for this generator.
 594     #[inline]
 595     pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
 596         self.split().tupled_upvars_ty.expect_ty()
 597     }
 598
 599     /// Returns the type representing the resume type of the generator.
 600     pub fn resume_ty(self) -> Ty<'tcx> {
 601         self.split().resume_ty.expect_ty()
 602     }
 603
 604     /// Returns the type representing the yield type of the generator.
 605     pub fn yield_ty(self) -> Ty<'tcx> {
 606         self.split().yield_ty.expect_ty()
 607     }
 608
 609     /// Returns the type representing the return type of the generator.
 610     pub fn return_ty(self) -> Ty<'tcx> {
 611         self.split().return_ty.expect_ty()
 612     }
 613
 614     /// Returns the "generator signature", which consists of its yield
 615     /// and return types.
 616     ///
 617     /// N.B., some bits of the code prefers to see this wrapped in a
 618     /// binder, but it never contains bound regions. Probably this
 619     /// function should be removed.
 620     pub fn poly_sig(self) -> PolyGenSig<'tcx> {
 621         ty::Binder::dummy(self.sig())
 622     }
 623
 624     /// Returns the "generator signature", which consists of its resume, yield
 625     /// and return types.
 626     pub fn sig(self) -> GenSig<'tcx> {
 627         ty::GenSig {
 628             resume_ty: self.resume_ty(),
 629             yield_ty: self.yield_ty(),
 630             return_ty: self.return_ty(),
 631         }
 632     }
 633 }
 634
 635 impl<'tcx> GeneratorSubsts<'tcx> {
 636     /// Generator has not been resumed yet.
 637     pub const UNRESUMED: usize = 0;
 638     /// Generator has returned or is completed.
 639     pub const RETURNED: usize = 1;
 640     /// Generator has been poisoned.
 641     pub const POISONED: usize = 2;
 642
 643     const UNRESUMED_NAME: &'static str = "Unresumed";
 644     const RETURNED_NAME: &'static str = "Returned";
 645     const POISONED_NAME: &'static str = "Panicked";
 646
 647     /// The valid variant indices of this generator.
 648     #[inline]
 649     pub fn variant_range(&self, def_id: DefId, tcx: TyCtxt<'tcx>) -> Range<VariantIdx> {
 650         // FIXME requires optimized MIR
 651         let num_variants = tcx.generator_layout(def_id).unwrap().variant_fields.len();
 652         VariantIdx::new(0)..VariantIdx::new(num_variants)
 653     }
 654
 655     /// The discriminant for the given variant. Panics if the `variant_index` is
 656     /// out of range.
 657     #[inline]
 658     pub fn discriminant_for_variant(
 659         &self,
 660         def_id: DefId,
 661         tcx: TyCtxt<'tcx>,
 662         variant_index: VariantIdx,
 663     ) -> Discr<'tcx> {
 664         // Generators don't support explicit discriminant values, so they are
 665         // the same as the variant index.
 666         assert!(self.variant_range(def_id, tcx).contains(&variant_index));
 667         Discr { val: variant_index.as_usize() as u128, ty: self.discr_ty(tcx) }
 668     }
 669
 670     /// The set of all discriminants for the generator, enumerated with their
 671     /// variant indices.
 672     #[inline]
 673     pub fn discriminants(
 674         self,
 675         def_id: DefId,
 676         tcx: TyCtxt<'tcx>,
 677     ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx> {
 678         self.variant_range(def_id, tcx).map(move |index| {
 679             (index, Discr { val: index.as_usize() as u128, ty: self.discr_ty(tcx) })
 680         })
 681     }
 682
 683     /// Calls `f` with a reference to the name of the enumerator for the given
 684     /// variant `v`.
 685     pub fn variant_name(v: VariantIdx) -> Cow<'static, str> {
 686         match v.as_usize() {
 687             Self::UNRESUMED => Cow::from(Self::UNRESUMED_NAME),
 688             Self::RETURNED => Cow::from(Self::RETURNED_NAME),
 689             Self::POISONED => Cow::from(Self::POISONED_NAME),
 690             _ => Cow::from(format!("Suspend{}", v.as_usize() - 3)),
 691         }
 692     }
 693
 694     /// The type of the state discriminant used in the generator type.
 695     #[inline]
 696     pub fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
 697         tcx.types.u32
 698     }
 699
 700     /// This returns the types of the MIR locals which had to be stored across suspension points.
 701     /// It is calculated in rustc_const_eval::transform::generator::StateTransform.
 702     /// All the types here must be in the tuple in GeneratorInterior.
 703     ///
 704     /// The locals are grouped by their variant number. Note that some locals may
 705     /// be repeated in multiple variants.
 706     #[inline]
 707     pub fn state_tys(
 708         self,
 709         def_id: DefId,
 710         tcx: TyCtxt<'tcx>,
 711     ) -> impl Iterator<Item = impl Iterator<Item = Ty<'tcx>> + Captures<'tcx>> {
 712         let layout = tcx.generator_layout(def_id).unwrap();
 713         layout.variant_fields.iter().map(move |variant| {
 714             variant.iter().map(move |field| layout.field_tys[*field].subst(tcx, self.substs))
 715         })
 716     }
 717
 718     /// This is the types of the fields of a generator which are not stored in a
 719     /// variant.
 720     #[inline]
 721     pub fn prefix_tys(self) -> impl Iterator<Item = Ty<'tcx>> {
 722         self.upvar_tys()
 723     }
 724 }
 725
 726 #[derive(Debug, Copy, Clone, HashStable)]
 727 pub enum UpvarSubsts<'tcx> {
 728     Closure(SubstsRef<'tcx>),
 729     Generator(SubstsRef<'tcx>),
 730 }
 731
 732 impl<'tcx> UpvarSubsts<'tcx> {
 733     /// Returns an iterator over the list of types of captured paths by the closure/generator.
 734     /// In case there was a type error in figuring out the types of the captured path, an
 735     /// empty iterator is returned.
 736     #[inline]
 737     pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
 738         let tupled_tys = match self {
 739             UpvarSubsts::Closure(substs) => substs.as_closure().tupled_upvars_ty(),
 740             UpvarSubsts::Generator(substs) => substs.as_generator().tupled_upvars_ty(),
 741         };
 742
 743         match tupled_tys.kind() {
 744             TyKind::Error(_) => None,
 745             TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
 746             TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
 747             ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
 748         }
 749         .into_iter()
 750         .flatten()
 751     }
 752
 753     #[inline]
 754     pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
 755         match self {
 756             UpvarSubsts::Closure(substs) => substs.as_closure().tupled_upvars_ty(),
 757             UpvarSubsts::Generator(substs) => substs.as_generator().tupled_upvars_ty(),
 758         }
 759     }
 760 }
 761
 762 /// An inline const is modeled like
 763 ///
 764 ///     const InlineConst<'l0...'li, T0...Tj, R>: R;
 765 ///
 766 /// where:
 767 ///
 768 /// - 'l0...'li and T0...Tj are the generic parameters
 769 ///   inherited from the item that defined the inline const,
 770 /// - R represents the type of the constant.
 771 ///
 772 /// When the inline const is instantiated, `R` is substituted as the actual inferred
 773 /// type of the constant. The reason that `R` is represented as an extra type parameter
 774 /// is the same reason that [`ClosureSubsts`] have `CS` and `U` as type parameters:
 775 /// inline const can reference lifetimes that are internal to the creating function.
 776 #[derive(Copy, Clone, Debug, TypeFoldable)]
 777 pub struct InlineConstSubsts<'tcx> {
 778     /// Generic parameters from the enclosing item,
 779     /// concatenated with the inferred type of the constant.
 780     pub substs: SubstsRef<'tcx>,
 781 }
 782
 783 /// Struct returned by `split()`.
 784 pub struct InlineConstSubstsParts<'tcx, T> {
 785     pub parent_substs: &'tcx [GenericArg<'tcx>],
 786     pub ty: T,
 787 }
 788
 789 impl<'tcx> InlineConstSubsts<'tcx> {
 790     /// Construct `InlineConstSubsts` from `InlineConstSubstsParts`.
 791     pub fn new(
 792         tcx: TyCtxt<'tcx>,
 793         parts: InlineConstSubstsParts<'tcx, Ty<'tcx>>,
 794     ) -> InlineConstSubsts<'tcx> {
 795         InlineConstSubsts {
 796             substs: tcx.mk_substs(
 797                 parts.parent_substs.iter().copied().chain(std::iter::once(parts.ty.into())),
 798             ),
 799         }
 800     }
 801
 802     /// Divides the inline const substs into their respective components.
 803     /// The ordering assumed here must match that used by `InlineConstSubsts::new` above.
 804     fn split(self) -> InlineConstSubstsParts<'tcx, GenericArg<'tcx>> {
 805         match self.substs[..] {
 806             [ref parent_substs @ .., ty] => InlineConstSubstsParts { parent_substs, ty },
 807             _ => bug!("inline const substs missing synthetics"),
 808         }
 809     }
 810
 811     /// Returns the substitutions of the inline const's parent.
 812     pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
 813         self.split().parent_substs
 814     }
 815
 816     /// Returns the type of this inline const.
 817     pub fn ty(self) -> Ty<'tcx> {
 818         self.split().ty.expect_ty()
 819     }
 820 }
 821
 822 #[derive(Debug, Copy, Clone, PartialEq, PartialOrd, Ord, Eq, Hash, TyEncodable, TyDecodable)]
 823 #[derive(HashStable, TypeFoldable)]
 824 pub enum ExistentialPredicate<'tcx> {
 825     /// E.g., `Iterator`.
 826     Trait(ExistentialTraitRef<'tcx>),
 827     /// E.g., `Iterator::Item = T`.
 828     Projection(ExistentialProjection<'tcx>),
 829     /// E.g., `Send`.
 830     AutoTrait(DefId),
 831 }
 832
 833 impl<'tcx> ExistentialPredicate<'tcx> {
 834     /// Compares via an ordering that will not change if modules are reordered or other changes are
 835     /// made to the tree. In particular, this ordering is preserved across incremental compilations.
 836     pub fn stable_cmp(&self, tcx: TyCtxt<'tcx>, other: &Self) -> Ordering {
 837         use self::ExistentialPredicate::*;
 838         match (*self, *other) {
 839             (Trait(_), Trait(_)) => Ordering::Equal,
 840             (Projection(ref a), Projection(ref b)) => {
 841                 tcx.def_path_hash(a.item_def_id).cmp(&tcx.def_path_hash(b.item_def_id))
 842             }
 843             (AutoTrait(ref a), AutoTrait(ref b)) => {
 844                 tcx.def_path_hash(*a).cmp(&tcx.def_path_hash(*b))
 845             }
 846             (Trait(_), _) => Ordering::Less,
 847             (Projection(_), Trait(_)) => Ordering::Greater,
 848             (Projection(_), _) => Ordering::Less,
 849             (AutoTrait(_), _) => Ordering::Greater,
 850         }
 851     }
 852 }
 853
 854 impl<'tcx> Binder<'tcx, ExistentialPredicate<'tcx>> {
 855     pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::Predicate<'tcx> {
 856         use crate::ty::ToPredicate;
 857         match self.skip_binder() {
 858             ExistentialPredicate::Trait(tr) => {
 859                 self.rebind(tr).with_self_ty(tcx, self_ty).without_const().to_predicate(tcx)
 860             }
 861             ExistentialPredicate::Projection(p) => {
 862                 self.rebind(p.with_self_ty(tcx, self_ty)).to_predicate(tcx)
 863             }
 864             ExistentialPredicate::AutoTrait(did) => {
 865                 let trait_ref = self.rebind(ty::TraitRef {
 866                     def_id: did,
 867                     substs: tcx.mk_substs_trait(self_ty, &[]),
 868                 });
 869                 trait_ref.without_const().to_predicate(tcx)
 870             }
 871         }
 872     }
 873 }
 874
 875 impl<'tcx> List<ty::Binder<'tcx, ExistentialPredicate<'tcx>>> {
 876     /// Returns the "principal `DefId`" of this set of existential predicates.
 877     ///
 878     /// A Rust trait object type consists (in addition to a lifetime bound)
 879     /// of a set of trait bounds, which are separated into any number
 880     /// of auto-trait bounds, and at most one non-auto-trait bound. The
 881     /// non-auto-trait bound is called the "principal" of the trait
 882     /// object.
 883     ///
 884     /// Only the principal can have methods or type parameters (because
 885     /// auto traits can have neither of them). This is important, because
 886     /// it means the auto traits can be treated as an unordered set (methods
 887     /// would force an order for the vtable, while relating traits with
 888     /// type parameters without knowing the order to relate them in is
 889     /// a rather non-trivial task).
 890     ///
 891     /// For example, in the trait object `dyn fmt::Debug + Sync`, the
 892     /// principal bound is `Some(fmt::Debug)`, while the auto-trait bounds
 893     /// are the set `{Sync}`.
 894     ///
 895     /// It is also possible to have a "trivial" trait object that
 896     /// consists only of auto traits, with no principal - for example,
 897     /// `dyn Send + Sync`. In that case, the set of auto-trait bounds
 898     /// is `{Send, Sync}`, while there is no principal. These trait objects
 899     /// have a "trivial" vtable consisting of just the size, alignment,
 900     /// and destructor.
 901     pub fn principal(&self) -> Option<ty::Binder<'tcx, ExistentialTraitRef<'tcx>>> {
 902         self[0]
 903             .map_bound(|this| match this {
 904                 ExistentialPredicate::Trait(tr) => Some(tr),
 905                 _ => None,
 906             })
 907             .transpose()
 908     }
 909
 910     pub fn principal_def_id(&self) -> Option<DefId> {
 911         self.principal().map(|trait_ref| trait_ref.skip_binder().def_id)
 912     }
 913
 914     #[inline]
 915     pub fn projection_bounds<'a>(
 916         &'a self,
 917     ) -> impl Iterator<Item = ty::Binder<'tcx, ExistentialProjection<'tcx>>> + 'a {
 918         self.iter().filter_map(|predicate| {
 919             predicate
 920                 .map_bound(|pred| match pred {
 921                     ExistentialPredicate::Projection(projection) => Some(projection),
 922                     _ => None,
 923                 })
 924                 .transpose()
 925         })
 926     }
 927
 928     #[inline]
 929     pub fn auto_traits<'a>(&'a self) -> impl Iterator<Item = DefId> + 'a {
 930         self.iter().filter_map(|predicate| match predicate.skip_binder() {
 931             ExistentialPredicate::AutoTrait(did) => Some(did),
 932             _ => None,
 933         })
 934     }
 935 }
 936
 937 /// A complete reference to a trait. These take numerous guises in syntax,
 938 /// but perhaps the most recognizable form is in a where-clause:
 939 ///
 940 ///     T: Foo<U>
 941 ///
 942 /// This would be represented by a trait-reference where the `DefId` is the
 943 /// `DefId` for the trait `Foo` and the substs define `T` as parameter 0,
 944 /// and `U` as parameter 1.
 945 ///
 946 /// Trait references also appear in object types like `Foo<U>`, but in
 947 /// that case the `Self` parameter is absent from the substitutions.
 948 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
 949 #[derive(HashStable, TypeFoldable)]
 950 pub struct TraitRef<'tcx> {
 951     pub def_id: DefId,
 952     pub substs: SubstsRef<'tcx>,
 953 }
 954
 955 impl<'tcx> TraitRef<'tcx> {
 956     pub fn new(def_id: DefId, substs: SubstsRef<'tcx>) -> TraitRef<'tcx> {
 957         TraitRef { def_id, substs }
 958     }
 959
 960     /// Returns a `TraitRef` of the form `P0: Foo<P1..Pn>` where `Pi`
 961     /// are the parameters defined on trait.
 962     pub fn identity(tcx: TyCtxt<'tcx>, def_id: DefId) -> Binder<'tcx, TraitRef<'tcx>> {
 963         ty::Binder::dummy(TraitRef {
 964             def_id,
 965             substs: InternalSubsts::identity_for_item(tcx, def_id),
 966         })
 967     }
 968
 969     #[inline]
 970     pub fn self_ty(&self) -> Ty<'tcx> {
 971         self.substs.type_at(0)
 972     }
 973
 974     pub fn from_method(
 975         tcx: TyCtxt<'tcx>,
 976         trait_id: DefId,
 977         substs: SubstsRef<'tcx>,
 978     ) -> ty::TraitRef<'tcx> {
 979         let defs = tcx.generics_of(trait_id);
 980
 981         ty::TraitRef { def_id: trait_id, substs: tcx.intern_substs(&substs[..defs.params.len()]) }
 982     }
 983 }
 984
 985 pub type PolyTraitRef<'tcx> = Binder<'tcx, TraitRef<'tcx>>;
 986
 987 impl<'tcx> PolyTraitRef<'tcx> {
 988     pub fn self_ty(&self) -> Binder<'tcx, Ty<'tcx>> {
 989         self.map_bound_ref(|tr| tr.self_ty())
 990     }
 991
 992     pub fn def_id(&self) -> DefId {
 993         self.skip_binder().def_id
 994     }
 995
 996     pub fn to_poly_trait_predicate(&self) -> ty::PolyTraitPredicate<'tcx> {
 997         self.map_bound(|trait_ref| ty::TraitPredicate {
 998             trait_ref,
 999             constness: ty::BoundConstness::NotConst,
1000             polarity: ty::ImplPolarity::Positive,
1001         })
1002     }
1003 }
1004
1005 /// An existential reference to a trait, where `Self` is erased.
1006 /// For example, the trait object `Trait<'a, 'b, X, Y>` is:
1007 ///
1008 ///     exists T. T: Trait<'a, 'b, X, Y>
1009 ///
1010 /// The substitutions don't include the erased `Self`, only trait
1011 /// type and lifetime parameters (`[X, Y]` and `['a, 'b]` above).
1012 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1013 #[derive(HashStable, TypeFoldable)]
1014 pub struct ExistentialTraitRef<'tcx> {
1015     pub def_id: DefId,
1016     pub substs: SubstsRef<'tcx>,
1017 }
1018
1019 impl<'tcx> ExistentialTraitRef<'tcx> {
1020     pub fn erase_self_ty(
1021         tcx: TyCtxt<'tcx>,
1022         trait_ref: ty::TraitRef<'tcx>,
1023     ) -> ty::ExistentialTraitRef<'tcx> {
1024         // Assert there is a Self.
1025         trait_ref.substs.type_at(0);
1026
1027         ty::ExistentialTraitRef {
1028             def_id: trait_ref.def_id,
1029             substs: tcx.intern_substs(&trait_ref.substs[1..]),
1030         }
1031     }
1032
1033     /// Object types don't have a self type specified. Therefore, when
1034     /// we convert the principal trait-ref into a normal trait-ref,
1035     /// you must give *some* self type. A common choice is `mk_err()`
1036     /// or some placeholder type.
1037     pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::TraitRef<'tcx> {
1038         // otherwise the escaping vars would be captured by the binder
1039         // debug_assert!(!self_ty.has_escaping_bound_vars());
1040
1041         ty::TraitRef { def_id: self.def_id, substs: tcx.mk_substs_trait(self_ty, self.substs) }
1042     }
1043 }
1044
1045 pub type PolyExistentialTraitRef<'tcx> = Binder<'tcx, ExistentialTraitRef<'tcx>>;
1046
1047 impl<'tcx> PolyExistentialTraitRef<'tcx> {
1048     pub fn def_id(&self) -> DefId {
1049         self.skip_binder().def_id
1050     }
1051
1052     /// Object types don't have a self type specified. Therefore, when
1053     /// we convert the principal trait-ref into a normal trait-ref,
1054     /// you must give *some* self type. A common choice is `mk_err()`
1055     /// or some placeholder type.
1056     pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::PolyTraitRef<'tcx> {
1057         self.map_bound(|trait_ref| trait_ref.with_self_ty(tcx, self_ty))
1058     }
1059 }
1060
1061 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1062 #[derive(HashStable)]
1063 pub enum BoundVariableKind {
1064     Ty(BoundTyKind),
1065     Region(BoundRegionKind),
1066     Const,
1067 }
1068
1069 /// Binder is a binder for higher-ranked lifetimes or types. It is part of the
1070 /// compiler's representation for things like `for<'a> Fn(&'a isize)`
1071 /// (which would be represented by the type `PolyTraitRef ==
1072 /// Binder<'tcx, TraitRef>`). Note that when we instantiate,
1073 /// erase, or otherwise "discharge" these bound vars, we change the
1074 /// type from `Binder<'tcx, T>` to just `T` (see
1075 /// e.g., `liberate_late_bound_regions`).
1076 ///
1077 /// `Decodable` and `Encodable` are implemented for `Binder<T>` using the `impl_binder_encode_decode!` macro.
1078 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
1079 pub struct Binder<'tcx, T>(T, &'tcx List<BoundVariableKind>);
1080
1081 impl<'tcx, T> Binder<'tcx, T>
1082 where
1083     T: TypeFoldable<'tcx>,
1084 {
1085     /// Wraps `value` in a binder, asserting that `value` does not
1086     /// contain any bound vars that would be bound by the
1087     /// binder. This is commonly used to 'inject' a value T into a
1088     /// different binding level.
1089     pub fn dummy(value: T) -> Binder<'tcx, T> {
1090         assert!(!value.has_escaping_bound_vars());
1091         Binder(value, ty::List::empty())
1092     }
1093
1094     pub fn bind_with_vars(value: T, vars: &'tcx List<BoundVariableKind>) -> Binder<'tcx, T> {
1095         if cfg!(debug_assertions) {
1096             let mut validator = ValidateBoundVars::new(vars);
1097             value.visit_with(&mut validator);
1098         }
1099         Binder(value, vars)
1100     }
1101 }
1102
1103 impl<'tcx, T> Binder<'tcx, T> {
1104     /// Skips the binder and returns the "bound" value. This is a
1105     /// risky thing to do because it's easy to get confused about
1106     /// De Bruijn indices and the like. It is usually better to
1107     /// discharge the binder using `no_bound_vars` or
1108     /// `replace_late_bound_regions` or something like
1109     /// that. `skip_binder` is only valid when you are either
1110     /// extracting data that has nothing to do with bound vars, you
1111     /// are doing some sort of test that does not involve bound
1112     /// regions, or you are being very careful about your depth
1113     /// accounting.
1114     ///
1115     /// Some examples where `skip_binder` is reasonable:
1116     ///
1117     /// - extracting the `DefId` from a PolyTraitRef;
1118     /// - comparing the self type of a PolyTraitRef to see if it is equal to
1119     ///   a type parameter `X`, since the type `X` does not reference any regions
1120     pub fn skip_binder(self) -> T {
1121         self.0
1122     }
1123
1124     pub fn bound_vars(&self) -> &'tcx List<BoundVariableKind> {
1125         self.1
1126     }
1127
1128     pub fn as_ref(&self) -> Binder<'tcx, &T> {
1129         Binder(&self.0, self.1)
1130     }
1131
1132     pub fn map_bound_ref_unchecked<F, U>(&self, f: F) -> Binder<'tcx, U>
1133     where
1134         F: FnOnce(&T) -> U,
1135     {
1136         let value = f(&self.0);
1137         Binder(value, self.1)
1138     }
1139
1140     pub fn map_bound_ref<F, U: TypeFoldable<'tcx>>(&self, f: F) -> Binder<'tcx, U>
1141     where
1142         F: FnOnce(&T) -> U,
1143     {
1144         self.as_ref().map_bound(f)
1145     }
1146
1147     pub fn map_bound<F, U: TypeFoldable<'tcx>>(self, f: F) -> Binder<'tcx, U>
1148     where
1149         F: FnOnce(T) -> U,
1150     {
1151         let value = f(self.0);
1152         if cfg!(debug_assertions) {
1153             let mut validator = ValidateBoundVars::new(self.1);
1154             value.visit_with(&mut validator);
1155         }
1156         Binder(value, self.1)
1157     }
1158
1159     pub fn try_map_bound<F, U: TypeFoldable<'tcx>, E>(self, f: F) -> Result<Binder<'tcx, U>, E>
1160     where
1161         F: FnOnce(T) -> Result<U, E>,
1162     {
1163         let value = f(self.0)?;
1164         if cfg!(debug_assertions) {
1165             let mut validator = ValidateBoundVars::new(self.1);
1166             value.visit_with(&mut validator);
1167         }
1168         Ok(Binder(value, self.1))
1169     }
1170
1171     /// Wraps a `value` in a binder, using the same bound variables as the
1172     /// current `Binder`. This should not be used if the new value *changes*
1173     /// the bound variables. Note: the (old or new) value itself does not
1174     /// necessarily need to *name* all the bound variables.
1175     ///
1176     /// This currently doesn't do anything different than `bind`, because we
1177     /// don't actually track bound vars. However, semantically, it is different
1178     /// because bound vars aren't allowed to change here, whereas they are
1179     /// in `bind`. This may be (debug) asserted in the future.
1180     pub fn rebind<U>(&self, value: U) -> Binder<'tcx, U>
1181     where
1182         U: TypeFoldable<'tcx>,
1183     {
1184         if cfg!(debug_assertions) {
1185             let mut validator = ValidateBoundVars::new(self.bound_vars());
1186             value.visit_with(&mut validator);
1187         }
1188         Binder(value, self.1)
1189     }
1190
1191     /// Unwraps and returns the value within, but only if it contains
1192     /// no bound vars at all. (In other words, if this binder --
1193     /// and indeed any enclosing binder -- doesn't bind anything at
1194     /// all.) Otherwise, returns `None`.
1195     ///
1196     /// (One could imagine having a method that just unwraps a single
1197     /// binder, but permits late-bound vars bound by enclosing
1198     /// binders, but that would require adjusting the debruijn
1199     /// indices, and given the shallow binding structure we often use,
1200     /// would not be that useful.)
1201     pub fn no_bound_vars(self) -> Option<T>
1202     where
1203         T: TypeFoldable<'tcx>,
1204     {
1205         if self.0.has_escaping_bound_vars() { None } else { Some(self.skip_binder()) }
1206     }
1207
1208     /// Splits the contents into two things that share the same binder
1209     /// level as the original, returning two distinct binders.
1210     ///
1211     /// `f` should consider bound regions at depth 1 to be free, and
1212     /// anything it produces with bound regions at depth 1 will be
1213     /// bound in the resulting return values.
1214     pub fn split<U, V, F>(self, f: F) -> (Binder<'tcx, U>, Binder<'tcx, V>)
1215     where
1216         F: FnOnce(T) -> (U, V),
1217     {
1218         let (u, v) = f(self.0);
1219         (Binder(u, self.1), Binder(v, self.1))
1220     }
1221 }
1222
1223 impl<'tcx, T> Binder<'tcx, Option<T>> {
1224     pub fn transpose(self) -> Option<Binder<'tcx, T>> {
1225         let bound_vars = self.1;
1226         self.0.map(|v| Binder(v, bound_vars))
1227     }
1228 }
1229
1230 /// Represents the projection of an associated type. In explicit UFCS
1231 /// form this would be written `<T as Trait<..>>::N`.
1232 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1233 #[derive(HashStable, TypeFoldable)]
1234 pub struct ProjectionTy<'tcx> {
1235     /// The parameters of the associated item.
1236     pub substs: SubstsRef<'tcx>,
1237
1238     /// The `DefId` of the `TraitItem` for the associated type `N`.
1239     ///
1240     /// Note that this is not the `DefId` of the `TraitRef` containing this
1241     /// associated type, which is in `tcx.associated_item(item_def_id).container`.
1242     pub item_def_id: DefId,
1243 }
1244
1245 impl<'tcx> ProjectionTy<'tcx> {
1246     pub fn trait_def_id(&self, tcx: TyCtxt<'tcx>) -> DefId {
1247         tcx.associated_item(self.item_def_id).container.id()
1248     }
1249
1250     /// Extracts the underlying trait reference and own substs from this projection.
1251     /// For example, if this is a projection of `<T as StreamingIterator>::Item<'a>`,
1252     /// then this function would return a `T: Iterator` trait reference and `['a]` as the own substs
1253     pub fn trait_ref_and_own_substs(
1254         &self,
1255         tcx: TyCtxt<'tcx>,
1256     ) -> (ty::TraitRef<'tcx>, &'tcx [ty::GenericArg<'tcx>]) {
1257         let def_id = tcx.associated_item(self.item_def_id).container.id();
1258         let trait_generics = tcx.generics_of(def_id);
1259         (
1260             ty::TraitRef { def_id, substs: self.substs.truncate_to(tcx, trait_generics) },
1261             &self.substs[trait_generics.count()..],
1262         )
1263     }
1264
1265     /// Extracts the underlying trait reference from this projection.
1266     /// For example, if this is a projection of `<T as Iterator>::Item`,
1267     /// then this function would return a `T: Iterator` trait reference.
1268     ///
1269     /// WARNING: This will drop the substs for generic associated types
1270     /// consider calling [Self::trait_ref_and_own_substs] to get those
1271     /// as well.
1272     pub fn trait_ref(&self, tcx: TyCtxt<'tcx>) -> ty::TraitRef<'tcx> {
1273         let def_id = self.trait_def_id(tcx);
1274         ty::TraitRef { def_id, substs: self.substs.truncate_to(tcx, tcx.generics_of(def_id)) }
1275     }
1276
1277     pub fn self_ty(&self) -> Ty<'tcx> {
1278         self.substs.type_at(0)
1279     }
1280 }
1281
1282 #[derive(Copy, Clone, Debug, TypeFoldable)]
1283 pub struct GenSig<'tcx> {
1284     pub resume_ty: Ty<'tcx>,
1285     pub yield_ty: Ty<'tcx>,
1286     pub return_ty: Ty<'tcx>,
1287 }
1288
1289 pub type PolyGenSig<'tcx> = Binder<'tcx, GenSig<'tcx>>;
1290
1291 /// Signature of a function type, which we have arbitrarily
1292 /// decided to use to refer to the input/output types.
1293 ///
1294 /// - `inputs`: is the list of arguments and their modes.
1295 /// - `output`: is the return type.
1296 /// - `c_variadic`: indicates whether this is a C-variadic function.
1297 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1298 #[derive(HashStable, TypeFoldable)]
1299 pub struct FnSig<'tcx> {
1300     pub inputs_and_output: &'tcx List<Ty<'tcx>>,
1301     pub c_variadic: bool,
1302     pub unsafety: hir::Unsafety,
1303     pub abi: abi::Abi,
1304 }
1305
1306 impl<'tcx> FnSig<'tcx> {
1307     pub fn inputs(&self) -> &'tcx [Ty<'tcx>] {
1308         &self.inputs_and_output[..self.inputs_and_output.len() - 1]
1309     }
1310
1311     pub fn output(&self) -> Ty<'tcx> {
1312         self.inputs_and_output[self.inputs_and_output.len() - 1]
1313     }
1314
1315     // Creates a minimal `FnSig` to be used when encountering a `TyKind::Error` in a fallible
1316     // method.
1317     fn fake() -> FnSig<'tcx> {
1318         FnSig {
1319             inputs_and_output: List::empty(),
1320             c_variadic: false,
1321             unsafety: hir::Unsafety::Normal,
1322             abi: abi::Abi::Rust,
1323         }
1324     }
1325 }
1326
1327 pub type PolyFnSig<'tcx> = Binder<'tcx, FnSig<'tcx>>;
1328
1329 impl<'tcx> PolyFnSig<'tcx> {
1330     #[inline]
1331     pub fn inputs(&self) -> Binder<'tcx, &'tcx [Ty<'tcx>]> {
1332         self.map_bound_ref_unchecked(|fn_sig| fn_sig.inputs())
1333     }
1334     #[inline]
1335     pub fn input(&self, index: usize) -> ty::Binder<'tcx, Ty<'tcx>> {
1336         self.map_bound_ref(|fn_sig| fn_sig.inputs()[index])
1337     }
1338     pub fn inputs_and_output(&self) -> ty::Binder<'tcx, &'tcx List<Ty<'tcx>>> {
1339         self.map_bound_ref(|fn_sig| fn_sig.inputs_and_output)
1340     }
1341     #[inline]
1342     pub fn output(&self) -> ty::Binder<'tcx, Ty<'tcx>> {
1343         self.map_bound_ref(|fn_sig| fn_sig.output())
1344     }
1345     pub fn c_variadic(&self) -> bool {
1346         self.skip_binder().c_variadic
1347     }
1348     pub fn unsafety(&self) -> hir::Unsafety {
1349         self.skip_binder().unsafety
1350     }
1351     pub fn abi(&self) -> abi::Abi {
1352         self.skip_binder().abi
1353     }
1354 }
1355
1356 pub type CanonicalPolyFnSig<'tcx> = Canonical<'tcx, Binder<'tcx, FnSig<'tcx>>>;
1357
1358 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1359 #[derive(HashStable)]
1360 pub struct ParamTy {
1361     pub index: u32,
1362     pub name: Symbol,
1363 }
1364
1365 impl<'tcx> ParamTy {
1366     pub fn new(index: u32, name: Symbol) -> ParamTy {
1367         ParamTy { index, name }
1368     }
1369
1370     pub fn for_def(def: &ty::GenericParamDef) -> ParamTy {
1371         ParamTy::new(def.index, def.name)
1372     }
1373
1374     #[inline]
1375     pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1376         tcx.mk_ty_param(self.index, self.name)
1377     }
1378 }
1379
1380 #[derive(Copy, Clone, Hash, TyEncodable, TyDecodable, Eq, PartialEq, Ord, PartialOrd)]
1381 #[derive(HashStable)]
1382 pub struct ParamConst {
1383     pub index: u32,
1384     pub name: Symbol,
1385 }
1386
1387 impl ParamConst {
1388     pub fn new(index: u32, name: Symbol) -> ParamConst {
1389         ParamConst { index, name }
1390     }
1391
1392     pub fn for_def(def: &ty::GenericParamDef) -> ParamConst {
1393         ParamConst::new(def.index, def.name)
1394     }
1395 }
1396
1397 /// Use this rather than `TyKind`, whenever possible.
1398 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, HashStable)]
1399 #[rustc_pass_by_value]
1400 pub struct Region<'tcx>(pub Interned<'tcx, RegionKind>);
1401
1402 impl<'tcx> Deref for Region<'tcx> {
1403     type Target = RegionKind;
1404
1405     fn deref(&self) -> &RegionKind {
1406         &self.0.0
1407     }
1408 }
1409
1410 impl<'tcx> fmt::Debug for Region<'tcx> {
1411     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1412         write!(f, "{:?}", self.kind())
1413     }
1414 }
1415
1416 /// Representation of regions. Note that the NLL checker uses a distinct
1417 /// representation of regions. For this reason, it internally replaces all the
1418 /// regions with inference variables -- the index of the variable is then used
1419 /// to index into internal NLL data structures. See `rustc_const_eval::borrow_check`
1420 /// module for more information.
1421 ///
1422 /// Note: operations are on the wrapper `Region` type, which is interned,
1423 /// rather than this type.
1424 ///
1425 /// ## The Region lattice within a given function
1426 ///
1427 /// In general, the region lattice looks like
1428 ///
1429 /// ```
1430 /// static ----------+-----...------+       (greatest)
1431 /// |                |              |
1432 /// early-bound and  |              |
1433 /// free regions     |              |
1434 /// |                |              |
1435 /// |                |              |
1436 /// empty(root)   placeholder(U1)   |
1437 /// |            /                  |
1438 /// |           /         placeholder(Un)
1439 /// empty(U1) --         /
1440 /// |                   /
1441 /// ...                /
1442 /// |                 /
1443 /// empty(Un) --------                      (smallest)
1444 /// ```
1445 ///
1446 /// Early-bound/free regions are the named lifetimes in scope from the
1447 /// function declaration. They have relationships to one another
1448 /// determined based on the declared relationships from the
1449 /// function.
1450 ///
1451 /// Note that inference variables and bound regions are not included
1452 /// in this diagram. In the case of inference variables, they should
1453 /// be inferred to some other region from the diagram.  In the case of
1454 /// bound regions, they are excluded because they don't make sense to
1455 /// include -- the diagram indicates the relationship between free
1456 /// regions.
1457 ///
1458 /// ## Inference variables
1459 ///
1460 /// During region inference, we sometimes create inference variables,
1461 /// represented as `ReVar`. These will be inferred by the code in
1462 /// `infer::lexical_region_resolve` to some free region from the
1463 /// lattice above (the minimal region that meets the
1464 /// constraints).
1465 ///
1466 /// During NLL checking, where regions are defined differently, we
1467 /// also use `ReVar` -- in that case, the index is used to index into
1468 /// the NLL region checker's data structures. The variable may in fact
1469 /// represent either a free region or an inference variable, in that
1470 /// case.
1471 ///
1472 /// ## Bound Regions
1473 ///
1474 /// These are regions that are stored behind a binder and must be substituted
1475 /// with some concrete region before being used. There are two kind of
1476 /// bound regions: early-bound, which are bound in an item's `Generics`,
1477 /// and are substituted by an `InternalSubsts`, and late-bound, which are part of
1478 /// higher-ranked types (e.g., `for<'a> fn(&'a ())`), and are substituted by
1479 /// the likes of `liberate_late_bound_regions`. The distinction exists
1480 /// because higher-ranked lifetimes aren't supported in all places. See [1][2].
1481 ///
1482 /// Unlike `Param`s, bound regions are not supposed to exist "in the wild"
1483 /// outside their binder, e.g., in types passed to type inference, and
1484 /// should first be substituted (by placeholder regions, free regions,
1485 /// or region variables).
1486 ///
1487 /// ## Placeholder and Free Regions
1488 ///
1489 /// One often wants to work with bound regions without knowing their precise
1490 /// identity. For example, when checking a function, the lifetime of a borrow
1491 /// can end up being assigned to some region parameter. In these cases,
1492 /// it must be ensured that bounds on the region can't be accidentally
1493 /// assumed without being checked.
1494 ///
1495 /// To do this, we replace the bound regions with placeholder markers,
1496 /// which don't satisfy any relation not explicitly provided.
1497 ///
1498 /// There are two kinds of placeholder regions in rustc: `ReFree` and
1499 /// `RePlaceholder`. When checking an item's body, `ReFree` is supposed
1500 /// to be used. These also support explicit bounds: both the internally-stored
1501 /// *scope*, which the region is assumed to outlive, as well as other
1502 /// relations stored in the `FreeRegionMap`. Note that these relations
1503 /// aren't checked when you `make_subregion` (or `eq_types`), only by
1504 /// `resolve_regions_and_report_errors`.
1505 ///
1506 /// When working with higher-ranked types, some region relations aren't
1507 /// yet known, so you can't just call `resolve_regions_and_report_errors`.
1508 /// `RePlaceholder` is designed for this purpose. In these contexts,
1509 /// there's also the risk that some inference variable laying around will
1510 /// get unified with your placeholder region: if you want to check whether
1511 /// `for<'a> Foo<'_>: 'a`, and you substitute your bound region `'a`
1512 /// with a placeholder region `'%a`, the variable `'_` would just be
1513 /// instantiated to the placeholder region `'%a`, which is wrong because
1514 /// the inference variable is supposed to satisfy the relation
1515 /// *for every value of the placeholder region*. To ensure that doesn't
1516 /// happen, you can use `leak_check`. This is more clearly explained
1517 /// by the [rustc dev guide].
1518 ///
1519 /// [1]: https://smallcultfollowing.com/babysteps/blog/2013/10/29/intermingled-parameter-lists/
1520 /// [2]: https://smallcultfollowing.com/babysteps/blog/2013/11/04/intermingled-parameter-lists/
1521 /// [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/traits/hrtb.html
1522 #[derive(Clone, PartialEq, Eq, Hash, Copy, TyEncodable, TyDecodable, PartialOrd, Ord)]
1523 pub enum RegionKind {
1524     /// Region bound in a type or fn declaration which will be
1525     /// substituted 'early' -- that is, at the same time when type
1526     /// parameters are substituted.
1527     ReEarlyBound(EarlyBoundRegion),
1528
1529     /// Region bound in a function scope, which will be substituted when the
1530     /// function is called.
1531     ReLateBound(ty::DebruijnIndex, BoundRegion),
1532
1533     /// When checking a function body, the types of all arguments and so forth
1534     /// that refer to bound region parameters are modified to refer to free
1535     /// region parameters.
1536     ReFree(FreeRegion),
1537
1538     /// Static data that has an "infinite" lifetime. Top in the region lattice.
1539     ReStatic,
1540
1541     /// A region variable. Should not exist outside of type inference.
1542     ReVar(RegionVid),
1543
1544     /// A placeholder region -- basically, the higher-ranked version of `ReFree`.
1545     /// Should not exist outside of type inference.
1546     RePlaceholder(ty::PlaceholderRegion),
1547
1548     /// Empty lifetime is for data that is never accessed.  We tag the
1549     /// empty lifetime with a universe -- the idea is that we don't
1550     /// want `exists<'a> { forall<'b> { 'b: 'a } }` to be satisfiable.
1551     /// Therefore, the `'empty` in a universe `U` is less than all
1552     /// regions visible from `U`, but not less than regions not visible
1553     /// from `U`.
1554     ReEmpty(ty::UniverseIndex),
1555
1556     /// Erased region, used by trait selection, in MIR and during codegen.
1557     ReErased,
1558 }
1559
1560 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable, Debug, PartialOrd, Ord)]
1561 pub struct EarlyBoundRegion {
1562     pub def_id: DefId,
1563     pub index: u32,
1564     pub name: Symbol,
1565 }
1566
1567 /// A **`const`** **v**ariable **ID**.
1568 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1569 pub struct ConstVid<'tcx> {
1570     pub index: u32,
1571     pub phantom: PhantomData<&'tcx ()>,
1572 }
1573
1574 rustc_index::newtype_index! {
1575     /// A **region** (lifetime) **v**ariable **ID**.
1576     pub struct RegionVid {
1577         DEBUG_FORMAT = custom,
1578     }
1579 }
1580
1581 impl Atom for RegionVid {
1582     fn index(self) -> usize {
1583         Idx::index(self)
1584     }
1585 }
1586
1587 rustc_index::newtype_index! {
1588     pub struct BoundVar { .. }
1589 }
1590
1591 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1592 #[derive(HashStable)]
1593 pub struct BoundTy {
1594     pub var: BoundVar,
1595     pub kind: BoundTyKind,
1596 }
1597
1598 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1599 #[derive(HashStable)]
1600 pub enum BoundTyKind {
1601     Anon,
1602     Param(Symbol),
1603 }
1604
1605 impl From<BoundVar> for BoundTy {
1606     fn from(var: BoundVar) -> Self {
1607         BoundTy { var, kind: BoundTyKind::Anon }
1608     }
1609 }
1610
1611 /// A `ProjectionPredicate` for an `ExistentialTraitRef`.
1612 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1613 #[derive(HashStable, TypeFoldable)]
1614 pub struct ExistentialProjection<'tcx> {
1615     pub item_def_id: DefId,
1616     pub substs: SubstsRef<'tcx>,
1617     pub term: Term<'tcx>,
1618 }
1619
1620 pub type PolyExistentialProjection<'tcx> = Binder<'tcx, ExistentialProjection<'tcx>>;
1621
1622 impl<'tcx> ExistentialProjection<'tcx> {
1623     /// Extracts the underlying existential trait reference from this projection.
1624     /// For example, if this is a projection of `exists T. <T as Iterator>::Item == X`,
1625     /// then this function would return an `exists T. T: Iterator` existential trait
1626     /// reference.
1627     pub fn trait_ref(&self, tcx: TyCtxt<'tcx>) -> ty::ExistentialTraitRef<'tcx> {
1628         let def_id = tcx.associated_item(self.item_def_id).container.id();
1629         let subst_count = tcx.generics_of(def_id).count() - 1;
1630         let substs = tcx.intern_substs(&self.substs[..subst_count]);
1631         ty::ExistentialTraitRef { def_id, substs }
1632     }
1633
1634     pub fn with_self_ty(
1635         &self,
1636         tcx: TyCtxt<'tcx>,
1637         self_ty: Ty<'tcx>,
1638     ) -> ty::ProjectionPredicate<'tcx> {
1639         // otherwise the escaping regions would be captured by the binders
1640         debug_assert!(!self_ty.has_escaping_bound_vars());
1641
1642         ty::ProjectionPredicate {
1643             projection_ty: ty::ProjectionTy {
1644                 item_def_id: self.item_def_id,
1645                 substs: tcx.mk_substs_trait(self_ty, self.substs),
1646             },
1647             term: self.term,
1648         }
1649     }
1650
1651     pub fn erase_self_ty(
1652         tcx: TyCtxt<'tcx>,
1653         projection_predicate: ty::ProjectionPredicate<'tcx>,
1654     ) -> Self {
1655         // Assert there is a Self.
1656         projection_predicate.projection_ty.substs.type_at(0);
1657
1658         Self {
1659             item_def_id: projection_predicate.projection_ty.item_def_id,
1660             substs: tcx.intern_substs(&projection_predicate.projection_ty.substs[1..]),
1661             term: projection_predicate.term,
1662         }
1663     }
1664 }
1665
1666 impl<'tcx> PolyExistentialProjection<'tcx> {
1667     pub fn with_self_ty(
1668         &self,
1669         tcx: TyCtxt<'tcx>,
1670         self_ty: Ty<'tcx>,
1671     ) -> ty::PolyProjectionPredicate<'tcx> {
1672         self.map_bound(|p| p.with_self_ty(tcx, self_ty))
1673     }
1674
1675     pub fn item_def_id(&self) -> DefId {
1676         self.skip_binder().item_def_id
1677     }
1678 }
1679
1680 /// Region utilities
1681 impl<'tcx> Region<'tcx> {
1682     pub fn kind(self) -> RegionKind {
1683         *self.0.0
1684     }
1685
1686     /// Is this region named by the user?
1687     pub fn has_name(self) -> bool {
1688         match *self {
1689             ty::ReEarlyBound(ebr) => ebr.has_name(),
1690             ty::ReLateBound(_, br) => br.kind.is_named(),
1691             ty::ReFree(fr) => fr.bound_region.is_named(),
1692             ty::ReStatic => true,
1693             ty::ReVar(..) => false,
1694             ty::RePlaceholder(placeholder) => placeholder.name.is_named(),
1695             ty::ReEmpty(_) => false,
1696             ty::ReErased => false,
1697         }
1698     }
1699
1700     #[inline]
1701     pub fn is_static(self) -> bool {
1702         matches!(*self, ty::ReStatic)
1703     }
1704
1705     #[inline]
1706     pub fn is_erased(self) -> bool {
1707         matches!(*self, ty::ReErased)
1708     }
1709
1710     #[inline]
1711     pub fn is_late_bound(self) -> bool {
1712         matches!(*self, ty::ReLateBound(..))
1713     }
1714
1715     #[inline]
1716     pub fn is_placeholder(self) -> bool {
1717         matches!(*self, ty::RePlaceholder(..))
1718     }
1719
1720     #[inline]
1721     pub fn is_empty(self) -> bool {
1722         matches!(*self, ty::ReEmpty(..))
1723     }
1724
1725     #[inline]
1726     pub fn bound_at_or_above_binder(self, index: ty::DebruijnIndex) -> bool {
1727         match *self {
1728             ty::ReLateBound(debruijn, _) => debruijn >= index,
1729             _ => false,
1730         }
1731     }
1732
1733     pub fn type_flags(self) -> TypeFlags {
1734         let mut flags = TypeFlags::empty();
1735
1736         match *self {
1737             ty::ReVar(..) => {
1738                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1739                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1740                 flags = flags | TypeFlags::HAS_RE_INFER;
1741             }
1742             ty::RePlaceholder(..) => {
1743                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1744                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1745                 flags = flags | TypeFlags::HAS_RE_PLACEHOLDER;
1746             }
1747             ty::ReEarlyBound(..) => {
1748                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1749                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1750                 flags = flags | TypeFlags::HAS_RE_PARAM;
1751             }
1752             ty::ReFree { .. } => {
1753                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1754                 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1755             }
1756             ty::ReEmpty(_) | ty::ReStatic => {
1757                 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1758             }
1759             ty::ReLateBound(..) => {
1760                 flags = flags | TypeFlags::HAS_RE_LATE_BOUND;
1761             }
1762             ty::ReErased => {
1763                 flags = flags | TypeFlags::HAS_RE_ERASED;
1764             }
1765         }
1766
1767         debug!("type_flags({:?}) = {:?}", self, flags);
1768
1769         flags
1770     }
1771
1772     /// Given an early-bound or free region, returns the `DefId` where it was bound.
1773     /// For example, consider the regions in this snippet of code:
1774     ///
1775     /// ```
1776     /// impl<'a> Foo {
1777     ///      ^^ -- early bound, declared on an impl
1778     ///
1779     ///     fn bar<'b, 'c>(x: &self, y: &'b u32, z: &'c u64) where 'static: 'c
1780     ///            ^^  ^^     ^ anonymous, late-bound
1781     ///            |   early-bound, appears in where-clauses
1782     ///            late-bound, appears only in fn args
1783     ///     {..}
1784     /// }
1785     /// ```
1786     ///
1787     /// Here, `free_region_binding_scope('a)` would return the `DefId`
1788     /// of the impl, and for all the other highlighted regions, it
1789     /// would return the `DefId` of the function. In other cases (not shown), this
1790     /// function might return the `DefId` of a closure.
1791     pub fn free_region_binding_scope(self, tcx: TyCtxt<'_>) -> DefId {
1792         match *self {
1793             ty::ReEarlyBound(br) => tcx.parent(br.def_id).unwrap(),
1794             ty::ReFree(fr) => fr.scope,
1795             _ => bug!("free_region_binding_scope invoked on inappropriate region: {:?}", self),
1796         }
1797     }
1798 }
1799
1800 /// Type utilities
1801 impl<'tcx> Ty<'tcx> {
1802     #[inline(always)]
1803     pub fn kind(self) -> &'tcx TyKind<'tcx> {
1804         &self.0.0.kind
1805     }
1806
1807     #[inline(always)]
1808     pub fn flags(self) -> TypeFlags {
1809         self.0.0.flags
1810     }
1811
1812     #[inline]
1813     pub fn is_unit(self) -> bool {
1814         match self.kind() {
1815             Tuple(ref tys) => tys.is_empty(),
1816             _ => false,
1817         }
1818     }
1819
1820     #[inline]
1821     pub fn is_never(self) -> bool {
1822         matches!(self.kind(), Never)
1823     }
1824
1825     #[inline]
1826     pub fn is_primitive(self) -> bool {
1827         self.kind().is_primitive()
1828     }
1829
1830     #[inline]
1831     pub fn is_adt(self) -> bool {
1832         matches!(self.kind(), Adt(..))
1833     }
1834
1835     #[inline]
1836     pub fn is_ref(self) -> bool {
1837         matches!(self.kind(), Ref(..))
1838     }
1839
1840     #[inline]
1841     pub fn is_ty_var(self) -> bool {
1842         matches!(self.kind(), Infer(TyVar(_)))
1843     }
1844
1845     #[inline]
1846     pub fn ty_vid(self) -> Option<ty::TyVid> {
1847         match self.kind() {
1848             &Infer(TyVar(vid)) => Some(vid),
1849             _ => None,
1850         }
1851     }
1852
1853     #[inline]
1854     pub fn is_ty_infer(self) -> bool {
1855         matches!(self.kind(), Infer(_))
1856     }
1857
1858     #[inline]
1859     pub fn is_phantom_data(self) -> bool {
1860         if let Adt(def, _) = self.kind() { def.is_phantom_data() } else { false }
1861     }
1862
1863     #[inline]
1864     pub fn is_bool(self) -> bool {
1865         *self.kind() == Bool
1866     }
1867
1868     /// Returns `true` if this type is a `str`.
1869     #[inline]
1870     pub fn is_str(self) -> bool {
1871         *self.kind() == Str
1872     }
1873
1874     #[inline]
1875     pub fn is_param(self, index: u32) -> bool {
1876         match self.kind() {
1877             ty::Param(ref data) => data.index == index,
1878             _ => false,
1879         }
1880     }
1881
1882     #[inline]
1883     pub fn is_slice(self) -> bool {
1884         match self.kind() {
1885             RawPtr(TypeAndMut { ty, .. }) | Ref(_, ty, _) => matches!(ty.kind(), Slice(_) | Str),
1886             _ => false,
1887         }
1888     }
1889
1890     #[inline]
1891     pub fn is_array(self) -> bool {
1892         matches!(self.kind(), Array(..))
1893     }
1894
1895     #[inline]
1896     pub fn is_simd(self) -> bool {
1897         match self.kind() {
1898             Adt(def, _) => def.repr.simd(),
1899             _ => false,
1900         }
1901     }
1902
1903     pub fn sequence_element_type(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1904         match self.kind() {
1905             Array(ty, _) | Slice(ty) => *ty,
1906             Str => tcx.types.u8,
1907             _ => bug!("`sequence_element_type` called on non-sequence value: {}", self),
1908         }
1909     }
1910
1911     pub fn simd_size_and_type(self, tcx: TyCtxt<'tcx>) -> (u64, Ty<'tcx>) {
1912         match self.kind() {
1913             Adt(def, substs) => {
1914                 assert!(def.repr.simd(), "`simd_size_and_type` called on non-SIMD type");
1915                 let variant = def.non_enum_variant();
1916                 let f0_ty = variant.fields[0].ty(tcx, substs);
1917
1918                 match f0_ty.kind() {
1919                     // If the first field is an array, we assume it is the only field and its
1920                     // elements are the SIMD components.
1921                     Array(f0_elem_ty, f0_len) => {
1922                         // FIXME(repr_simd): https://github.com/rust-lang/rust/pull/78863#discussion_r522784112
1923                         // The way we evaluate the `N` in `[T; N]` here only works since we use
1924                         // `simd_size_and_type` post-monomorphization. It will probably start to ICE
1925                         // if we use it in generic code. See the `simd-array-trait` ui test.
1926                         (f0_len.eval_usize(tcx, ParamEnv::empty()) as u64, *f0_elem_ty)
1927                     }
1928                     // Otherwise, the fields of this Adt are the SIMD components (and we assume they
1929                     // all have the same type).
1930                     _ => (variant.fields.len() as u64, f0_ty),
1931                 }
1932             }
1933             _ => bug!("`simd_size_and_type` called on invalid type"),
1934         }
1935     }
1936
1937     #[inline]
1938     pub fn is_region_ptr(self) -> bool {
1939         matches!(self.kind(), Ref(..))
1940     }
1941
1942     #[inline]
1943     pub fn is_mutable_ptr(self) -> bool {
1944         matches!(
1945             self.kind(),
1946             RawPtr(TypeAndMut { mutbl: hir::Mutability::Mut, .. })
1947                 | Ref(_, _, hir::Mutability::Mut)
1948         )
1949     }
1950
1951     /// Get the mutability of the reference or `None` when not a reference
1952     #[inline]
1953     pub fn ref_mutability(self) -> Option<hir::Mutability> {
1954         match self.kind() {
1955             Ref(_, _, mutability) => Some(*mutability),
1956             _ => None,
1957         }
1958     }
1959
1960     #[inline]
1961     pub fn is_unsafe_ptr(self) -> bool {
1962         matches!(self.kind(), RawPtr(_))
1963     }
1964
1965     /// Tests if this is any kind of primitive pointer type (reference, raw pointer, fn pointer).
1966     #[inline]
1967     pub fn is_any_ptr(self) -> bool {
1968         self.is_region_ptr() || self.is_unsafe_ptr() || self.is_fn_ptr()
1969     }
1970
1971     #[inline]
1972     pub fn is_box(self) -> bool {
1973         match self.kind() {
1974             Adt(def, _) => def.is_box(),
1975             _ => false,
1976         }
1977     }
1978
1979     /// Panics if called on any type other than `Box<T>`.
1980     pub fn boxed_ty(self) -> Ty<'tcx> {
1981         match self.kind() {
1982             Adt(def, substs) if def.is_box() => substs.type_at(0),
1983             _ => bug!("`boxed_ty` is called on non-box type {:?}", self),
1984         }
1985     }
1986
1987     /// A scalar type is one that denotes an atomic datum, with no sub-components.
1988     /// (A RawPtr is scalar because it represents a non-managed pointer, so its
1989     /// contents are abstract to rustc.)
1990     #[inline]
1991     pub fn is_scalar(self) -> bool {
1992         matches!(
1993             self.kind(),
1994             Bool | Char
1995                 | Int(_)
1996                 | Float(_)
1997                 | Uint(_)
1998                 | FnDef(..)
1999                 | FnPtr(_)
2000                 | RawPtr(_)
2001                 | Infer(IntVar(_) | FloatVar(_))
2002         )
2003     }
2004
2005     /// Returns `true` if this type is a floating point type.
2006     #[inline]
2007     pub fn is_floating_point(self) -> bool {
2008         matches!(self.kind(), Float(_) | Infer(FloatVar(_)))
2009     }
2010
2011     #[inline]
2012     pub fn is_trait(self) -> bool {
2013         matches!(self.kind(), Dynamic(..))
2014     }
2015
2016     #[inline]
2017     pub fn is_enum(self) -> bool {
2018         matches!(self.kind(), Adt(adt_def, _) if adt_def.is_enum())
2019     }
2020
2021     #[inline]
2022     pub fn is_union(self) -> bool {
2023         matches!(self.kind(), Adt(adt_def, _) if adt_def.is_union())
2024     }
2025
2026     #[inline]
2027     pub fn is_closure(self) -> bool {
2028         matches!(self.kind(), Closure(..))
2029     }
2030
2031     #[inline]
2032     pub fn is_generator(self) -> bool {
2033         matches!(self.kind(), Generator(..))
2034     }
2035
2036     #[inline]
2037     pub fn is_integral(self) -> bool {
2038         matches!(self.kind(), Infer(IntVar(_)) | Int(_) | Uint(_))
2039     }
2040
2041     #[inline]
2042     pub fn is_fresh_ty(self) -> bool {
2043         matches!(self.kind(), Infer(FreshTy(_)))
2044     }
2045
2046     #[inline]
2047     pub fn is_fresh(self) -> bool {
2048         matches!(self.kind(), Infer(FreshTy(_) | FreshIntTy(_) | FreshFloatTy(_)))
2049     }
2050
2051     #[inline]
2052     pub fn is_char(self) -> bool {
2053         matches!(self.kind(), Char)
2054     }
2055
2056     #[inline]
2057     pub fn is_numeric(self) -> bool {
2058         self.is_integral() || self.is_floating_point()
2059     }
2060
2061     #[inline]
2062     pub fn is_signed(self) -> bool {
2063         matches!(self.kind(), Int(_))
2064     }
2065
2066     #[inline]
2067     pub fn is_ptr_sized_integral(self) -> bool {
2068         matches!(self.kind(), Int(ty::IntTy::Isize) | Uint(ty::UintTy::Usize))
2069     }
2070
2071     #[inline]
2072     pub fn has_concrete_skeleton(self) -> bool {
2073         !matches!(self.kind(), Param(_) | Infer(_) | Error(_))
2074     }
2075
2076     /// Checks whether a type recursively contains another type
2077     ///
2078     /// Example: `Option<()>` contains `()`
2079     pub fn contains(self, other: Ty<'tcx>) -> bool {
2080         struct ContainsTyVisitor<'tcx>(Ty<'tcx>);
2081
2082         impl<'tcx> TypeVisitor<'tcx> for ContainsTyVisitor<'tcx> {
2083             type BreakTy = ();
2084
2085             fn visit_ty(&mut self, t: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
2086                 if self.0 == t { ControlFlow::BREAK } else { t.super_visit_with(self) }
2087             }
2088         }
2089
2090         let cf = self.visit_with(&mut ContainsTyVisitor(other));
2091         cf.is_break()
2092     }
2093
2094     /// Returns the type and mutability of `*ty`.
2095     ///
2096     /// The parameter `explicit` indicates if this is an *explicit* dereference.
2097     /// Some types -- notably unsafe ptrs -- can only be dereferenced explicitly.
2098     pub fn builtin_deref(self, explicit: bool) -> Option<TypeAndMut<'tcx>> {
2099         match self.kind() {
2100             Adt(def, _) if def.is_box() => {
2101                 Some(TypeAndMut { ty: self.boxed_ty(), mutbl: hir::Mutability::Not })
2102             }
2103             Ref(_, ty, mutbl) => Some(TypeAndMut { ty: *ty, mutbl: *mutbl }),
2104             RawPtr(mt) if explicit => Some(*mt),
2105             _ => None,
2106         }
2107     }
2108
2109     /// Returns the type of `ty[i]`.
2110     pub fn builtin_index(self) -> Option<Ty<'tcx>> {
2111         match self.kind() {
2112             Array(ty, _) | Slice(ty) => Some(*ty),
2113             _ => None,
2114         }
2115     }
2116
2117     pub fn fn_sig(self, tcx: TyCtxt<'tcx>) -> PolyFnSig<'tcx> {
2118         match self.kind() {
2119             FnDef(def_id, substs) => tcx.fn_sig(*def_id).subst(tcx, substs),
2120             FnPtr(f) => *f,
2121             Error(_) => {
2122                 // ignore errors (#54954)
2123                 ty::Binder::dummy(FnSig::fake())
2124             }
2125             Closure(..) => bug!(
2126                 "to get the signature of a closure, use `substs.as_closure().sig()` not `fn_sig()`",
2127             ),
2128             _ => bug!("Ty::fn_sig() called on non-fn type: {:?}", self),
2129         }
2130     }
2131
2132     #[inline]
2133     pub fn is_fn(self) -> bool {
2134         matches!(self.kind(), FnDef(..) | FnPtr(_))
2135     }
2136
2137     #[inline]
2138     pub fn is_fn_ptr(self) -> bool {
2139         matches!(self.kind(), FnPtr(_))
2140     }
2141
2142     #[inline]
2143     pub fn is_impl_trait(self) -> bool {
2144         matches!(self.kind(), Opaque(..))
2145     }
2146
2147     #[inline]
2148     pub fn ty_adt_def(self) -> Option<&'tcx AdtDef> {
2149         match self.kind() {
2150             Adt(adt, _) => Some(adt),
2151             _ => None,
2152         }
2153     }
2154
2155     /// Iterates over tuple fields.
2156     /// Panics when called on anything but a tuple.
2157     pub fn tuple_fields(self) -> &'tcx List<Ty<'tcx>> {
2158         match self.kind() {
2159             Tuple(substs) => substs,
2160             _ => bug!("tuple_fields called on non-tuple"),
2161         }
2162     }
2163
2164     /// If the type contains variants, returns the valid range of variant indices.
2165     //
2166     // FIXME: This requires the optimized MIR in the case of generators.
2167     #[inline]
2168     pub fn variant_range(self, tcx: TyCtxt<'tcx>) -> Option<Range<VariantIdx>> {
2169         match self.kind() {
2170             TyKind::Adt(adt, _) => Some(adt.variant_range()),
2171             TyKind::Generator(def_id, substs, _) => {
2172                 Some(substs.as_generator().variant_range(*def_id, tcx))
2173             }
2174             _ => None,
2175         }
2176     }
2177
2178     /// If the type contains variants, returns the variant for `variant_index`.
2179     /// Panics if `variant_index` is out of range.
2180     //
2181     // FIXME: This requires the optimized MIR in the case of generators.
2182     #[inline]
2183     pub fn discriminant_for_variant(
2184         self,
2185         tcx: TyCtxt<'tcx>,
2186         variant_index: VariantIdx,
2187     ) -> Option<Discr<'tcx>> {
2188         match self.kind() {
2189             TyKind::Adt(adt, _) if adt.variants.is_empty() => {
2190                 // This can actually happen during CTFE, see
2191                 // https://github.com/rust-lang/rust/issues/89765.
2192                 None
2193             }
2194             TyKind::Adt(adt, _) if adt.is_enum() => {
2195                 Some(adt.discriminant_for_variant(tcx, variant_index))
2196             }
2197             TyKind::Generator(def_id, substs, _) => {
2198                 Some(substs.as_generator().discriminant_for_variant(*def_id, tcx, variant_index))
2199             }
2200             _ => None,
2201         }
2202     }
2203
2204     /// Returns the type of the discriminant of this type.
2205     pub fn discriminant_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2206         match self.kind() {
2207             ty::Adt(adt, _) if adt.is_enum() => adt.repr.discr_type().to_ty(tcx),
2208             ty::Generator(_, substs, _) => substs.as_generator().discr_ty(tcx),
2209
2210             ty::Param(_) | ty::Projection(_) | ty::Opaque(..) | ty::Infer(ty::TyVar(_)) => {
2211                 let assoc_items = tcx.associated_item_def_ids(
2212                     tcx.require_lang_item(hir::LangItem::DiscriminantKind, None),
2213                 );
2214                 tcx.mk_projection(assoc_items[0], tcx.intern_substs(&[self.into()]))
2215             }
2216
2217             ty::Bool
2218             | ty::Char
2219             | ty::Int(_)
2220             | ty::Uint(_)
2221             | ty::Float(_)
2222             | ty::Adt(..)
2223             | ty::Foreign(_)
2224             | ty::Str
2225             | ty::Array(..)
2226             | ty::Slice(_)
2227             | ty::RawPtr(_)
2228             | ty::Ref(..)
2229             | ty::FnDef(..)
2230             | ty::FnPtr(..)
2231             | ty::Dynamic(..)
2232             | ty::Closure(..)
2233             | ty::GeneratorWitness(..)
2234             | ty::Never
2235             | ty::Tuple(_)
2236             | ty::Error(_)
2237             | ty::Infer(IntVar(_) | FloatVar(_)) => tcx.types.u8,
2238
2239             ty::Bound(..)
2240             | ty::Placeholder(_)
2241             | ty::Infer(FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2242                 bug!("`discriminant_ty` applied to unexpected type: {:?}", self)
2243             }
2244         }
2245     }
2246
2247     /// Returns the type of metadata for (potentially fat) pointers to this type.
2248     pub fn ptr_metadata_ty(
2249         self,
2250         tcx: TyCtxt<'tcx>,
2251         normalize: impl FnMut(Ty<'tcx>) -> Ty<'tcx>,
2252     ) -> Ty<'tcx> {
2253         let tail = tcx.struct_tail_with_normalize(self, normalize);
2254         match tail.kind() {
2255             // Sized types
2256             ty::Infer(ty::IntVar(_) | ty::FloatVar(_))
2257             | ty::Uint(_)
2258             | ty::Int(_)
2259             | ty::Bool
2260             | ty::Float(_)
2261             | ty::FnDef(..)
2262             | ty::FnPtr(_)
2263             | ty::RawPtr(..)
2264             | ty::Char
2265             | ty::Ref(..)
2266             | ty::Generator(..)
2267             | ty::GeneratorWitness(..)
2268             | ty::Array(..)
2269             | ty::Closure(..)
2270             | ty::Never
2271             | ty::Error(_)
2272             | ty::Foreign(..)
2273             // If returned by `struct_tail_without_normalization` this is a unit struct
2274             // without any fields, or not a struct, and therefore is Sized.
2275             | ty::Adt(..)
2276             // If returned by `struct_tail_without_normalization` this is the empty tuple,
2277             // a.k.a. unit type, which is Sized
2278             | ty::Tuple(..) => tcx.types.unit,
2279
2280             ty::Str | ty::Slice(_) => tcx.types.usize,
2281             ty::Dynamic(..) => {
2282                 let dyn_metadata = tcx.lang_items().dyn_metadata().unwrap();
2283                 tcx.type_of(dyn_metadata).subst(tcx, &[tail.into()])
2284             },
2285
2286             ty::Projection(_)
2287             | ty::Param(_)
2288             | ty::Opaque(..)
2289             | ty::Infer(ty::TyVar(_))
2290             | ty::Bound(..)
2291             | ty::Placeholder(..)
2292             | ty::Infer(ty::FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2293                 bug!("`ptr_metadata_ty` applied to unexpected type: {:?}", tail)
2294             }
2295         }
2296     }
2297
2298     /// When we create a closure, we record its kind (i.e., what trait
2299     /// it implements) into its `ClosureSubsts` using a type
2300     /// parameter. This is kind of a phantom type, except that the
2301     /// most convenient thing for us to are the integral types. This
2302     /// function converts such a special type into the closure
2303     /// kind. To go the other way, use
2304     /// `tcx.closure_kind_ty(closure_kind)`.
2305     ///
2306     /// Note that during type checking, we use an inference variable
2307     /// to represent the closure kind, because it has not yet been
2308     /// inferred. Once upvar inference (in `rustc_typeck/src/check/upvar.rs`)
2309     /// is complete, that type variable will be unified.
2310     pub fn to_opt_closure_kind(self) -> Option<ty::ClosureKind> {
2311         match self.kind() {
2312             Int(int_ty) => match int_ty {
2313                 ty::IntTy::I8 => Some(ty::ClosureKind::Fn),
2314                 ty::IntTy::I16 => Some(ty::ClosureKind::FnMut),
2315                 ty::IntTy::I32 => Some(ty::ClosureKind::FnOnce),
2316                 _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2317             },
2318
2319             // "Bound" types appear in canonical queries when the
2320             // closure type is not yet known
2321             Bound(..) | Infer(_) => None,
2322
2323             Error(_) => Some(ty::ClosureKind::Fn),
2324
2325             _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2326         }
2327     }
2328
2329     /// Fast path helper for testing if a type is `Sized`.
2330     ///
2331     /// Returning true means the type is known to be sized. Returning
2332     /// `false` means nothing -- could be sized, might not be.
2333     ///
2334     /// Note that we could never rely on the fact that a type such as `[_]` is
2335     /// trivially `!Sized` because we could be in a type environment with a
2336     /// bound such as `[_]: Copy`. A function with such a bound obviously never
2337     /// can be called, but that doesn't mean it shouldn't typecheck. This is why
2338     /// this method doesn't return `Option<bool>`.
2339     pub fn is_trivially_sized(self, tcx: TyCtxt<'tcx>) -> bool {
2340         match self.kind() {
2341             ty::Infer(ty::IntVar(_) | ty::FloatVar(_))
2342             | ty::Uint(_)
2343             | ty::Int(_)
2344             | ty::Bool
2345             | ty::Float(_)
2346             | ty::FnDef(..)
2347             | ty::FnPtr(_)
2348             | ty::RawPtr(..)
2349             | ty::Char
2350             | ty::Ref(..)
2351             | ty::Generator(..)
2352             | ty::GeneratorWitness(..)
2353             | ty::Array(..)
2354             | ty::Closure(..)
2355             | ty::Never
2356             | ty::Error(_) => true,
2357
2358             ty::Str | ty::Slice(_) | ty::Dynamic(..) | ty::Foreign(..) => false,
2359
2360             ty::Tuple(tys) => tys.iter().all(|ty| ty.is_trivially_sized(tcx)),
2361
2362             ty::Adt(def, _substs) => def.sized_constraint(tcx).is_empty(),
2363
2364             ty::Projection(_) | ty::Param(_) | ty::Opaque(..) => false,
2365
2366             ty::Infer(ty::TyVar(_)) => false,
2367
2368             ty::Bound(..)
2369             | ty::Placeholder(..)
2370             | ty::Infer(ty::FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2371                 bug!("`is_trivially_sized` applied to unexpected type: {:?}", self)
2372             }
2373         }
2374     }
2375 }
2376
2377 /// Extra information about why we ended up with a particular variance.
2378 /// This is only used to add more information to error messages, and
2379 /// has no effect on soundness. While choosing the 'wrong' `VarianceDiagInfo`
2380 /// may lead to confusing notes in error messages, it will never cause
2381 /// a miscompilation or unsoundness.
2382 ///
2383 /// When in doubt, use `VarianceDiagInfo::default()`
2384 #[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
2385 pub enum VarianceDiagInfo<'tcx> {
2386     /// No additional information - this is the default.
2387     /// We will not add any additional information to error messages.
2388     #[default]
2389     None,
2390     /// We switched our variance because a generic argument occurs inside
2391     /// the invariant generic argument of another type.
2392     Invariant {
2393         /// The generic type containing the generic parameter
2394         /// that changes the variance (e.g. `*mut T`, `MyStruct<T>`)
2395         ty: Ty<'tcx>,
2396         /// The index of the generic parameter being used
2397         /// (e.g. `0` for `*mut T`, `1` for `MyStruct<'CovariantParam, 'InvariantParam>`)
2398         param_index: u32,
2399     },
2400 }
2401
2402 impl<'tcx> VarianceDiagInfo<'tcx> {
2403     /// Mirrors `Variance::xform` - used to 'combine' the existing
2404     /// and new `VarianceDiagInfo`s when our variance changes.
2405     pub fn xform(self, other: VarianceDiagInfo<'tcx>) -> VarianceDiagInfo<'tcx> {
2406         // For now, just use the first `VarianceDiagInfo::Invariant` that we see
2407         match self {
2408             VarianceDiagInfo::None => other,
2409             VarianceDiagInfo::Invariant { .. } => self,
2410         }
2411     }
2412 }