src/librustc/ty/mod.rs

   1 // ignore-tidy-filelength
   2
   3 pub use self::Variance::*;
   4 pub use self::AssocItemContainer::*;
   5 pub use self::BorrowKind::*;
   6 pub use self::IntVarValue::*;
   7 pub use self::fold::{TypeFoldable, TypeVisitor};
   8
   9 use crate::hir::{map as hir_map, GlobMap, TraitMap};
  10 use crate::hir::Node;
  11 use crate::hir::def::{Res, DefKind, CtorOf, CtorKind, ExportMap};
  12 use crate::hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
  13 use rustc_data_structures::svh::Svh;
  14 use rustc_macros::HashStable;
  15 use crate::ich::Fingerprint;
  16 use crate::ich::StableHashingContext;
  17 use crate::infer::canonical::Canonical;
  18 use crate::middle::cstore::CrateStoreDyn;
  19 use crate::middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem, FnOnceTraitLangItem};
  20 use crate::middle::resolve_lifetime::ObjectLifetimeDefault;
  21 use crate::mir::ReadOnlyBodyAndCache;
  22 use crate::mir::interpret::{GlobalId, ErrorHandled};
  23 use crate::mir::GeneratorLayout;
  24 use crate::session::CrateDisambiguator;
  25 use crate::traits::{self, Reveal};
  26 use crate::ty;
  27 use crate::ty::layout::VariantIdx;
  28 use crate::ty::subst::{Subst, InternalSubsts, SubstsRef};
  29 use crate::ty::util::{IntTypeExt, Discr};
  30 use crate::ty::walk::TypeWalker;
  31 use crate::util::captures::Captures;
  32 use crate::util::nodemap::{NodeMap, NodeSet, DefIdMap, FxHashMap};
  33 use arena::SyncDroplessArena;
  34 use crate::session::DataTypeKind;
  35
  36 use rustc_serialize::{self, Encodable, Encoder};
  37 use rustc_target::abi::Align;
  38 use std::cell::RefCell;
  39 use std::cmp::{self, Ordering};
  40 use std::fmt;
  41 use std::hash::{Hash, Hasher};
  42 use std::ops::Deref;
  43 use rustc_data_structures::sync::{self, Lrc, ParallelIterator, par_iter};
  44 use std::slice;
  45 use std::{mem, ptr};
  46 use std::ops::Range;
  47 use syntax::ast::{self, Name, Ident, NodeId};
  48 use syntax::attr;
  49 use syntax_pos::symbol::{kw, sym, Symbol};
  50 use syntax_pos::hygiene::ExpnId;
  51 use syntax_pos::Span;
  52
  53 use smallvec;
  54 use rustc_data_structures::fx::{FxIndexMap};
  55 use rustc_data_structures::stable_hasher::{StableHasher, HashStable};
  56 use rustc_index::vec::{Idx, IndexVec};
  57
  58 use crate::hir;
  59
  60 pub use self::sty::{Binder, BoundTy, BoundTyKind, BoundVar, DebruijnIndex, INNERMOST};
  61 pub use self::sty::{FnSig, GenSig, CanonicalPolyFnSig, PolyFnSig, PolyGenSig};
  62 pub use self::sty::{InferTy, ParamTy, ParamConst, InferConst, ProjectionTy, ExistentialPredicate};
  63 pub use self::sty::{ClosureSubsts, GeneratorSubsts, UpvarSubsts, TypeAndMut};
  64 pub use self::sty::{TraitRef, TyKind, PolyTraitRef};
  65 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
  66 pub use self::sty::{ExistentialProjection, PolyExistentialProjection, Const, ConstKind};
  67 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
  68 pub use self::sty::RegionKind;
  69 pub use self::sty::{TyVid, IntVid, FloatVid, ConstVid, RegionVid};
  70 pub use self::sty::BoundRegion::*;
  71 pub use self::sty::InferTy::*;
  72 pub use self::sty::RegionKind::*;
  73 pub use self::sty::TyKind::*;
  74 pub use crate::ty::diagnostics::*;
  75
  76 pub use self::binding::BindingMode;
  77 pub use self::binding::BindingMode::*;
  78
  79 pub use self::context::{TyCtxt, FreeRegionInfo, AllArenas, tls, keep_local};
  80 pub use self::context::{Lift, GeneratorInteriorTypeCause, TypeckTables, CtxtInterners, GlobalCtxt};
  81 pub use self::context::{
  82     UserTypeAnnotationIndex, UserType, CanonicalUserType,
  83     CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations, ResolvedOpaqueTy,
  84 };
  85
  86 pub use self::instance::{Instance, InstanceDef};
  87
  88 pub use self::structural_match::search_for_structural_match_violation;
  89 pub use self::structural_match::type_marked_structural;
  90 pub use self::structural_match::NonStructuralMatchTy;
  91
  92 pub use self::trait_def::TraitDef;
  93
  94 pub use self::query::queries;
  95
  96 pub mod adjustment;
  97 pub mod binding;
  98 pub mod cast;
  99 #[macro_use]
 100 pub mod codec;
 101 mod constness;
 102 pub mod error;
 103 mod erase_regions;
 104 pub mod fast_reject;
 105 pub mod flags;
 106 pub mod fold;
 107 pub mod inhabitedness;
 108 pub mod layout;
 109 pub mod _match;
 110 pub mod outlives;
 111 pub mod print;
 112 pub mod query;
 113 pub mod relate;
 114 pub mod steal;
 115 pub mod subst;
 116 pub mod trait_def;
 117 pub mod walk;
 118 pub mod wf;
 119 pub mod util;
 120
 121 mod context;
 122 mod instance;
 123 mod structural_impls;
 124 mod structural_match;
 125 mod sty;
 126 mod diagnostics;
 127
 128 // Data types
 129
 130 pub struct ResolverOutputs {
 131     pub definitions: hir_map::Definitions,
 132     pub cstore: Box<CrateStoreDyn>,
 133     pub extern_crate_map: NodeMap<CrateNum>,
 134     pub trait_map: TraitMap,
 135     pub maybe_unused_trait_imports: NodeSet,
 136     pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
 137     pub export_map: ExportMap<NodeId>,
 138     pub glob_map: GlobMap,
 139     /// Extern prelude entries. The value is `true` if the entry was introduced
 140     /// via `extern crate` item and not `--extern` option or compiler built-in.
 141     pub extern_prelude: FxHashMap<Name, bool>,
 142 }
 143
 144 #[derive(Clone, Copy, PartialEq, Eq, Debug, HashStable)]
 145 pub enum AssocItemContainer {
 146     TraitContainer(DefId),
 147     ImplContainer(DefId),
 148 }
 149
 150 impl AssocItemContainer {
 151     /// Asserts that this is the `DefId` of an associated item declared
 152     /// in a trait, and returns the trait `DefId`.
 153     pub fn assert_trait(&self) -> DefId {
 154         match *self {
 155             TraitContainer(id) => id,
 156             _ => bug!("associated item has wrong container type: {:?}", self)
 157         }
 158     }
 159
 160     pub fn id(&self) -> DefId {
 161         match *self {
 162             TraitContainer(id) => id,
 163             ImplContainer(id) => id,
 164         }
 165     }
 166 }
 167
 168 /// The "header" of an impl is everything outside the body: a Self type, a trait
 169 /// ref (in the case of a trait impl), and a set of predicates (from the
 170 /// bounds / where-clauses).
 171 #[derive(Clone, Debug, TypeFoldable)]
 172 pub struct ImplHeader<'tcx> {
 173     pub impl_def_id: DefId,
 174     pub self_ty: Ty<'tcx>,
 175     pub trait_ref: Option<TraitRef<'tcx>>,
 176     pub predicates: Vec<Predicate<'tcx>>,
 177 }
 178
 179 #[derive(Copy, Clone, PartialEq, RustcEncodable, RustcDecodable, HashStable)]
 180 pub enum ImplPolarity {
 181     /// `impl Trait for Type`
 182     Positive,
 183     /// `impl !Trait for Type`
 184     Negative,
 185     /// `#[rustc_reservation_impl] impl Trait for Type`
 186     ///
 187     /// This is a "stability hack", not a real Rust feature.
 188     /// See #64631 for details.
 189     Reservation,
 190 }
 191
 192 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
 193 pub struct AssocItem {
 194     pub def_id: DefId,
 195     #[stable_hasher(project(name))]
 196     pub ident: Ident,
 197     pub kind: AssocKind,
 198     pub vis: Visibility,
 199     pub defaultness: hir::Defaultness,
 200     pub container: AssocItemContainer,
 201
 202     /// Whether this is a method with an explicit self
 203     /// as its first argument, allowing method calls.
 204     pub method_has_self_argument: bool,
 205 }
 206
 207 #[derive(Copy, Clone, PartialEq, Debug, HashStable)]
 208 pub enum AssocKind {
 209     Const,
 210     Method,
 211     OpaqueTy,
 212     Type
 213 }
 214
 215 impl AssocKind {
 216     pub fn suggestion_descr(&self) -> &'static str {
 217         match self {
 218             ty::AssocKind::Method => "method call",
 219             ty::AssocKind::Type |
 220             ty::AssocKind::OpaqueTy => "associated type",
 221             ty::AssocKind::Const => "associated constant",
 222         }
 223     }
 224 }
 225
 226 impl AssocItem {
 227     pub fn def_kind(&self) -> DefKind {
 228         match self.kind {
 229             AssocKind::Const => DefKind::AssocConst,
 230             AssocKind::Method => DefKind::Method,
 231             AssocKind::Type => DefKind::AssocTy,
 232             AssocKind::OpaqueTy => DefKind::AssocOpaqueTy,
 233         }
 234     }
 235
 236     /// Tests whether the associated item admits a non-trivial implementation
 237     /// for !
 238     pub fn relevant_for_never(&self) -> bool {
 239         match self.kind {
 240             AssocKind::OpaqueTy |
 241             AssocKind::Const |
 242             AssocKind::Type => true,
 243             // FIXME(canndrew): Be more thorough here, check if any argument is uninhabited.
 244             AssocKind::Method => !self.method_has_self_argument,
 245         }
 246     }
 247
 248     pub fn signature(&self, tcx: TyCtxt<'_>) -> String {
 249         match self.kind {
 250             ty::AssocKind::Method => {
 251                 // We skip the binder here because the binder would deanonymize all
 252                 // late-bound regions, and we don't want method signatures to show up
 253                 // `as for<'r> fn(&'r MyType)`.  Pretty-printing handles late-bound
 254                 // regions just fine, showing `fn(&MyType)`.
 255                 tcx.fn_sig(self.def_id).skip_binder().to_string()
 256             }
 257             ty::AssocKind::Type => format!("type {};", self.ident),
 258             // FIXME(type_alias_impl_trait): we should print bounds here too.
 259             ty::AssocKind::OpaqueTy => format!("type {};", self.ident),
 260             ty::AssocKind::Const => {
 261                 format!("const {}: {:?};", self.ident, tcx.type_of(self.def_id))
 262             }
 263         }
 264     }
 265 }
 266
 267 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable, HashStable)]
 268 pub enum Visibility {
 269     /// Visible everywhere (including in other crates).
 270     Public,
 271     /// Visible only in the given crate-local module.
 272     Restricted(DefId),
 273     /// Not visible anywhere in the local crate. This is the visibility of private external items.
 274     Invisible,
 275 }
 276
 277 pub trait DefIdTree: Copy {
 278     fn parent(self, id: DefId) -> Option<DefId>;
 279
 280     fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
 281         if descendant.krate != ancestor.krate {
 282             return false;
 283         }
 284
 285         while descendant != ancestor {
 286             match self.parent(descendant) {
 287                 Some(parent) => descendant = parent,
 288                 None => return false,
 289             }
 290         }
 291         true
 292     }
 293 }
 294
 295 impl<'tcx> DefIdTree for TyCtxt<'tcx> {
 296     fn parent(self, id: DefId) -> Option<DefId> {
 297         self.def_key(id).parent.map(|index| DefId { index: index, ..id })
 298     }
 299 }
 300
 301 impl Visibility {
 302     pub fn from_hir(visibility: &hir::Visibility, id: hir::HirId, tcx: TyCtxt<'_>) -> Self {
 303         match visibility.node {
 304             hir::VisibilityKind::Public => Visibility::Public,
 305             hir::VisibilityKind::Crate(_) => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
 306             hir::VisibilityKind::Restricted { ref path, .. } => match path.res {
 307                 // If there is no resolution, `resolve` will have already reported an error, so
 308                 // assume that the visibility is public to avoid reporting more privacy errors.
 309                 Res::Err => Visibility::Public,
 310                 def => Visibility::Restricted(def.def_id()),
 311             },
 312             hir::VisibilityKind::Inherited => {
 313                 Visibility::Restricted(tcx.hir().get_module_parent(id))
 314             }
 315         }
 316     }
 317
 318     /// Returns `true` if an item with this visibility is accessible from the given block.
 319     pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
 320         let restriction = match self {
 321             // Public items are visible everywhere.
 322             Visibility::Public => return true,
 323             // Private items from other crates are visible nowhere.
 324             Visibility::Invisible => return false,
 325             // Restricted items are visible in an arbitrary local module.
 326             Visibility::Restricted(other) if other.krate != module.krate => return false,
 327             Visibility::Restricted(module) => module,
 328         };
 329
 330         tree.is_descendant_of(module, restriction)
 331     }
 332
 333     /// Returns `true` if this visibility is at least as accessible as the given visibility
 334     pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
 335         let vis_restriction = match vis {
 336             Visibility::Public => return self == Visibility::Public,
 337             Visibility::Invisible => return true,
 338             Visibility::Restricted(module) => module,
 339         };
 340
 341         self.is_accessible_from(vis_restriction, tree)
 342     }
 343
 344     // Returns `true` if this item is visible anywhere in the local crate.
 345     pub fn is_visible_locally(self) -> bool {
 346         match self {
 347             Visibility::Public => true,
 348             Visibility::Restricted(def_id) => def_id.is_local(),
 349             Visibility::Invisible => false,
 350         }
 351     }
 352 }
 353
 354 #[derive(Copy, Clone, PartialEq, RustcDecodable, RustcEncodable, HashStable)]
 355 pub enum Variance {
 356     Covariant,      // T<A> <: T<B> iff A <: B -- e.g., function return type
 357     Invariant,      // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
 358     Contravariant,  // T<A> <: T<B> iff B <: A -- e.g., function param type
 359     Bivariant,      // T<A> <: T<B>            -- e.g., unused type parameter
 360 }
 361
 362 /// The crate variances map is computed during typeck and contains the
 363 /// variance of every item in the local crate. You should not use it
 364 /// directly, because to do so will make your pass dependent on the
 365 /// HIR of every item in the local crate. Instead, use
 366 /// `tcx.variances_of()` to get the variance for a *particular*
 367 /// item.
 368 #[derive(HashStable)]
 369 pub struct CrateVariancesMap<'tcx> {
 370     /// For each item with generics, maps to a vector of the variance
 371     /// of its generics. If an item has no generics, it will have no
 372     /// entry.
 373     pub variances: FxHashMap<DefId, &'tcx [ty::Variance]>,
 374 }
 375
 376 impl Variance {
 377     /// `a.xform(b)` combines the variance of a context with the
 378     /// variance of a type with the following meaning. If we are in a
 379     /// context with variance `a`, and we encounter a type argument in
 380     /// a position with variance `b`, then `a.xform(b)` is the new
 381     /// variance with which the argument appears.
 382     ///
 383     /// Example 1:
 384     ///
 385     ///     *mut Vec<i32>
 386     ///
 387     /// Here, the "ambient" variance starts as covariant. `*mut T` is
 388     /// invariant with respect to `T`, so the variance in which the
 389     /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
 390     /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
 391     /// respect to its type argument `T`, and hence the variance of
 392     /// the `i32` here is `Invariant.xform(Covariant)`, which results
 393     /// (again) in `Invariant`.
 394     ///
 395     /// Example 2:
 396     ///
 397     ///     fn(*const Vec<i32>, *mut Vec<i32)
 398     ///
 399     /// The ambient variance is covariant. A `fn` type is
 400     /// contravariant with respect to its parameters, so the variance
 401     /// within which both pointer types appear is
 402     /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
 403     /// T` is covariant with respect to `T`, so the variance within
 404     /// which the first `Vec<i32>` appears is
 405     /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
 406     /// is true for its `i32` argument. In the `*mut T` case, the
 407     /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
 408     /// and hence the outermost type is `Invariant` with respect to
 409     /// `Vec<i32>` (and its `i32` argument).
 410     ///
 411     /// Source: Figure 1 of "Taming the Wildcards:
 412     /// Combining Definition- and Use-Site Variance" published in PLDI'11.
 413     pub fn xform(self, v: ty::Variance) -> ty::Variance {
 414         match (self, v) {
 415             // Figure 1, column 1.
 416             (ty::Covariant, ty::Covariant) => ty::Covariant,
 417             (ty::Covariant, ty::Contravariant) => ty::Contravariant,
 418             (ty::Covariant, ty::Invariant) => ty::Invariant,
 419             (ty::Covariant, ty::Bivariant) => ty::Bivariant,
 420
 421             // Figure 1, column 2.
 422             (ty::Contravariant, ty::Covariant) => ty::Contravariant,
 423             (ty::Contravariant, ty::Contravariant) => ty::Covariant,
 424             (ty::Contravariant, ty::Invariant) => ty::Invariant,
 425             (ty::Contravariant, ty::Bivariant) => ty::Bivariant,
 426
 427             // Figure 1, column 3.
 428             (ty::Invariant, _) => ty::Invariant,
 429
 430             // Figure 1, column 4.
 431             (ty::Bivariant, _) => ty::Bivariant,
 432         }
 433     }
 434 }
 435
 436 // Contains information needed to resolve types and (in the future) look up
 437 // the types of AST nodes.
 438 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
 439 pub struct CReaderCacheKey {
 440     pub cnum: CrateNum,
 441     pub pos: usize,
 442 }
 443
 444 // Flags that we track on types. These flags are propagated upwards
 445 // through the type during type construction, so that we can quickly
 446 // check whether the type has various kinds of types in it without
 447 // recursing over the type itself.
 448 bitflags! {
 449     pub struct TypeFlags: u32 {
 450         const HAS_PARAMS         = 1 << 0;
 451         const HAS_TY_INFER       = 1 << 1;
 452         const HAS_RE_INFER       = 1 << 2;
 453         const HAS_RE_PLACEHOLDER = 1 << 3;
 454
 455         /// Does this have any `ReEarlyBound` regions? Used to
 456         /// determine whether substitition is required, since those
 457         /// represent regions that are bound in a `ty::Generics` and
 458         /// hence may be substituted.
 459         const HAS_RE_EARLY_BOUND = 1 << 4;
 460
 461         /// Does this have any region that "appears free" in the type?
 462         /// Basically anything but `ReLateBound` and `ReErased`.
 463         const HAS_FREE_REGIONS   = 1 << 5;
 464
 465         /// Is an error type reachable?
 466         const HAS_TY_ERR         = 1 << 6;
 467         const HAS_PROJECTION     = 1 << 7;
 468
 469         // FIXME: Rename this to the actual property since it's used for generators too
 470         const HAS_TY_CLOSURE     = 1 << 8;
 471
 472         /// `true` if there are "names" of types and regions and so forth
 473         /// that are local to a particular fn
 474         const HAS_FREE_LOCAL_NAMES = 1 << 9;
 475
 476         /// Present if the type belongs in a local type context.
 477         /// Only set for Infer other than Fresh.
 478         const KEEP_IN_LOCAL_TCX  = 1 << 10;
 479
 480         /// Does this have any `ReLateBound` regions? Used to check
 481         /// if a global bound is safe to evaluate.
 482         const HAS_RE_LATE_BOUND  = 1 << 11;
 483
 484         const HAS_TY_PLACEHOLDER = 1 << 12;
 485
 486         const HAS_CT_INFER       = 1 << 13;
 487         const HAS_CT_PLACEHOLDER = 1 << 14;
 488
 489         const NEEDS_SUBST        = TypeFlags::HAS_PARAMS.bits |
 490                                    TypeFlags::HAS_RE_EARLY_BOUND.bits;
 491
 492         /// Flags representing the nominal content of a type,
 493         /// computed by FlagsComputation. If you add a new nominal
 494         /// flag, it should be added here too.
 495         const NOMINAL_FLAGS     = TypeFlags::HAS_PARAMS.bits |
 496                                   TypeFlags::HAS_TY_INFER.bits |
 497                                   TypeFlags::HAS_RE_INFER.bits |
 498                                   TypeFlags::HAS_RE_PLACEHOLDER.bits |
 499                                   TypeFlags::HAS_RE_EARLY_BOUND.bits |
 500                                   TypeFlags::HAS_FREE_REGIONS.bits |
 501                                   TypeFlags::HAS_TY_ERR.bits |
 502                                   TypeFlags::HAS_PROJECTION.bits |
 503                                   TypeFlags::HAS_TY_CLOSURE.bits |
 504                                   TypeFlags::HAS_FREE_LOCAL_NAMES.bits |
 505                                   TypeFlags::KEEP_IN_LOCAL_TCX.bits |
 506                                   TypeFlags::HAS_RE_LATE_BOUND.bits |
 507                                   TypeFlags::HAS_TY_PLACEHOLDER.bits |
 508                                   TypeFlags::HAS_CT_INFER.bits |
 509                                   TypeFlags::HAS_CT_PLACEHOLDER.bits;
 510     }
 511 }
 512
 513 #[allow(rustc::usage_of_ty_tykind)]
 514 pub struct TyS<'tcx> {
 515     pub kind: TyKind<'tcx>,
 516     pub flags: TypeFlags,
 517
 518     /// This is a kind of confusing thing: it stores the smallest
 519     /// binder such that
 520     ///
 521     /// (a) the binder itself captures nothing but
 522     /// (b) all the late-bound things within the type are captured
 523     ///     by some sub-binder.
 524     ///
 525     /// So, for a type without any late-bound things, like `u32`, this
 526     /// will be *innermost*, because that is the innermost binder that
 527     /// captures nothing. But for a type `&'D u32`, where `'D` is a
 528     /// late-bound region with De Bruijn index `D`, this would be `D + 1`
 529     /// -- the binder itself does not capture `D`, but `D` is captured
 530     /// by an inner binder.
 531     ///
 532     /// We call this concept an "exclusive" binder `D` because all
 533     /// De Bruijn indices within the type are contained within `0..D`
 534     /// (exclusive).
 535     outer_exclusive_binder: ty::DebruijnIndex,
 536 }
 537
 538 // `TyS` is used a lot. Make sure it doesn't unintentionally get bigger.
 539 #[cfg(target_arch = "x86_64")]
 540 static_assert_size!(TyS<'_>, 32);
 541
 542 impl<'tcx> Ord for TyS<'tcx> {
 543     fn cmp(&self, other: &TyS<'tcx>) -> Ordering {
 544         self.kind.cmp(&other.kind)
 545     }
 546 }
 547
 548 impl<'tcx> PartialOrd for TyS<'tcx> {
 549     fn partial_cmp(&self, other: &TyS<'tcx>) -> Option<Ordering> {
 550         Some(self.kind.cmp(&other.kind))
 551     }
 552 }
 553
 554 impl<'tcx> PartialEq for TyS<'tcx> {
 555     #[inline]
 556     fn eq(&self, other: &TyS<'tcx>) -> bool {
 557         ptr::eq(self, other)
 558     }
 559 }
 560 impl<'tcx> Eq for TyS<'tcx> {}
 561
 562 impl<'tcx> Hash for TyS<'tcx> {
 563     fn hash<H: Hasher>(&self, s: &mut H) {
 564         (self as *const TyS<'_>).hash(s)
 565     }
 566 }
 567
 568 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for ty::TyS<'tcx> {
 569     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
 570         let ty::TyS {
 571             ref kind,
 572
 573             // The other fields just provide fast access to information that is
 574             // also contained in `kind`, so no need to hash them.
 575             flags: _,
 576
 577             outer_exclusive_binder: _,
 578         } = *self;
 579
 580         kind.hash_stable(hcx, hasher);
 581     }
 582 }
 583
 584 #[rustc_diagnostic_item = "Ty"]
 585 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
 586
 587 impl<'tcx> rustc_serialize::UseSpecializedEncodable for Ty<'tcx> {}
 588 impl<'tcx> rustc_serialize::UseSpecializedDecodable for Ty<'tcx> {}
 589
 590 pub type CanonicalTy<'tcx> = Canonical<'tcx, Ty<'tcx>>;
 591
 592 extern {
 593     /// A dummy type used to force `List` to be unsized while not requiring references to it be wide
 594     /// pointers.
 595     type OpaqueListContents;
 596 }
 597
 598 /// A wrapper for slices with the additional invariant
 599 /// that the slice is interned and no other slice with
 600 /// the same contents can exist in the same context.
 601 /// This means we can use pointer for both
 602 /// equality comparisons and hashing.
 603 /// Note: `Slice` was already taken by the `Ty`.
 604 #[repr(C)]
 605 pub struct List<T> {
 606     len: usize,
 607     data: [T; 0],
 608     opaque: OpaqueListContents,
 609 }
 610
 611 unsafe impl<T: Sync> Sync for List<T> {}
 612
 613 impl<T: Copy> List<T> {
 614     #[inline]
 615     fn from_arena<'tcx>(arena: &'tcx SyncDroplessArena, slice: &[T]) -> &'tcx List<T> {
 616         assert!(!mem::needs_drop::<T>());
 617         assert!(mem::size_of::<T>() != 0);
 618         assert!(slice.len() != 0);
 619
 620         // Align up the size of the len (usize) field
 621         let align = mem::align_of::<T>();
 622         let align_mask = align - 1;
 623         let offset = mem::size_of::<usize>();
 624         let offset = (offset + align_mask) & !align_mask;
 625
 626         let size = offset + slice.len() * mem::size_of::<T>();
 627
 628         let mem = arena.alloc_raw(
 629             size,
 630             cmp::max(mem::align_of::<T>(), mem::align_of::<usize>()));
 631         unsafe {
 632             let result = &mut *(mem.as_mut_ptr() as *mut List<T>);
 633             // Write the length
 634             result.len = slice.len();
 635
 636             // Write the elements
 637             let arena_slice = slice::from_raw_parts_mut(result.data.as_mut_ptr(), result.len);
 638             arena_slice.copy_from_slice(slice);
 639
 640             result
 641         }
 642     }
 643 }
 644
 645 impl<T: fmt::Debug> fmt::Debug for List<T> {
 646     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
 647         (**self).fmt(f)
 648     }
 649 }
 650
 651 impl<T: Encodable> Encodable for List<T> {
 652     #[inline]
 653     fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
 654         (**self).encode(s)
 655     }
 656 }
 657
 658 impl<T> Ord for List<T> where T: Ord {
 659     fn cmp(&self, other: &List<T>) -> Ordering {
 660         if self == other { Ordering::Equal } else {
 661             <[T] as Ord>::cmp(&**self, &**other)
 662         }
 663     }
 664 }
 665
 666 impl<T> PartialOrd for List<T> where T: PartialOrd {
 667     fn partial_cmp(&self, other: &List<T>) -> Option<Ordering> {
 668         if self == other { Some(Ordering::Equal) } else {
 669             <[T] as PartialOrd>::partial_cmp(&**self, &**other)
 670         }
 671     }
 672 }
 673
 674 impl<T: PartialEq> PartialEq for List<T> {
 675     #[inline]
 676     fn eq(&self, other: &List<T>) -> bool {
 677         ptr::eq(self, other)
 678     }
 679 }
 680 impl<T: Eq> Eq for List<T> {}
 681
 682 impl<T> Hash for List<T> {
 683     #[inline]
 684     fn hash<H: Hasher>(&self, s: &mut H) {
 685         (self as *const List<T>).hash(s)
 686     }
 687 }
 688
 689 impl<T> Deref for List<T> {
 690     type Target = [T];
 691     #[inline(always)]
 692     fn deref(&self) -> &[T] {
 693         self.as_ref()
 694     }
 695 }
 696
 697 impl<T> AsRef<[T]> for List<T> {
 698     #[inline(always)]
 699     fn as_ref(&self) -> &[T] {
 700         unsafe {
 701             slice::from_raw_parts(self.data.as_ptr(), self.len)
 702         }
 703     }
 704 }
 705
 706 impl<'a, T> IntoIterator for &'a List<T> {
 707     type Item = &'a T;
 708     type IntoIter = <&'a [T] as IntoIterator>::IntoIter;
 709     #[inline(always)]
 710     fn into_iter(self) -> Self::IntoIter {
 711         self[..].iter()
 712     }
 713 }
 714
 715 impl<'tcx> rustc_serialize::UseSpecializedDecodable for &'tcx List<Ty<'tcx>> {}
 716
 717 impl<T> List<T> {
 718     #[inline(always)]
 719     pub fn empty<'a>() -> &'a List<T> {
 720         #[repr(align(64), C)]
 721         struct EmptySlice([u8; 64]);
 722         static EMPTY_SLICE: EmptySlice = EmptySlice([0; 64]);
 723         assert!(mem::align_of::<T>() <= 64);
 724         unsafe {
 725             &*(&EMPTY_SLICE as *const _ as *const List<T>)
 726         }
 727     }
 728 }
 729
 730 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
 731 pub struct UpvarPath {
 732     pub hir_id: hir::HirId,
 733 }
 734
 735 /// Upvars do not get their own `NodeId`. Instead, we use the pair of
 736 /// the original var ID (that is, the root variable that is referenced
 737 /// by the upvar) and the ID of the closure expression.
 738 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
 739 pub struct UpvarId {
 740     pub var_path: UpvarPath,
 741     pub closure_expr_id: LocalDefId,
 742 }
 743
 744 #[derive(Clone, PartialEq, Debug, RustcEncodable, RustcDecodable, Copy, HashStable)]
 745 pub enum BorrowKind {
 746     /// Data must be immutable and is aliasable.
 747     ImmBorrow,
 748
 749     /// Data must be immutable but not aliasable. This kind of borrow
 750     /// cannot currently be expressed by the user and is used only in
 751     /// implicit closure bindings. It is needed when the closure
 752     /// is borrowing or mutating a mutable referent, e.g.:
 753     ///
 754     ///    let x: &mut isize = ...;
 755     ///    let y = || *x += 5;
 756     ///
 757     /// If we were to try to translate this closure into a more explicit
 758     /// form, we'd encounter an error with the code as written:
 759     ///
 760     ///    struct Env { x: & &mut isize }
 761     ///    let x: &mut isize = ...;
 762     ///    let y = (&mut Env { &x }, fn_ptr);  // Closure is pair of env and fn
 763     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
 764     ///
 765     /// This is then illegal because you cannot mutate a `&mut` found
 766     /// in an aliasable location. To solve, you'd have to translate with
 767     /// an `&mut` borrow:
 768     ///
 769     ///    struct Env { x: & &mut isize }
 770     ///    let x: &mut isize = ...;
 771     ///    let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
 772     ///    fn fn_ptr(env: &mut Env) { **env.x += 5; }
 773     ///
 774     /// Now the assignment to `**env.x` is legal, but creating a
 775     /// mutable pointer to `x` is not because `x` is not mutable. We
 776     /// could fix this by declaring `x` as `let mut x`. This is ok in
 777     /// user code, if awkward, but extra weird for closures, since the
 778     /// borrow is hidden.
 779     ///
 780     /// So we introduce a "unique imm" borrow -- the referent is
 781     /// immutable, but not aliasable. This solves the problem. For
 782     /// simplicity, we don't give users the way to express this
 783     /// borrow, it's just used when translating closures.
 784     UniqueImmBorrow,
 785
 786     /// Data is mutable and not aliasable.
 787     MutBorrow
 788 }
 789
 790 /// Information describing the capture of an upvar. This is computed
 791 /// during `typeck`, specifically by `regionck`.
 792 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable, HashStable)]
 793 pub enum UpvarCapture<'tcx> {
 794     /// Upvar is captured by value. This is always true when the
 795     /// closure is labeled `move`, but can also be true in other cases
 796     /// depending on inference.
 797     ByValue,
 798
 799     /// Upvar is captured by reference.
 800     ByRef(UpvarBorrow<'tcx>),
 801 }
 802
 803 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable, HashStable)]
 804 pub struct UpvarBorrow<'tcx> {
 805     /// The kind of borrow: by-ref upvars have access to shared
 806     /// immutable borrows, which are not part of the normal language
 807     /// syntax.
 808     pub kind: BorrowKind,
 809
 810     /// Region of the resulting reference.
 811     pub region: ty::Region<'tcx>,
 812 }
 813
 814 pub type UpvarListMap = FxHashMap<DefId, FxIndexMap<hir::HirId, UpvarId>>;
 815 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
 816
 817 #[derive(Copy, Clone, TypeFoldable)]
 818 pub struct ClosureUpvar<'tcx> {
 819     pub res: Res,
 820     pub span: Span,
 821     pub ty: Ty<'tcx>,
 822 }
 823
 824 #[derive(Clone, Copy, PartialEq, Eq)]
 825 pub enum IntVarValue {
 826     IntType(ast::IntTy),
 827     UintType(ast::UintTy),
 828 }
 829
 830 #[derive(Clone, Copy, PartialEq, Eq)]
 831 pub struct FloatVarValue(pub ast::FloatTy);
 832
 833 impl ty::EarlyBoundRegion {
 834     pub fn to_bound_region(&self) -> ty::BoundRegion {
 835         ty::BoundRegion::BrNamed(self.def_id, self.name)
 836     }
 837
 838     /// Does this early bound region have a name? Early bound regions normally
 839     /// always have names except when using anonymous lifetimes (`'_`).
 840     pub fn has_name(&self) -> bool {
 841         self.name != kw::UnderscoreLifetime
 842     }
 843 }
 844
 845 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
 846 pub enum GenericParamDefKind {
 847     Lifetime,
 848     Type {
 849         has_default: bool,
 850         object_lifetime_default: ObjectLifetimeDefault,
 851         synthetic: Option<hir::SyntheticTyParamKind>,
 852     },
 853     Const,
 854 }
 855
 856 #[derive(Clone, RustcEncodable, RustcDecodable, HashStable)]
 857 pub struct GenericParamDef {
 858     pub name: Symbol,
 859     pub def_id: DefId,
 860     pub index: u32,
 861
 862     /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
 863     /// on generic parameter `'a`/`T`, asserts data behind the parameter
 864     /// `'a`/`T` won't be accessed during the parent type's `Drop` impl.
 865     pub pure_wrt_drop: bool,
 866
 867     pub kind: GenericParamDefKind,
 868 }
 869
 870 impl GenericParamDef {
 871     pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
 872         if let GenericParamDefKind::Lifetime = self.kind {
 873             ty::EarlyBoundRegion {
 874                 def_id: self.def_id,
 875                 index: self.index,
 876                 name: self.name,
 877             }
 878         } else {
 879             bug!("cannot convert a non-lifetime parameter def to an early bound region")
 880         }
 881     }
 882
 883     pub fn to_bound_region(&self) -> ty::BoundRegion {
 884         if let GenericParamDefKind::Lifetime = self.kind {
 885             self.to_early_bound_region_data().to_bound_region()
 886         } else {
 887             bug!("cannot convert a non-lifetime parameter def to an early bound region")
 888         }
 889     }
 890 }
 891
 892 #[derive(Default)]
 893 pub struct GenericParamCount {
 894     pub lifetimes: usize,
 895     pub types: usize,
 896     pub consts: usize,
 897 }
 898
 899 /// Information about the formal type/lifetime parameters associated
 900 /// with an item or method. Analogous to `hir::Generics`.
 901 ///
 902 /// The ordering of parameters is the same as in `Subst` (excluding child generics):
 903 /// `Self` (optionally), `Lifetime` params..., `Type` params...
 904 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
 905 pub struct Generics {
 906     pub parent: Option<DefId>,
 907     pub parent_count: usize,
 908     pub params: Vec<GenericParamDef>,
 909
 910     /// Reverse map to the `index` field of each `GenericParamDef`.
 911     #[stable_hasher(ignore)]
 912     pub param_def_id_to_index: FxHashMap<DefId, u32>,
 913
 914     pub has_self: bool,
 915     pub has_late_bound_regions: Option<Span>,
 916 }
 917
 918 impl<'tcx> Generics {
 919     pub fn count(&self) -> usize {
 920         self.parent_count + self.params.len()
 921     }
 922
 923     pub fn own_counts(&self) -> GenericParamCount {
 924         // We could cache this as a property of `GenericParamCount`, but
 925         // the aim is to refactor this away entirely eventually and the
 926         // presence of this method will be a constant reminder.
 927         let mut own_counts: GenericParamCount = Default::default();
 928
 929         for param in &self.params {
 930             match param.kind {
 931                 GenericParamDefKind::Lifetime => own_counts.lifetimes += 1,
 932                 GenericParamDefKind::Type { .. } => own_counts.types += 1,
 933                 GenericParamDefKind::Const => own_counts.consts += 1,
 934             };
 935         }
 936
 937         own_counts
 938     }
 939
 940     pub fn requires_monomorphization(&self, tcx: TyCtxt<'tcx>) -> bool {
 941         if self.own_requires_monomorphization() {
 942             return true;
 943         }
 944
 945         if let Some(parent_def_id) = self.parent {
 946             let parent = tcx.generics_of(parent_def_id);
 947             parent.requires_monomorphization(tcx)
 948         } else {
 949             false
 950         }
 951     }
 952
 953     pub fn own_requires_monomorphization(&self) -> bool {
 954         for param in &self.params {
 955             match param.kind {
 956                 GenericParamDefKind::Type { .. } | GenericParamDefKind::Const => return true,
 957                 GenericParamDefKind::Lifetime => {}
 958             }
 959         }
 960         false
 961     }
 962
 963     pub fn region_param(
 964         &'tcx self,
 965         param: &EarlyBoundRegion,
 966         tcx: TyCtxt<'tcx>,
 967     ) -> &'tcx GenericParamDef {
 968         if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
 969             let param = &self.params[index as usize];
 970             match param.kind {
 971                 GenericParamDefKind::Lifetime => param,
 972                 _ => bug!("expected lifetime parameter, but found another generic parameter")
 973             }
 974         } else {
 975             tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
 976                .region_param(param, tcx)
 977         }
 978     }
 979
 980     /// Returns the `GenericParamDef` associated with this `ParamTy`.
 981     pub fn type_param(&'tcx self, param: &ParamTy, tcx: TyCtxt<'tcx>) -> &'tcx GenericParamDef {
 982         if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
 983             let param = &self.params[index as usize];
 984             match param.kind {
 985                 GenericParamDefKind::Type { .. } => param,
 986                 _ => bug!("expected type parameter, but found another generic parameter")
 987             }
 988         } else {
 989             tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
 990                .type_param(param, tcx)
 991         }
 992     }
 993
 994     /// Returns the `ConstParameterDef` associated with this `ParamConst`.
 995     pub fn const_param(&'tcx self, param: &ParamConst, tcx: TyCtxt<'tcx>) -> &GenericParamDef {
 996         if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
 997             let param = &self.params[index as usize];
 998             match param.kind {
 999                 GenericParamDefKind::Const => param,
1000                 _ => bug!("expected const parameter, but found another generic parameter")
1001             }
1002         } else {
1003             tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
1004                 .const_param(param, tcx)
1005         }
1006     }
1007 }
1008
1009 /// Bounds on generics.
1010 #[derive(Copy, Clone, Default, Debug, RustcEncodable, RustcDecodable, HashStable)]
1011 pub struct GenericPredicates<'tcx> {
1012     pub parent: Option<DefId>,
1013     pub predicates: &'tcx [(Predicate<'tcx>, Span)],
1014 }
1015
1016 impl<'tcx> GenericPredicates<'tcx> {
1017     pub fn instantiate(
1018         &self,
1019         tcx: TyCtxt<'tcx>,
1020         substs: SubstsRef<'tcx>,
1021     ) -> InstantiatedPredicates<'tcx> {
1022         let mut instantiated = InstantiatedPredicates::empty();
1023         self.instantiate_into(tcx, &mut instantiated, substs);
1024         instantiated
1025     }
1026
1027     pub fn instantiate_own(
1028         &self,
1029         tcx: TyCtxt<'tcx>,
1030         substs: SubstsRef<'tcx>,
1031     ) -> InstantiatedPredicates<'tcx> {
1032         InstantiatedPredicates {
1033             predicates: self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)).collect(),
1034         }
1035     }
1036
1037     fn instantiate_into(
1038         &self,
1039         tcx: TyCtxt<'tcx>,
1040         instantiated: &mut InstantiatedPredicates<'tcx>,
1041         substs: SubstsRef<'tcx>,
1042     ) {
1043         if let Some(def_id) = self.parent {
1044             tcx.predicates_of(def_id).instantiate_into(tcx, instantiated, substs);
1045         }
1046         instantiated.predicates.extend(
1047             self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)),
1048         );
1049     }
1050
1051     pub fn instantiate_identity(&self, tcx: TyCtxt<'tcx>) -> InstantiatedPredicates<'tcx> {
1052         let mut instantiated = InstantiatedPredicates::empty();
1053         self.instantiate_identity_into(tcx, &mut instantiated);
1054         instantiated
1055     }
1056
1057     fn instantiate_identity_into(
1058         &self,
1059         tcx: TyCtxt<'tcx>,
1060         instantiated: &mut InstantiatedPredicates<'tcx>,
1061     ) {
1062         if let Some(def_id) = self.parent {
1063             tcx.predicates_of(def_id).instantiate_identity_into(tcx, instantiated);
1064         }
1065         instantiated.predicates.extend(self.predicates.iter().map(|&(p, _)| p))
1066     }
1067
1068     pub fn instantiate_supertrait(
1069         &self,
1070         tcx: TyCtxt<'tcx>,
1071         poly_trait_ref: &ty::PolyTraitRef<'tcx>,
1072     ) -> InstantiatedPredicates<'tcx> {
1073         assert_eq!(self.parent, None);
1074         InstantiatedPredicates {
1075             predicates: self.predicates.iter().map(|(pred, _)| {
1076                 pred.subst_supertrait(tcx, poly_trait_ref)
1077             }).collect()
1078         }
1079     }
1080 }
1081
1082 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1083 #[derive(HashStable, TypeFoldable)]
1084 pub enum Predicate<'tcx> {
1085     /// Corresponds to `where Foo: Bar<A, B, C>`. `Foo` here would be
1086     /// the `Self` type of the trait reference and `A`, `B`, and `C`
1087     /// would be the type parameters.
1088     Trait(PolyTraitPredicate<'tcx>),
1089
1090     /// `where 'a: 'b`
1091     RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
1092
1093     /// `where T: 'a`
1094     TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
1095
1096     /// `where <T as TraitRef>::Name == X`, approximately.
1097     /// See the `ProjectionPredicate` struct for details.
1098     Projection(PolyProjectionPredicate<'tcx>),
1099
1100     /// No syntax: `T` well-formed.
1101     WellFormed(Ty<'tcx>),
1102
1103     /// Trait must be object-safe.
1104     ObjectSafe(DefId),
1105
1106     /// No direct syntax. May be thought of as `where T: FnFoo<...>`
1107     /// for some substitutions `...` and `T` being a closure type.
1108     /// Satisfied (or refuted) once we know the closure's kind.
1109     ClosureKind(DefId, SubstsRef<'tcx>, ClosureKind),
1110
1111     /// `T1 <: T2`
1112     Subtype(PolySubtypePredicate<'tcx>),
1113
1114     /// Constant initializer must evaluate successfully.
1115     ConstEvaluatable(DefId, SubstsRef<'tcx>),
1116 }
1117
1118 /// The crate outlives map is computed during typeck and contains the
1119 /// outlives of every item in the local crate. You should not use it
1120 /// directly, because to do so will make your pass dependent on the
1121 /// HIR of every item in the local crate. Instead, use
1122 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
1123 /// item.
1124 #[derive(HashStable)]
1125 pub struct CratePredicatesMap<'tcx> {
1126     /// For each struct with outlive bounds, maps to a vector of the
1127     /// predicate of its outlive bounds. If an item has no outlives
1128     /// bounds, it will have no entry.
1129     pub predicates: FxHashMap<DefId, &'tcx [(ty::Predicate<'tcx>, Span)]>,
1130 }
1131
1132 impl<'tcx> AsRef<Predicate<'tcx>> for Predicate<'tcx> {
1133     fn as_ref(&self) -> &Predicate<'tcx> {
1134         self
1135     }
1136 }
1137
1138 impl<'tcx> Predicate<'tcx> {
1139     /// Performs a substitution suitable for going from a
1140     /// poly-trait-ref to supertraits that must hold if that
1141     /// poly-trait-ref holds. This is slightly different from a normal
1142     /// substitution in terms of what happens with bound regions. See
1143     /// lengthy comment below for details.
1144     pub fn subst_supertrait(
1145         &self,
1146         tcx: TyCtxt<'tcx>,
1147         trait_ref: &ty::PolyTraitRef<'tcx>,
1148     ) -> ty::Predicate<'tcx> {
1149         // The interaction between HRTB and supertraits is not entirely
1150         // obvious. Let me walk you (and myself) through an example.
1151         //
1152         // Let's start with an easy case. Consider two traits:
1153         //
1154         //     trait Foo<'a>: Bar<'a,'a> { }
1155         //     trait Bar<'b,'c> { }
1156         //
1157         // Now, if we have a trait reference `for<'x> T: Foo<'x>`, then
1158         // we can deduce that `for<'x> T: Bar<'x,'x>`. Basically, if we
1159         // knew that `Foo<'x>` (for any 'x) then we also know that
1160         // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
1161         // normal substitution.
1162         //
1163         // In terms of why this is sound, the idea is that whenever there
1164         // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
1165         // holds.  So if there is an impl of `T:Foo<'a>` that applies to
1166         // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
1167         // `'a`.
1168         //
1169         // Another example to be careful of is this:
1170         //
1171         //     trait Foo1<'a>: for<'b> Bar1<'a,'b> { }
1172         //     trait Bar1<'b,'c> { }
1173         //
1174         // Here, if we have `for<'x> T: Foo1<'x>`, then what do we know?
1175         // The answer is that we know `for<'x,'b> T: Bar1<'x,'b>`. The
1176         // reason is similar to the previous example: any impl of
1177         // `T:Foo1<'x>` must show that `for<'b> T: Bar1<'x, 'b>`.  So
1178         // basically we would want to collapse the bound lifetimes from
1179         // the input (`trait_ref`) and the supertraits.
1180         //
1181         // To achieve this in practice is fairly straightforward. Let's
1182         // consider the more complicated scenario:
1183         //
1184         // - We start out with `for<'x> T: Foo1<'x>`. In this case, `'x`
1185         //   has a De Bruijn index of 1. We want to produce `for<'x,'b> T: Bar1<'x,'b>`,
1186         //   where both `'x` and `'b` would have a DB index of 1.
1187         //   The substitution from the input trait-ref is therefore going to be
1188         //   `'a => 'x` (where `'x` has a DB index of 1).
1189         // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
1190         //   early-bound parameter and `'b' is a late-bound parameter with a
1191         //   DB index of 1.
1192         // - If we replace `'a` with `'x` from the input, it too will have
1193         //   a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
1194         //   just as we wanted.
1195         //
1196         // There is only one catch. If we just apply the substitution `'a
1197         // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
1198         // adjust the DB index because we substituting into a binder (it
1199         // tries to be so smart...) resulting in `for<'x> for<'b>
1200         // Bar1<'x,'b>` (we have no syntax for this, so use your
1201         // imagination). Basically the 'x will have DB index of 2 and 'b
1202         // will have DB index of 1. Not quite what we want. So we apply
1203         // the substitution to the *contents* of the trait reference,
1204         // rather than the trait reference itself (put another way, the
1205         // substitution code expects equal binding levels in the values
1206         // from the substitution and the value being substituted into, and
1207         // this trick achieves that).
1208
1209         let substs = &trait_ref.skip_binder().substs;
1210         match *self {
1211             Predicate::Trait(ref binder) =>
1212                 Predicate::Trait(binder.map_bound(|data| data.subst(tcx, substs))),
1213             Predicate::Subtype(ref binder) =>
1214                 Predicate::Subtype(binder.map_bound(|data| data.subst(tcx, substs))),
1215             Predicate::RegionOutlives(ref binder) =>
1216                 Predicate::RegionOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1217             Predicate::TypeOutlives(ref binder) =>
1218                 Predicate::TypeOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1219             Predicate::Projection(ref binder) =>
1220                 Predicate::Projection(binder.map_bound(|data| data.subst(tcx, substs))),
1221             Predicate::WellFormed(data) =>
1222                 Predicate::WellFormed(data.subst(tcx, substs)),
1223             Predicate::ObjectSafe(trait_def_id) =>
1224                 Predicate::ObjectSafe(trait_def_id),
1225             Predicate::ClosureKind(closure_def_id, closure_substs, kind) =>
1226                 Predicate::ClosureKind(closure_def_id, closure_substs.subst(tcx, substs), kind),
1227             Predicate::ConstEvaluatable(def_id, const_substs) =>
1228                 Predicate::ConstEvaluatable(def_id, const_substs.subst(tcx, substs)),
1229         }
1230     }
1231 }
1232
1233 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1234 #[derive(HashStable, TypeFoldable)]
1235 pub struct TraitPredicate<'tcx> {
1236     pub trait_ref: TraitRef<'tcx>
1237 }
1238
1239 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
1240
1241 impl<'tcx> TraitPredicate<'tcx> {
1242     pub fn def_id(&self) -> DefId {
1243         self.trait_ref.def_id
1244     }
1245
1246     pub fn input_types<'a>(&'a self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> + 'a {
1247         self.trait_ref.input_types()
1248     }
1249
1250     pub fn self_ty(&self) -> Ty<'tcx> {
1251         self.trait_ref.self_ty()
1252     }
1253 }
1254
1255 impl<'tcx> PolyTraitPredicate<'tcx> {
1256     pub fn def_id(&self) -> DefId {
1257         // Ok to skip binder since trait `DefId` does not care about regions.
1258         self.skip_binder().def_id()
1259     }
1260 }
1261
1262 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, RustcEncodable, RustcDecodable)]
1263 #[derive(HashStable, TypeFoldable)]
1264 pub struct OutlivesPredicate<A, B>(pub A, pub B); // `A: B`
1265 pub type PolyOutlivesPredicate<A, B> = ty::Binder<OutlivesPredicate<A, B>>;
1266 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>;
1267 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>;
1268 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<RegionOutlivesPredicate<'tcx>>;
1269 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<TypeOutlivesPredicate<'tcx>>;
1270
1271 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
1272 #[derive(HashStable, TypeFoldable)]
1273 pub struct SubtypePredicate<'tcx> {
1274     pub a_is_expected: bool,
1275     pub a: Ty<'tcx>,
1276     pub b: Ty<'tcx>
1277 }
1278 pub type PolySubtypePredicate<'tcx> = ty::Binder<SubtypePredicate<'tcx>>;
1279
1280 /// This kind of predicate has no *direct* correspondent in the
1281 /// syntax, but it roughly corresponds to the syntactic forms:
1282 ///
1283 /// 1. `T: TraitRef<..., Item = Type>`
1284 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
1285 ///
1286 /// In particular, form #1 is "desugared" to the combination of a
1287 /// normal trait predicate (`T: TraitRef<...>`) and one of these
1288 /// predicates. Form #2 is a broader form in that it also permits
1289 /// equality between arbitrary types. Processing an instance of
1290 /// Form #2 eventually yields one of these `ProjectionPredicate`
1291 /// instances to normalize the LHS.
1292 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1293 #[derive(HashStable, TypeFoldable)]
1294 pub struct ProjectionPredicate<'tcx> {
1295     pub projection_ty: ProjectionTy<'tcx>,
1296     pub ty: Ty<'tcx>,
1297 }
1298
1299 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
1300
1301 impl<'tcx> PolyProjectionPredicate<'tcx> {
1302     /// Returns the `DefId` of the associated item being projected.
1303     pub fn item_def_id(&self) -> DefId {
1304         self.skip_binder().projection_ty.item_def_id
1305     }
1306
1307     #[inline]
1308     pub fn to_poly_trait_ref(&self, tcx: TyCtxt<'tcx>) -> PolyTraitRef<'tcx> {
1309         // Note: unlike with `TraitRef::to_poly_trait_ref()`,
1310         // `self.0.trait_ref` is permitted to have escaping regions.
1311         // This is because here `self` has a `Binder` and so does our
1312         // return value, so we are preserving the number of binding
1313         // levels.
1314         self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
1315     }
1316
1317     pub fn ty(&self) -> Binder<Ty<'tcx>> {
1318         self.map_bound(|predicate| predicate.ty)
1319     }
1320
1321     /// The `DefId` of the `TraitItem` for the associated type.
1322     ///
1323     /// Note that this is not the `DefId` of the `TraitRef` containing this
1324     /// associated type, which is in `tcx.associated_item(projection_def_id()).container`.
1325     pub fn projection_def_id(&self) -> DefId {
1326         // Ok to skip binder since trait `DefId` does not care about regions.
1327         self.skip_binder().projection_ty.item_def_id
1328     }
1329 }
1330
1331 pub trait ToPolyTraitRef<'tcx> {
1332     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
1333 }
1334
1335 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
1336     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1337         ty::Binder::dummy(self.clone())
1338     }
1339 }
1340
1341 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
1342     fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1343         self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
1344     }
1345 }
1346
1347 pub trait ToPredicate<'tcx> {
1348     fn to_predicate(&self) -> Predicate<'tcx>;
1349 }
1350
1351 impl<'tcx> ToPredicate<'tcx> for TraitRef<'tcx> {
1352     fn to_predicate(&self) -> Predicate<'tcx> {
1353         ty::Predicate::Trait(ty::Binder::dummy(ty::TraitPredicate {
1354             trait_ref: self.clone()
1355         }))
1356     }
1357 }
1358
1359 impl<'tcx> ToPredicate<'tcx> for PolyTraitRef<'tcx> {
1360     fn to_predicate(&self) -> Predicate<'tcx> {
1361         ty::Predicate::Trait(self.to_poly_trait_predicate())
1362     }
1363 }
1364
1365 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1366     fn to_predicate(&self) -> Predicate<'tcx> {
1367         Predicate::RegionOutlives(self.clone())
1368     }
1369 }
1370
1371 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1372     fn to_predicate(&self) -> Predicate<'tcx> {
1373         Predicate::TypeOutlives(self.clone())
1374     }
1375 }
1376
1377 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1378     fn to_predicate(&self) -> Predicate<'tcx> {
1379         Predicate::Projection(self.clone())
1380     }
1381 }
1382
1383 // A custom iterator used by `Predicate::walk_tys`.
1384 enum WalkTysIter<'tcx, I, J, K>
1385     where I: Iterator<Item = Ty<'tcx>>,
1386           J: Iterator<Item = Ty<'tcx>>,
1387           K: Iterator<Item = Ty<'tcx>>
1388 {
1389     None,
1390     One(Ty<'tcx>),
1391     Two(Ty<'tcx>, Ty<'tcx>),
1392     Types(I),
1393     InputTypes(J),
1394     ProjectionTypes(K)
1395 }
1396
1397 impl<'tcx, I, J, K> Iterator for WalkTysIter<'tcx, I, J, K>
1398     where I: Iterator<Item = Ty<'tcx>>,
1399           J: Iterator<Item = Ty<'tcx>>,
1400           K: Iterator<Item = Ty<'tcx>>
1401 {
1402     type Item = Ty<'tcx>;
1403
1404     fn next(&mut self) -> Option<Ty<'tcx>> {
1405         match *self {
1406             WalkTysIter::None => None,
1407             WalkTysIter::One(item) => {
1408                 *self = WalkTysIter::None;
1409                 Some(item)
1410             },
1411             WalkTysIter::Two(item1, item2) => {
1412                 *self = WalkTysIter::One(item2);
1413                 Some(item1)
1414             },
1415             WalkTysIter::Types(ref mut iter) => {
1416                 iter.next()
1417             },
1418             WalkTysIter::InputTypes(ref mut iter) => {
1419                 iter.next()
1420             },
1421             WalkTysIter::ProjectionTypes(ref mut iter) => {
1422                 iter.next()
1423             }
1424         }
1425     }
1426 }
1427
1428 impl<'tcx> Predicate<'tcx> {
1429     /// Iterates over the types in this predicate. Note that in all
1430     /// cases this is skipping over a binder, so late-bound regions
1431     /// with depth 0 are bound by the predicate.
1432     pub fn walk_tys(&'a self) -> impl Iterator<Item = Ty<'tcx>> + 'a {
1433         match *self {
1434             ty::Predicate::Trait(ref data) => {
1435                 WalkTysIter::InputTypes(data.skip_binder().input_types())
1436             }
1437             ty::Predicate::Subtype(binder) => {
1438                 let SubtypePredicate { a, b, a_is_expected: _ } = binder.skip_binder();
1439                 WalkTysIter::Two(a, b)
1440             }
1441             ty::Predicate::TypeOutlives(binder) => {
1442                 WalkTysIter::One(binder.skip_binder().0)
1443             }
1444             ty::Predicate::RegionOutlives(..) => {
1445                 WalkTysIter::None
1446             }
1447             ty::Predicate::Projection(ref data) => {
1448                 let inner = data.skip_binder();
1449                 WalkTysIter::ProjectionTypes(
1450                     inner.projection_ty.substs.types().chain(Some(inner.ty)))
1451             }
1452             ty::Predicate::WellFormed(data) => {
1453                 WalkTysIter::One(data)
1454             }
1455             ty::Predicate::ObjectSafe(_trait_def_id) => {
1456                 WalkTysIter::None
1457             }
1458             ty::Predicate::ClosureKind(_closure_def_id, closure_substs, _kind) => {
1459                 WalkTysIter::Types(closure_substs.types())
1460             }
1461             ty::Predicate::ConstEvaluatable(_, substs) => {
1462                 WalkTysIter::Types(substs.types())
1463             }
1464         }
1465     }
1466
1467     pub fn to_opt_poly_trait_ref(&self) -> Option<PolyTraitRef<'tcx>> {
1468         match *self {
1469             Predicate::Trait(ref t) => {
1470                 Some(t.to_poly_trait_ref())
1471             }
1472             Predicate::Projection(..) |
1473             Predicate::Subtype(..) |
1474             Predicate::RegionOutlives(..) |
1475             Predicate::WellFormed(..) |
1476             Predicate::ObjectSafe(..) |
1477             Predicate::ClosureKind(..) |
1478             Predicate::TypeOutlives(..) |
1479             Predicate::ConstEvaluatable(..) => {
1480                 None
1481             }
1482         }
1483     }
1484
1485     pub fn to_opt_type_outlives(&self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1486         match *self {
1487             Predicate::TypeOutlives(data) => {
1488                 Some(data)
1489             }
1490             Predicate::Trait(..) |
1491             Predicate::Projection(..) |
1492             Predicate::Subtype(..) |
1493             Predicate::RegionOutlives(..) |
1494             Predicate::WellFormed(..) |
1495             Predicate::ObjectSafe(..) |
1496             Predicate::ClosureKind(..) |
1497             Predicate::ConstEvaluatable(..) => {
1498                 None
1499             }
1500         }
1501     }
1502 }
1503
1504 /// Represents the bounds declared on a particular set of type
1505 /// parameters. Should eventually be generalized into a flag list of
1506 /// where-clauses. You can obtain a `InstantiatedPredicates` list from a
1507 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1508 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1509 /// the `GenericPredicates` are expressed in terms of the bound type
1510 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1511 /// represented a set of bounds for some particular instantiation,
1512 /// meaning that the generic parameters have been substituted with
1513 /// their values.
1514 ///
1515 /// Example:
1516 ///
1517 ///     struct Foo<T, U: Bar<T>> { ... }
1518 ///
1519 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1520 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1521 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1522 /// [usize:Bar<isize>]]`.
1523 #[derive(Clone, Debug, TypeFoldable)]
1524 pub struct InstantiatedPredicates<'tcx> {
1525     pub predicates: Vec<Predicate<'tcx>>,
1526 }
1527
1528 impl<'tcx> InstantiatedPredicates<'tcx> {
1529     pub fn empty() -> InstantiatedPredicates<'tcx> {
1530         InstantiatedPredicates { predicates: vec![] }
1531     }
1532
1533     pub fn is_empty(&self) -> bool {
1534         self.predicates.is_empty()
1535     }
1536 }
1537
1538 rustc_index::newtype_index! {
1539     /// "Universes" are used during type- and trait-checking in the
1540     /// presence of `for<..>` binders to control what sets of names are
1541     /// visible. Universes are arranged into a tree: the root universe
1542     /// contains names that are always visible. Each child then adds a new
1543     /// set of names that are visible, in addition to those of its parent.
1544     /// We say that the child universe "extends" the parent universe with
1545     /// new names.
1546     ///
1547     /// To make this more concrete, consider this program:
1548     ///
1549     /// ```
1550     /// struct Foo { }
1551     /// fn bar<T>(x: T) {
1552     ///   let y: for<'a> fn(&'a u8, Foo) = ...;
1553     /// }
1554     /// ```
1555     ///
1556     /// The struct name `Foo` is in the root universe U0. But the type
1557     /// parameter `T`, introduced on `bar`, is in an extended universe U1
1558     /// -- i.e., within `bar`, we can name both `T` and `Foo`, but outside
1559     /// of `bar`, we cannot name `T`. Then, within the type of `y`, the
1560     /// region `'a` is in a universe U2 that extends U1, because we can
1561     /// name it inside the fn type but not outside.
1562     ///
1563     /// Universes are used to do type- and trait-checking around these
1564     /// "forall" binders (also called **universal quantification**). The
1565     /// idea is that when, in the body of `bar`, we refer to `T` as a
1566     /// type, we aren't referring to any type in particular, but rather a
1567     /// kind of "fresh" type that is distinct from all other types we have
1568     /// actually declared. This is called a **placeholder** type, and we
1569     /// use universes to talk about this. In other words, a type name in
1570     /// universe 0 always corresponds to some "ground" type that the user
1571     /// declared, but a type name in a non-zero universe is a placeholder
1572     /// type -- an idealized representative of "types in general" that we
1573     /// use for checking generic functions.
1574     pub struct UniverseIndex {
1575         derive [HashStable]
1576         DEBUG_FORMAT = "U{}",
1577     }
1578 }
1579
1580 impl UniverseIndex {
1581     pub const ROOT: UniverseIndex = UniverseIndex::from_u32_const(0);
1582
1583     /// Returns the "next" universe index in order -- this new index
1584     /// is considered to extend all previous universes. This
1585     /// corresponds to entering a `forall` quantifier. So, for
1586     /// example, suppose we have this type in universe `U`:
1587     ///
1588     /// ```
1589     /// for<'a> fn(&'a u32)
1590     /// ```
1591     ///
1592     /// Once we "enter" into this `for<'a>` quantifier, we are in a
1593     /// new universe that extends `U` -- in this new universe, we can
1594     /// name the region `'a`, but that region was not nameable from
1595     /// `U` because it was not in scope there.
1596     pub fn next_universe(self) -> UniverseIndex {
1597         UniverseIndex::from_u32(self.private.checked_add(1).unwrap())
1598     }
1599
1600     /// Returns `true` if `self` can name a name from `other` -- in other words,
1601     /// if the set of names in `self` is a superset of those in
1602     /// `other` (`self >= other`).
1603     pub fn can_name(self, other: UniverseIndex) -> bool {
1604         self.private >= other.private
1605     }
1606
1607     /// Returns `true` if `self` cannot name some names from `other` -- in other
1608     /// words, if the set of names in `self` is a strict subset of
1609     /// those in `other` (`self < other`).
1610     pub fn cannot_name(self, other: UniverseIndex) -> bool {
1611         self.private < other.private
1612     }
1613 }
1614
1615 /// The "placeholder index" fully defines a placeholder region.
1616 /// Placeholder regions are identified by both a **universe** as well
1617 /// as a "bound-region" within that universe. The `bound_region` is
1618 /// basically a name -- distinct bound regions within the same
1619 /// universe are just two regions with an unknown relationship to one
1620 /// another.
1621 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, PartialOrd, Ord)]
1622 pub struct Placeholder<T> {
1623     pub universe: UniverseIndex,
1624     pub name: T,
1625 }
1626
1627 impl<'a, T> HashStable<StableHashingContext<'a>> for Placeholder<T>
1628 where
1629     T: HashStable<StableHashingContext<'a>>,
1630 {
1631     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1632         self.universe.hash_stable(hcx, hasher);
1633         self.name.hash_stable(hcx, hasher);
1634     }
1635 }
1636
1637 pub type PlaceholderRegion = Placeholder<BoundRegion>;
1638
1639 pub type PlaceholderType = Placeholder<BoundVar>;
1640
1641 pub type PlaceholderConst = Placeholder<BoundVar>;
1642
1643 /// When type checking, we use the `ParamEnv` to track
1644 /// details about the set of where-clauses that are in scope at this
1645 /// particular point.
1646 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable, TypeFoldable)]
1647 pub struct ParamEnv<'tcx> {
1648     /// `Obligation`s that the caller must satisfy. This is basically
1649     /// the set of bounds on the in-scope type parameters, translated
1650     /// into `Obligation`s, and elaborated and normalized.
1651     pub caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1652
1653     /// Typically, this is `Reveal::UserFacing`, but during codegen we
1654     /// want `Reveal::All` -- note that this is always paired with an
1655     /// empty environment. To get that, use `ParamEnv::reveal()`.
1656     pub reveal: traits::Reveal,
1657
1658     /// If this `ParamEnv` comes from a call to `tcx.param_env(def_id)`,
1659     /// register that `def_id` (useful for transitioning to the chalk trait
1660     /// solver).
1661     pub def_id: Option<DefId>,
1662 }
1663
1664 impl<'tcx> ParamEnv<'tcx> {
1665     /// Construct a trait environment suitable for contexts where
1666     /// there are no where-clauses in scope. Hidden types (like `impl
1667     /// Trait`) are left hidden, so this is suitable for ordinary
1668     /// type-checking.
1669     #[inline]
1670     pub fn empty() -> Self {
1671         Self::new(List::empty(), Reveal::UserFacing, None)
1672     }
1673
1674     /// Construct a trait environment with no where-clauses in scope
1675     /// where the values of all `impl Trait` and other hidden types
1676     /// are revealed. This is suitable for monomorphized, post-typeck
1677     /// environments like codegen or doing optimizations.
1678     ///
1679     /// N.B., if you want to have predicates in scope, use `ParamEnv::new`,
1680     /// or invoke `param_env.with_reveal_all()`.
1681     #[inline]
1682     pub fn reveal_all() -> Self {
1683         Self::new(List::empty(), Reveal::All, None)
1684     }
1685
1686     /// Construct a trait environment with the given set of predicates.
1687     #[inline]
1688     pub fn new(
1689         caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1690         reveal: Reveal,
1691         def_id: Option<DefId>
1692     ) -> Self {
1693         ty::ParamEnv { caller_bounds, reveal, def_id }
1694     }
1695
1696     /// Returns a new parameter environment with the same clauses, but
1697     /// which "reveals" the true results of projections in all cases
1698     /// (even for associated types that are specializable). This is
1699     /// the desired behavior during codegen and certain other special
1700     /// contexts; normally though we want to use `Reveal::UserFacing`,
1701     /// which is the default.
1702     pub fn with_reveal_all(self) -> Self {
1703         ty::ParamEnv { reveal: Reveal::All, ..self }
1704     }
1705
1706     /// Returns this same environment but with no caller bounds.
1707     pub fn without_caller_bounds(self) -> Self {
1708         ty::ParamEnv { caller_bounds: List::empty(), ..self }
1709     }
1710
1711     /// Creates a suitable environment in which to perform trait
1712     /// queries on the given value. When type-checking, this is simply
1713     /// the pair of the environment plus value. But when reveal is set to
1714     /// All, then if `value` does not reference any type parameters, we will
1715     /// pair it with the empty environment. This improves caching and is generally
1716     /// invisible.
1717     ///
1718     /// N.B., we preserve the environment when type-checking because it
1719     /// is possible for the user to have wacky where-clauses like
1720     /// `where Box<u32>: Copy`, which are clearly never
1721     /// satisfiable. We generally want to behave as if they were true,
1722     /// although the surrounding function is never reachable.
1723     pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
1724         match self.reveal {
1725             Reveal::UserFacing => {
1726                 ParamEnvAnd {
1727                     param_env: self,
1728                     value,
1729                 }
1730             }
1731
1732             Reveal::All => {
1733                 if value.has_placeholders()
1734                     || value.needs_infer()
1735                     || value.has_param_types()
1736                 {
1737                     ParamEnvAnd {
1738                         param_env: self,
1739                         value,
1740                     }
1741                 } else {
1742                     ParamEnvAnd {
1743                         param_env: self.without_caller_bounds(),
1744                         value,
1745                     }
1746                 }
1747             }
1748         }
1749     }
1750 }
1751
1752 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TypeFoldable)]
1753 pub struct ParamEnvAnd<'tcx, T> {
1754     pub param_env: ParamEnv<'tcx>,
1755     pub value: T,
1756 }
1757
1758 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
1759     pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
1760         (self.param_env, self.value)
1761     }
1762 }
1763
1764 impl<'a, 'tcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'tcx, T>
1765 where
1766     T: HashStable<StableHashingContext<'a>>,
1767 {
1768     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1769         let ParamEnvAnd {
1770             ref param_env,
1771             ref value
1772         } = *self;
1773
1774         param_env.hash_stable(hcx, hasher);
1775         value.hash_stable(hcx, hasher);
1776     }
1777 }
1778
1779 #[derive(Copy, Clone, Debug, HashStable)]
1780 pub struct Destructor {
1781     /// The `DefId` of the destructor method
1782     pub did: DefId,
1783 }
1784
1785 bitflags! {
1786     #[derive(HashStable)]
1787     pub struct AdtFlags: u32 {
1788         const NO_ADT_FLAGS        = 0;
1789         /// Indicates whether the ADT is an enum.
1790         const IS_ENUM             = 1 << 0;
1791         /// Indicates whether the ADT is a union.
1792         const IS_UNION            = 1 << 1;
1793         /// Indicates whether the ADT is a struct.
1794         const IS_STRUCT           = 1 << 2;
1795         /// Indicates whether the ADT is a struct and has a constructor.
1796         const HAS_CTOR            = 1 << 3;
1797         /// Indicates whether the type is a `PhantomData`.
1798         const IS_PHANTOM_DATA     = 1 << 4;
1799         /// Indicates whether the type has a `#[fundamental]` attribute.
1800         const IS_FUNDAMENTAL      = 1 << 5;
1801         /// Indicates whether the type is a `Box`.
1802         const IS_BOX              = 1 << 6;
1803         /// Indicates whether the type is an `Arc`.
1804         const IS_ARC              = 1 << 7;
1805         /// Indicates whether the type is an `Rc`.
1806         const IS_RC               = 1 << 8;
1807         /// Indicates whether the variant list of this ADT is `#[non_exhaustive]`.
1808         /// (i.e., this flag is never set unless this ADT is an enum).
1809         const IS_VARIANT_LIST_NON_EXHAUSTIVE = 1 << 9;
1810     }
1811 }
1812
1813 bitflags! {
1814     #[derive(HashStable)]
1815     pub struct VariantFlags: u32 {
1816         const NO_VARIANT_FLAGS        = 0;
1817         /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
1818         const IS_FIELD_LIST_NON_EXHAUSTIVE = 1 << 0;
1819     }
1820 }
1821
1822 /// Definition of a variant -- a struct's fields or a enum variant.
1823 #[derive(Debug, HashStable)]
1824 pub struct VariantDef {
1825     /// `DefId` that identifies the variant itself.
1826     /// If this variant belongs to a struct or union, then this is a copy of its `DefId`.
1827     pub def_id: DefId,
1828     /// `DefId` that identifies the variant's constructor.
1829     /// If this variant is a struct variant, then this is `None`.
1830     pub ctor_def_id: Option<DefId>,
1831     /// Variant or struct name.
1832     #[stable_hasher(project(name))]
1833     pub ident: Ident,
1834     /// Discriminant of this variant.
1835     pub discr: VariantDiscr,
1836     /// Fields of this variant.
1837     pub fields: Vec<FieldDef>,
1838     /// Type of constructor of variant.
1839     pub ctor_kind: CtorKind,
1840     /// Flags of the variant (e.g. is field list non-exhaustive)?
1841     flags: VariantFlags,
1842     /// Variant is obtained as part of recovering from a syntactic error.
1843     /// May be incomplete or bogus.
1844     pub recovered: bool,
1845 }
1846
1847 impl<'tcx> VariantDef {
1848     /// Creates a new `VariantDef`.
1849     ///
1850     /// `variant_did` is the `DefId` that identifies the enum variant (if this `VariantDef`
1851     /// represents an enum variant).
1852     ///
1853     /// `ctor_did` is the `DefId` that identifies the constructor of unit or
1854     /// tuple-variants/structs. If this is a `struct`-variant then this should be `None`.
1855     ///
1856     /// `parent_did` is the `DefId` of the `AdtDef` representing the enum or struct that
1857     /// owns this variant. It is used for checking if a struct has `#[non_exhaustive]` w/out having
1858     /// to go through the redirect of checking the ctor's attributes - but compiling a small crate
1859     /// requires loading the `AdtDef`s for all the structs in the universe (e.g., coherence for any
1860     /// built-in trait), and we do not want to load attributes twice.
1861     ///
1862     /// If someone speeds up attribute loading to not be a performance concern, they can
1863     /// remove this hack and use the constructor `DefId` everywhere.
1864     pub fn new(
1865         tcx: TyCtxt<'tcx>,
1866         ident: Ident,
1867         variant_did: Option<DefId>,
1868         ctor_def_id: Option<DefId>,
1869         discr: VariantDiscr,
1870         fields: Vec<FieldDef>,
1871         ctor_kind: CtorKind,
1872         adt_kind: AdtKind,
1873         parent_did: DefId,
1874         recovered: bool,
1875     ) -> Self {
1876         debug!(
1877             "VariantDef::new(ident = {:?}, variant_did = {:?}, ctor_def_id = {:?}, discr = {:?},
1878              fields = {:?}, ctor_kind = {:?}, adt_kind = {:?}, parent_did = {:?})",
1879              ident, variant_did, ctor_def_id, discr, fields, ctor_kind, adt_kind, parent_did,
1880         );
1881
1882         let mut flags = VariantFlags::NO_VARIANT_FLAGS;
1883         if adt_kind == AdtKind::Struct && tcx.has_attr(parent_did, sym::non_exhaustive) {
1884             debug!("found non-exhaustive field list for {:?}", parent_did);
1885             flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1886         } else if let Some(variant_did) = variant_did {
1887             if tcx.has_attr(variant_did, sym::non_exhaustive) {
1888                 debug!("found non-exhaustive field list for {:?}", variant_did);
1889                 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1890             }
1891         }
1892
1893         VariantDef {
1894             def_id: variant_did.unwrap_or(parent_did),
1895             ctor_def_id,
1896             ident,
1897             discr,
1898             fields,
1899             ctor_kind,
1900             flags,
1901             recovered,
1902         }
1903     }
1904
1905     /// Is this field list non-exhaustive?
1906     #[inline]
1907     pub fn is_field_list_non_exhaustive(&self) -> bool {
1908         self.flags.intersects(VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE)
1909     }
1910 }
1911
1912 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable, HashStable)]
1913 pub enum VariantDiscr {
1914     /// Explicit value for this variant, i.e., `X = 123`.
1915     /// The `DefId` corresponds to the embedded constant.
1916     Explicit(DefId),
1917
1918     /// The previous variant's discriminant plus one.
1919     /// For efficiency reasons, the distance from the
1920     /// last `Explicit` discriminant is being stored,
1921     /// or `0` for the first variant, if it has none.
1922     Relative(u32),
1923 }
1924
1925 #[derive(Debug, HashStable)]
1926 pub struct FieldDef {
1927     pub did: DefId,
1928     #[stable_hasher(project(name))]
1929     pub ident: Ident,
1930     pub vis: Visibility,
1931 }
1932
1933 /// The definition of a user-defined type, e.g., a `struct`, `enum`, or `union`.
1934 ///
1935 /// These are all interned (by `intern_adt_def`) into the `adt_defs` table.
1936 ///
1937 /// The initialism *ADT* stands for an [*algebraic data type (ADT)*][adt].
1938 /// This is slightly wrong because `union`s are not ADTs.
1939 /// Moreover, Rust only allows recursive data types through indirection.
1940 ///
1941 /// [adt]: https://en.wikipedia.org/wiki/Algebraic_data_type
1942 pub struct AdtDef {
1943     /// The `DefId` of the struct, enum or union item.
1944     pub did: DefId,
1945     /// Variants of the ADT. If this is a struct or union, then there will be a single variant.
1946     pub variants: IndexVec<self::layout::VariantIdx, VariantDef>,
1947     /// Flags of the ADT (e.g., is this a struct? is this non-exhaustive?).
1948     flags: AdtFlags,
1949     /// Repr options provided by the user.
1950     pub repr: ReprOptions,
1951 }
1952
1953 impl PartialOrd for AdtDef {
1954     fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering> {
1955         Some(self.cmp(&other))
1956     }
1957 }
1958
1959 /// There should be only one AdtDef for each `did`, therefore
1960 /// it is fine to implement `Ord` only based on `did`.
1961 impl Ord for AdtDef {
1962     fn cmp(&self, other: &AdtDef) -> Ordering {
1963         self.did.cmp(&other.did)
1964     }
1965 }
1966
1967 impl PartialEq for AdtDef {
1968     // `AdtDef`s are always interned, and this is part of `TyS` equality.
1969     #[inline]
1970     fn eq(&self, other: &Self) -> bool { ptr::eq(self, other) }
1971 }
1972
1973 impl Eq for AdtDef {}
1974
1975 impl Hash for AdtDef {
1976     #[inline]
1977     fn hash<H: Hasher>(&self, s: &mut H) {
1978         (self as *const AdtDef).hash(s)
1979     }
1980 }
1981
1982 impl<'tcx> rustc_serialize::UseSpecializedEncodable for &'tcx AdtDef {
1983     fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1984         self.did.encode(s)
1985     }
1986 }
1987
1988 impl<'tcx> rustc_serialize::UseSpecializedDecodable for &'tcx AdtDef {}
1989
1990 impl<'a> HashStable<StableHashingContext<'a>> for AdtDef {
1991     fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1992         thread_local! {
1993             static CACHE: RefCell<FxHashMap<usize, Fingerprint>> = Default::default();
1994         }
1995
1996         let hash: Fingerprint = CACHE.with(|cache| {
1997             let addr = self as *const AdtDef as usize;
1998             *cache.borrow_mut().entry(addr).or_insert_with(|| {
1999                 let ty::AdtDef {
2000                     did,
2001                     ref variants,
2002                     ref flags,
2003                     ref repr,
2004                 } = *self;
2005
2006                 let mut hasher = StableHasher::new();
2007                 did.hash_stable(hcx, &mut hasher);
2008                 variants.hash_stable(hcx, &mut hasher);
2009                 flags.hash_stable(hcx, &mut hasher);
2010                 repr.hash_stable(hcx, &mut hasher);
2011
2012                 hasher.finish()
2013            })
2014         });
2015
2016         hash.hash_stable(hcx, hasher);
2017     }
2018 }
2019
2020 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
2021 pub enum AdtKind { Struct, Union, Enum }
2022
2023 impl Into<DataTypeKind> for AdtKind {
2024     fn into(self) -> DataTypeKind {
2025         match self {
2026             AdtKind::Struct => DataTypeKind::Struct,
2027             AdtKind::Union => DataTypeKind::Union,
2028             AdtKind::Enum => DataTypeKind::Enum,
2029         }
2030     }
2031 }
2032
2033 bitflags! {
2034     #[derive(RustcEncodable, RustcDecodable, Default, HashStable)]
2035     pub struct ReprFlags: u8 {
2036         const IS_C               = 1 << 0;
2037         const IS_SIMD            = 1 << 1;
2038         const IS_TRANSPARENT     = 1 << 2;
2039         // Internal only for now. If true, don't reorder fields.
2040         const IS_LINEAR          = 1 << 3;
2041
2042         // Any of these flags being set prevent field reordering optimisation.
2043         const IS_UNOPTIMISABLE   = ReprFlags::IS_C.bits |
2044                                    ReprFlags::IS_SIMD.bits |
2045                                    ReprFlags::IS_LINEAR.bits;
2046     }
2047 }
2048
2049 /// Represents the repr options provided by the user,
2050 #[derive(Copy, Clone, Debug, Eq, PartialEq, RustcEncodable, RustcDecodable,
2051          Default, HashStable)]
2052 pub struct ReprOptions {
2053     pub int: Option<attr::IntType>,
2054     pub align: Option<Align>,
2055     pub pack: Option<Align>,
2056     pub flags: ReprFlags,
2057 }
2058
2059 impl ReprOptions {
2060     pub fn new(tcx: TyCtxt<'_>, did: DefId) -> ReprOptions {
2061         let mut flags = ReprFlags::empty();
2062         let mut size = None;
2063         let mut max_align: Option<Align> = None;
2064         let mut min_pack: Option<Align> = None;
2065         for attr in tcx.get_attrs(did).iter() {
2066             for r in attr::find_repr_attrs(&tcx.sess.parse_sess, attr) {
2067                 flags.insert(match r {
2068                     attr::ReprC => ReprFlags::IS_C,
2069                     attr::ReprPacked(pack) => {
2070                         let pack = Align::from_bytes(pack as u64).unwrap();
2071                         min_pack = Some(if let Some(min_pack) = min_pack {
2072                             min_pack.min(pack)
2073                         } else {
2074                             pack
2075                         });
2076                         ReprFlags::empty()
2077                     },
2078                     attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
2079                     attr::ReprSimd => ReprFlags::IS_SIMD,
2080                     attr::ReprInt(i) => {
2081                         size = Some(i);
2082                         ReprFlags::empty()
2083                     },
2084                     attr::ReprAlign(align) => {
2085                         max_align = max_align.max(Some(Align::from_bytes(align as u64).unwrap()));
2086                         ReprFlags::empty()
2087                     },
2088                 });
2089             }
2090         }
2091
2092         // This is here instead of layout because the choice must make it into metadata.
2093         if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.def_path_str(did))) {
2094             flags.insert(ReprFlags::IS_LINEAR);
2095         }
2096         ReprOptions { int: size, align: max_align, pack: min_pack, flags: flags }
2097     }
2098
2099     #[inline]
2100     pub fn simd(&self) -> bool { self.flags.contains(ReprFlags::IS_SIMD) }
2101     #[inline]
2102     pub fn c(&self) -> bool { self.flags.contains(ReprFlags::IS_C) }
2103     #[inline]
2104     pub fn packed(&self) -> bool { self.pack.is_some() }
2105     #[inline]
2106     pub fn transparent(&self) -> bool { self.flags.contains(ReprFlags::IS_TRANSPARENT) }
2107     #[inline]
2108     pub fn linear(&self) -> bool { self.flags.contains(ReprFlags::IS_LINEAR) }
2109
2110     pub fn discr_type(&self) -> attr::IntType {
2111         self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
2112     }
2113
2114     /// Returns `true` if this `#[repr()]` should inhabit "smart enum
2115     /// layout" optimizations, such as representing `Foo<&T>` as a
2116     /// single pointer.
2117     pub fn inhibit_enum_layout_opt(&self) -> bool {
2118         self.c() || self.int.is_some()
2119     }
2120
2121     /// Returns `true` if this `#[repr()]` should inhibit struct field reordering
2122     /// optimizations, such as with `repr(C)`, `repr(packed(1))`, or `repr(<int>)`.
2123     pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
2124         if let Some(pack) = self.pack {
2125             if pack.bytes() == 1 {
2126                 return true;
2127             }
2128         }
2129         self.flags.intersects(ReprFlags::IS_UNOPTIMISABLE) || self.int.is_some()
2130     }
2131
2132     /// Returns `true` if this `#[repr()]` should inhibit union ABI optimisations.
2133     pub fn inhibit_union_abi_opt(&self) -> bool {
2134         self.c()
2135     }
2136 }
2137
2138 impl<'tcx> AdtDef {
2139     /// Creates a new `AdtDef`.
2140     fn new(
2141         tcx: TyCtxt<'_>,
2142         did: DefId,
2143         kind: AdtKind,
2144         variants: IndexVec<VariantIdx, VariantDef>,
2145         repr: ReprOptions,
2146     ) -> Self {
2147         debug!("AdtDef::new({:?}, {:?}, {:?}, {:?})", did, kind, variants, repr);
2148         let mut flags = AdtFlags::NO_ADT_FLAGS;
2149
2150         if kind == AdtKind::Enum && tcx.has_attr(did, sym::non_exhaustive) {
2151             debug!("found non-exhaustive variant list for {:?}", did);
2152             flags = flags | AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE;
2153         }
2154
2155         flags |= match kind {
2156             AdtKind::Enum => AdtFlags::IS_ENUM,
2157             AdtKind::Union => AdtFlags::IS_UNION,
2158             AdtKind::Struct => AdtFlags::IS_STRUCT,
2159         };
2160
2161         if kind == AdtKind::Struct && variants[VariantIdx::new(0)].ctor_def_id.is_some() {
2162             flags |= AdtFlags::HAS_CTOR;
2163         }
2164
2165         let attrs = tcx.get_attrs(did);
2166         if attr::contains_name(&attrs, sym::fundamental) {
2167             flags |= AdtFlags::IS_FUNDAMENTAL;
2168         }
2169         if Some(did) == tcx.lang_items().phantom_data() {
2170             flags |= AdtFlags::IS_PHANTOM_DATA;
2171         }
2172         if Some(did) == tcx.lang_items().owned_box() {
2173             flags |= AdtFlags::IS_BOX;
2174         }
2175         if Some(did) == tcx.lang_items().arc() {
2176             flags |= AdtFlags::IS_ARC;
2177         }
2178         if Some(did) == tcx.lang_items().rc() {
2179             flags |= AdtFlags::IS_RC;
2180         }
2181
2182         AdtDef {
2183             did,
2184             variants,
2185             flags,
2186             repr,
2187         }
2188     }
2189
2190     /// Returns `true` if this is a struct.
2191     #[inline]
2192     pub fn is_struct(&self) -> bool {
2193         self.flags.contains(AdtFlags::IS_STRUCT)
2194     }
2195
2196     /// Returns `true` if this is a union.
2197     #[inline]
2198     pub fn is_union(&self) -> bool {
2199         self.flags.contains(AdtFlags::IS_UNION)
2200     }
2201
2202     /// Returns `true` if this is a enum.
2203     #[inline]
2204     pub fn is_enum(&self) -> bool {
2205         self.flags.contains(AdtFlags::IS_ENUM)
2206     }
2207
2208     /// Returns `true` if the variant list of this ADT is `#[non_exhaustive]`.
2209     #[inline]
2210     pub fn is_variant_list_non_exhaustive(&self) -> bool {
2211         self.flags.contains(AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE)
2212     }
2213
2214     /// Returns the kind of the ADT.
2215     #[inline]
2216     pub fn adt_kind(&self) -> AdtKind {
2217         if self.is_enum() {
2218             AdtKind::Enum
2219         } else if self.is_union() {
2220             AdtKind::Union
2221         } else {
2222             AdtKind::Struct
2223         }
2224     }
2225
2226     /// Returns a description of this abstract data type.
2227     pub fn descr(&self) -> &'static str {
2228         match self.adt_kind() {
2229             AdtKind::Struct => "struct",
2230             AdtKind::Union => "union",
2231             AdtKind::Enum => "enum",
2232         }
2233     }
2234
2235     /// Returns a description of a variant of this abstract data type.
2236     #[inline]
2237     pub fn variant_descr(&self) -> &'static str {
2238         match self.adt_kind() {
2239             AdtKind::Struct => "struct",
2240             AdtKind::Union => "union",
2241             AdtKind::Enum => "variant",
2242         }
2243     }
2244
2245     /// If this function returns `true`, it implies that `is_struct` must return `true`.
2246     #[inline]
2247     pub fn has_ctor(&self) -> bool {
2248         self.flags.contains(AdtFlags::HAS_CTOR)
2249     }
2250
2251     /// Returns `true` if this type is `#[fundamental]` for the purposes
2252     /// of coherence checking.
2253     #[inline]
2254     pub fn is_fundamental(&self) -> bool {
2255         self.flags.contains(AdtFlags::IS_FUNDAMENTAL)
2256     }
2257
2258     /// Returns `true` if this is `PhantomData<T>`.
2259     #[inline]
2260     pub fn is_phantom_data(&self) -> bool {
2261         self.flags.contains(AdtFlags::IS_PHANTOM_DATA)
2262     }
2263
2264     /// Returns `true` if this is `Arc<T>`.
2265     pub fn is_arc(&self) -> bool {
2266         self.flags.contains(AdtFlags::IS_ARC)
2267     }
2268
2269     /// Returns `true` if this is `Rc<T>`.
2270     pub fn is_rc(&self) -> bool {
2271         self.flags.contains(AdtFlags::IS_RC)
2272     }
2273
2274     /// Returns `true` if this is Box<T>.
2275     #[inline]
2276     pub fn is_box(&self) -> bool {
2277         self.flags.contains(AdtFlags::IS_BOX)
2278     }
2279
2280     /// Returns `true` if this type has a destructor.
2281     pub fn has_dtor(&self, tcx: TyCtxt<'tcx>) -> bool {
2282         self.destructor(tcx).is_some()
2283     }
2284
2285     /// Asserts this is a struct or union and returns its unique variant.
2286     pub fn non_enum_variant(&self) -> &VariantDef {
2287         assert!(self.is_struct() || self.is_union());
2288         &self.variants[VariantIdx::new(0)]
2289     }
2290
2291     #[inline]
2292     pub fn predicates(&self, tcx: TyCtxt<'tcx>) -> GenericPredicates<'tcx> {
2293         tcx.predicates_of(self.did)
2294     }
2295
2296     /// Returns an iterator over all fields contained
2297     /// by this ADT.
2298     #[inline]
2299     pub fn all_fields(&self) -> impl Iterator<Item=&FieldDef> + Clone {
2300         self.variants.iter().flat_map(|v| v.fields.iter())
2301     }
2302
2303     pub fn is_payloadfree(&self) -> bool {
2304         !self.variants.is_empty() &&
2305             self.variants.iter().all(|v| v.fields.is_empty())
2306     }
2307
2308     /// Return a `VariantDef` given a variant id.
2309     pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
2310         self.variants.iter().find(|v| v.def_id == vid)
2311             .expect("variant_with_id: unknown variant")
2312     }
2313
2314     /// Return a `VariantDef` given a constructor id.
2315     pub fn variant_with_ctor_id(&self, cid: DefId) -> &VariantDef {
2316         self.variants.iter().find(|v| v.ctor_def_id == Some(cid))
2317             .expect("variant_with_ctor_id: unknown variant")
2318     }
2319
2320     /// Return the index of `VariantDef` given a variant id.
2321     pub fn variant_index_with_id(&self, vid: DefId) -> VariantIdx {
2322         self.variants.iter_enumerated().find(|(_, v)| v.def_id == vid)
2323             .expect("variant_index_with_id: unknown variant").0
2324     }
2325
2326     /// Return the index of `VariantDef` given a constructor id.
2327     pub fn variant_index_with_ctor_id(&self, cid: DefId) -> VariantIdx {
2328         self.variants.iter_enumerated().find(|(_, v)| v.ctor_def_id == Some(cid))
2329             .expect("variant_index_with_ctor_id: unknown variant").0
2330     }
2331
2332     pub fn variant_of_res(&self, res: Res) -> &VariantDef {
2333         match res {
2334             Res::Def(DefKind::Variant, vid) => self.variant_with_id(vid),
2335             Res::Def(DefKind::Ctor(..), cid) => self.variant_with_ctor_id(cid),
2336             Res::Def(DefKind::Struct, _) | Res::Def(DefKind::Union, _) |
2337             Res::Def(DefKind::TyAlias, _) | Res::Def(DefKind::AssocTy, _) | Res::SelfTy(..) |
2338             Res::SelfCtor(..) => self.non_enum_variant(),
2339             _ => bug!("unexpected res {:?} in variant_of_res", res)
2340         }
2341     }
2342
2343     #[inline]
2344     pub fn eval_explicit_discr(&self, tcx: TyCtxt<'tcx>, expr_did: DefId) -> Option<Discr<'tcx>> {
2345         let param_env = tcx.param_env(expr_did);
2346         let repr_type = self.repr.discr_type();
2347         let substs = InternalSubsts::identity_for_item(tcx, expr_did);
2348         let instance = ty::Instance::new(expr_did, substs);
2349         let cid = GlobalId {
2350             instance,
2351             promoted: None
2352         };
2353         match tcx.const_eval(param_env.and(cid)) {
2354             Ok(val) => {
2355                 // FIXME: Find the right type and use it instead of `val.ty` here
2356                 if let Some(b) = val.try_eval_bits(tcx, param_env, val.ty) {
2357                     trace!("discriminants: {} ({:?})", b, repr_type);
2358                     Some(Discr {
2359                         val: b,
2360                         ty: val.ty,
2361                     })
2362                 } else {
2363                     info!("invalid enum discriminant: {:#?}", val);
2364                     crate::mir::interpret::struct_error(
2365                         tcx.at(tcx.def_span(expr_did)),
2366                         "constant evaluation of enum discriminant resulted in non-integer",
2367                     ).emit();
2368                     None
2369                 }
2370             }
2371             Err(ErrorHandled::Reported) => {
2372                 if !expr_did.is_local() {
2373                     span_bug!(tcx.def_span(expr_did),
2374                         "variant discriminant evaluation succeeded \
2375                          in its crate but failed locally");
2376                 }
2377                 None
2378             }
2379             Err(ErrorHandled::TooGeneric) => span_bug!(
2380                 tcx.def_span(expr_did),
2381                 "enum discriminant depends on generic arguments",
2382             ),
2383         }
2384     }
2385
2386     #[inline]
2387     pub fn discriminants(
2388         &'tcx self,
2389         tcx: TyCtxt<'tcx>,
2390     ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx> {
2391         let repr_type = self.repr.discr_type();
2392         let initial = repr_type.initial_discriminant(tcx);
2393         let mut prev_discr = None::<Discr<'tcx>>;
2394         self.variants.iter_enumerated().map(move |(i, v)| {
2395             let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
2396             if let VariantDiscr::Explicit(expr_did) = v.discr {
2397                 if let Some(new_discr) = self.eval_explicit_discr(tcx, expr_did) {
2398                     discr = new_discr;
2399                 }
2400             }
2401             prev_discr = Some(discr);
2402
2403             (i, discr)
2404         })
2405     }
2406
2407     #[inline]
2408     pub fn variant_range(&self) -> Range<VariantIdx> {
2409         (VariantIdx::new(0)..VariantIdx::new(self.variants.len()))
2410     }
2411
2412     /// Computes the discriminant value used by a specific variant.
2413     /// Unlike `discriminants`, this is (amortized) constant-time,
2414     /// only doing at most one query for evaluating an explicit
2415     /// discriminant (the last one before the requested variant),
2416     /// assuming there are no constant-evaluation errors there.
2417     #[inline]
2418     pub fn discriminant_for_variant(
2419         &self,
2420         tcx: TyCtxt<'tcx>,
2421         variant_index: VariantIdx,
2422     ) -> Discr<'tcx> {
2423         let (val, offset) = self.discriminant_def_for_variant(variant_index);
2424         let explicit_value = val
2425             .and_then(|expr_did| self.eval_explicit_discr(tcx, expr_did))
2426             .unwrap_or_else(|| self.repr.discr_type().initial_discriminant(tcx));
2427         explicit_value.checked_add(tcx, offset as u128).0
2428     }
2429
2430     /// Yields a `DefId` for the discriminant and an offset to add to it
2431     /// Alternatively, if there is no explicit discriminant, returns the
2432     /// inferred discriminant directly.
2433     pub fn discriminant_def_for_variant(
2434         &self,
2435         variant_index: VariantIdx,
2436     ) -> (Option<DefId>, u32) {
2437         let mut explicit_index = variant_index.as_u32();
2438         let expr_did;
2439         loop {
2440             match self.variants[VariantIdx::from_u32(explicit_index)].discr {
2441                 ty::VariantDiscr::Relative(0) => {
2442                     expr_did = None;
2443                     break;
2444                 },
2445                 ty::VariantDiscr::Relative(distance) => {
2446                     explicit_index -= distance;
2447                 }
2448                 ty::VariantDiscr::Explicit(did) => {
2449                     expr_did = Some(did);
2450                     break;
2451                 }
2452             }
2453         }
2454         (expr_did, variant_index.as_u32() - explicit_index)
2455     }
2456
2457     pub fn destructor(&self, tcx: TyCtxt<'tcx>) -> Option<Destructor> {
2458         tcx.adt_destructor(self.did)
2459     }
2460
2461     /// Returns a list of types such that `Self: Sized` if and only
2462     /// if that type is `Sized`, or `TyErr` if this type is recursive.
2463     ///
2464     /// Oddly enough, checking that the sized-constraint is `Sized` is
2465     /// actually more expressive than checking all members:
2466     /// the `Sized` trait is inductive, so an associated type that references
2467     /// `Self` would prevent its containing ADT from being `Sized`.
2468     ///
2469     /// Due to normalization being eager, this applies even if
2470     /// the associated type is behind a pointer (e.g., issue #31299).
2471     pub fn sized_constraint(&self, tcx: TyCtxt<'tcx>) -> &'tcx [Ty<'tcx>] {
2472         tcx.adt_sized_constraint(self.did).0
2473     }
2474
2475     fn sized_constraint_for_ty(&self, tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> Vec<Ty<'tcx>> {
2476         let result = match ty.kind {
2477             Bool | Char | Int(..) | Uint(..) | Float(..) |
2478             RawPtr(..) | Ref(..) | FnDef(..) | FnPtr(_) |
2479             Array(..) | Closure(..) | Generator(..) | Never => {
2480                 vec![]
2481             }
2482
2483             Str |
2484             Dynamic(..) |
2485             Slice(_) |
2486             Foreign(..) |
2487             Error |
2488             GeneratorWitness(..) => {
2489                 // these are never sized - return the target type
2490                 vec![ty]
2491             }
2492
2493             Tuple(ref tys) => {
2494                 match tys.last() {
2495                     None => vec![],
2496                     Some(ty) => self.sized_constraint_for_ty(tcx, ty.expect_ty()),
2497                 }
2498             }
2499
2500             Adt(adt, substs) => {
2501                 // recursive case
2502                 let adt_tys = adt.sized_constraint(tcx);
2503                 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}",
2504                        ty, adt_tys);
2505                 adt_tys.iter()
2506                        .map(|ty| ty.subst(tcx, substs))
2507                        .flat_map(|ty| self.sized_constraint_for_ty(tcx, ty))
2508                        .collect()
2509             }
2510
2511             Projection(..) | Opaque(..) => {
2512                 // must calculate explicitly.
2513                 // FIXME: consider special-casing always-Sized projections
2514                 vec![ty]
2515             }
2516
2517             UnnormalizedProjection(..) => bug!("only used with chalk-engine"),
2518
2519             Param(..) => {
2520                 // perf hack: if there is a `T: Sized` bound, then
2521                 // we know that `T` is Sized and do not need to check
2522                 // it on the impl.
2523
2524                 let sized_trait = match tcx.lang_items().sized_trait() {
2525                     Some(x) => x,
2526                     _ => return vec![ty]
2527                 };
2528                 let sized_predicate = Binder::dummy(TraitRef {
2529                     def_id: sized_trait,
2530                     substs: tcx.mk_substs_trait(ty, &[])
2531                 }).to_predicate();
2532                 let predicates = tcx.predicates_of(self.did).predicates;
2533                 if predicates.iter().any(|(p, _)| *p == sized_predicate) {
2534                     vec![]
2535                 } else {
2536                     vec![ty]
2537                 }
2538             }
2539
2540             Placeholder(..) |
2541             Bound(..) |
2542             Infer(..) => {
2543                 bug!("unexpected type `{:?}` in sized_constraint_for_ty",
2544                      ty)
2545             }
2546         };
2547         debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
2548         result
2549     }
2550 }
2551
2552 impl<'tcx> FieldDef {
2553     /// Returns the type of this field. The `subst` is typically obtained
2554     /// via the second field of `TyKind::AdtDef`.
2555     pub fn ty(&self, tcx: TyCtxt<'tcx>, subst: SubstsRef<'tcx>) -> Ty<'tcx> {
2556         tcx.type_of(self.did).subst(tcx, subst)
2557     }
2558 }
2559
2560 /// Represents the various closure traits in the language. This
2561 /// will determine the type of the environment (`self`, in the
2562 /// desugaring) argument that the closure expects.
2563 ///
2564 /// You can get the environment type of a closure using
2565 /// `tcx.closure_env_ty()`.
2566 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug,
2567          RustcEncodable, RustcDecodable, HashStable)]
2568 pub enum ClosureKind {
2569     // Warning: Ordering is significant here! The ordering is chosen
2570     // because the trait Fn is a subtrait of FnMut and so in turn, and
2571     // hence we order it so that Fn < FnMut < FnOnce.
2572     Fn,
2573     FnMut,
2574     FnOnce,
2575 }
2576
2577 impl<'tcx> ClosureKind {
2578     // This is the initial value used when doing upvar inference.
2579     pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn;
2580
2581     pub fn trait_did(&self, tcx: TyCtxt<'tcx>) -> DefId {
2582         match *self {
2583             ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem, None),
2584             ClosureKind::FnMut => {
2585                 tcx.require_lang_item(FnMutTraitLangItem, None)
2586             }
2587             ClosureKind::FnOnce => {
2588                 tcx.require_lang_item(FnOnceTraitLangItem, None)
2589             }
2590         }
2591     }
2592
2593     /// Returns `true` if this a type that impls this closure kind
2594     /// must also implement `other`.
2595     pub fn extends(self, other: ty::ClosureKind) -> bool {
2596         match (self, other) {
2597             (ClosureKind::Fn, ClosureKind::Fn) => true,
2598             (ClosureKind::Fn, ClosureKind::FnMut) => true,
2599             (ClosureKind::Fn, ClosureKind::FnOnce) => true,
2600             (ClosureKind::FnMut, ClosureKind::FnMut) => true,
2601             (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
2602             (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
2603             _ => false,
2604         }
2605     }
2606
2607     /// Returns the representative scalar type for this closure kind.
2608     /// See `TyS::to_opt_closure_kind` for more details.
2609     pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2610         match self {
2611             ty::ClosureKind::Fn => tcx.types.i8,
2612             ty::ClosureKind::FnMut => tcx.types.i16,
2613             ty::ClosureKind::FnOnce => tcx.types.i32,
2614         }
2615     }
2616 }
2617
2618 impl<'tcx> TyS<'tcx> {
2619     /// Iterator that walks `self` and any types reachable from
2620     /// `self`, in depth-first order. Note that just walks the types
2621     /// that appear in `self`, it does not descend into the fields of
2622     /// structs or variants. For example:
2623     ///
2624     /// ```notrust
2625     /// isize => { isize }
2626     /// Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
2627     /// [isize] => { [isize], isize }
2628     /// ```
2629     pub fn walk(&'tcx self) -> TypeWalker<'tcx> {
2630         TypeWalker::new(self)
2631     }
2632
2633     /// Iterator that walks the immediate children of `self`. Hence
2634     /// `Foo<Bar<i32>, u32>` yields the sequence `[Bar<i32>, u32]`
2635     /// (but not `i32`, like `walk`).
2636     pub fn walk_shallow(&'tcx self) -> smallvec::IntoIter<walk::TypeWalkerArray<'tcx>> {
2637         walk::walk_shallow(self)
2638     }
2639
2640     /// Walks `ty` and any types appearing within `ty`, invoking the
2641     /// callback `f` on each type. If the callback returns `false`, then the
2642     /// children of the current type are ignored.
2643     ///
2644     /// Note: prefer `ty.walk()` where possible.
2645     pub fn maybe_walk<F>(&'tcx self, mut f: F)
2646         where F: FnMut(Ty<'tcx>) -> bool
2647     {
2648         let mut walker = self.walk();
2649         while let Some(ty) = walker.next() {
2650             if !f(ty) {
2651                 walker.skip_current_subtree();
2652             }
2653         }
2654     }
2655 }
2656
2657 impl BorrowKind {
2658     pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
2659         match m {
2660             hir::Mutability::Mut => MutBorrow,
2661             hir::Mutability::Not => ImmBorrow,
2662         }
2663     }
2664
2665     /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
2666     /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
2667     /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
2668     /// question.
2669     pub fn to_mutbl_lossy(self) -> hir::Mutability {
2670         match self {
2671             MutBorrow => hir::Mutability::Mut,
2672             ImmBorrow => hir::Mutability::Not,
2673
2674             // We have no type corresponding to a unique imm borrow, so
2675             // use `&mut`. It gives all the capabilities of an `&uniq`
2676             // and hence is a safe "over approximation".
2677             UniqueImmBorrow => hir::Mutability::Mut,
2678         }
2679     }
2680
2681     pub fn to_user_str(&self) -> &'static str {
2682         match *self {
2683             MutBorrow => "mutable",
2684             ImmBorrow => "immutable",
2685             UniqueImmBorrow => "uniquely immutable",
2686         }
2687     }
2688 }
2689
2690 #[derive(Debug, Clone)]
2691 pub enum Attributes<'tcx> {
2692     Owned(Lrc<[ast::Attribute]>),
2693     Borrowed(&'tcx [ast::Attribute]),
2694 }
2695
2696 impl<'tcx> ::std::ops::Deref for Attributes<'tcx> {
2697     type Target = [ast::Attribute];
2698
2699     fn deref(&self) -> &[ast::Attribute] {
2700         match self {
2701             &Attributes::Owned(ref data) => &data,
2702             &Attributes::Borrowed(data) => data
2703         }
2704     }
2705 }
2706
2707 #[derive(Debug, PartialEq, Eq)]
2708 pub enum ImplOverlapKind {
2709     /// These impls are always allowed to overlap.
2710     Permitted,
2711     /// These impls are allowed to overlap, but that raises
2712     /// an issue #33140 future-compatibility warning.
2713     ///
2714     /// Some background: in Rust 1.0, the trait-object types `Send + Sync` (today's
2715     /// `dyn Send + Sync`) and `Sync + Send` (now `dyn Sync + Send`) were different.
2716     ///
2717     /// The widely-used version 0.1.0 of the crate `traitobject` had accidentally relied
2718     /// that difference, making what reduces to the following set of impls:
2719     ///
2720     /// ```
2721     /// trait Trait {}
2722     /// impl Trait for dyn Send + Sync {}
2723     /// impl Trait for dyn Sync + Send {}
2724     /// ```
2725     ///
2726     /// Obviously, once we made these types be identical, that code causes a coherence
2727     /// error and a fairly big headache for us. However, luckily for us, the trait
2728     /// `Trait` used in this case is basically a marker trait, and therefore having
2729     /// overlapping impls for it is sound.
2730     ///
2731     /// To handle this, we basically regard the trait as a marker trait, with an additional
2732     /// future-compatibility warning. To avoid accidentally "stabilizing" this feature,
2733     /// it has the following restrictions:
2734     ///
2735     /// 1. The trait must indeed be a marker-like trait (i.e., no items), and must be
2736     /// positive impls.
2737     /// 2. The trait-ref of both impls must be equal.
2738     /// 3. The trait-ref of both impls must be a trait object type consisting only of
2739     /// marker traits.
2740     /// 4. Neither of the impls can have any where-clauses.
2741     ///
2742     /// Once `traitobject` 0.1.0 is no longer an active concern, this hack can be removed.
2743     Issue33140
2744 }
2745
2746 impl<'tcx> TyCtxt<'tcx> {
2747     pub fn body_tables(self, body: hir::BodyId) -> &'tcx TypeckTables<'tcx> {
2748         self.typeck_tables_of(self.hir().body_owner_def_id(body))
2749     }
2750
2751     /// Returns an iterator of the `DefId`s for all body-owners in this
2752     /// crate. If you would prefer to iterate over the bodies
2753     /// themselves, you can do `self.hir().krate().body_ids.iter()`.
2754     pub fn body_owners(self) -> impl Iterator<Item = DefId> + Captures<'tcx> + 'tcx {
2755         self.hir().krate()
2756                   .body_ids
2757                   .iter()
2758                   .map(move |&body_id| self.hir().body_owner_def_id(body_id))
2759     }
2760
2761     pub fn par_body_owners<F: Fn(DefId) + sync::Sync + sync::Send>(self, f: F) {
2762         par_iter(&self.hir().krate().body_ids).for_each(|&body_id| {
2763             f(self.hir().body_owner_def_id(body_id))
2764         });
2765     }
2766
2767     pub fn provided_trait_methods(self, id: DefId) -> Vec<AssocItem> {
2768         self.associated_items(id)
2769             .filter(|item| item.kind == AssocKind::Method && item.defaultness.has_value())
2770             .collect()
2771     }
2772
2773     pub fn trait_relevant_for_never(self, did: DefId) -> bool {
2774         self.associated_items(did).any(|item| {
2775             item.relevant_for_never()
2776         })
2777     }
2778
2779     pub fn opt_item_name(self, def_id: DefId) -> Option<Ident> {
2780         self.hir().as_local_hir_id(def_id).and_then(|hir_id| self.hir().get(hir_id).ident())
2781     }
2782
2783     pub fn opt_associated_item(self, def_id: DefId) -> Option<AssocItem> {
2784         let is_associated_item = if let Some(hir_id) = self.hir().as_local_hir_id(def_id) {
2785             match self.hir().get(hir_id) {
2786                 Node::TraitItem(_) | Node::ImplItem(_) => true,
2787                 _ => false,
2788             }
2789         } else {
2790             match self.def_kind(def_id).expect("no def for `DefId`") {
2791                 DefKind::AssocConst
2792                 | DefKind::Method
2793                 | DefKind::AssocTy => true,
2794                 _ => false,
2795             }
2796         };
2797
2798         is_associated_item.then(|| self.associated_item(def_id))
2799     }
2800
2801     fn associated_item_from_trait_item_ref(self,
2802                                            parent_def_id: DefId,
2803                                            parent_vis: &hir::Visibility,
2804                                            trait_item_ref: &hir::TraitItemRef)
2805                                            -> AssocItem {
2806         let def_id = self.hir().local_def_id(trait_item_ref.id.hir_id);
2807         let (kind, has_self) = match trait_item_ref.kind {
2808             hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
2809             hir::AssocItemKind::Method { has_self } => {
2810                 (ty::AssocKind::Method, has_self)
2811             }
2812             hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
2813             hir::AssocItemKind::OpaqueTy => bug!("only impls can have opaque types"),
2814         };
2815
2816         AssocItem {
2817             ident: trait_item_ref.ident,
2818             kind,
2819             // Visibility of trait items is inherited from their traits.
2820             vis: Visibility::from_hir(parent_vis, trait_item_ref.id.hir_id, self),
2821             defaultness: trait_item_ref.defaultness,
2822             def_id,
2823             container: TraitContainer(parent_def_id),
2824             method_has_self_argument: has_self
2825         }
2826     }
2827
2828     fn associated_item_from_impl_item_ref(self,
2829                                           parent_def_id: DefId,
2830                                           impl_item_ref: &hir::ImplItemRef)
2831                                           -> AssocItem {
2832         let def_id = self.hir().local_def_id(impl_item_ref.id.hir_id);
2833         let (kind, has_self) = match impl_item_ref.kind {
2834             hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
2835             hir::AssocItemKind::Method { has_self } => {
2836                 (ty::AssocKind::Method, has_self)
2837             }
2838             hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
2839             hir::AssocItemKind::OpaqueTy => (ty::AssocKind::OpaqueTy, false),
2840         };
2841
2842         AssocItem {
2843             ident: impl_item_ref.ident,
2844             kind,
2845             // Visibility of trait impl items doesn't matter.
2846             vis: ty::Visibility::from_hir(&impl_item_ref.vis, impl_item_ref.id.hir_id, self),
2847             defaultness: impl_item_ref.defaultness,
2848             def_id,
2849             container: ImplContainer(parent_def_id),
2850             method_has_self_argument: has_self
2851         }
2852     }
2853
2854     pub fn field_index(self, hir_id: hir::HirId, tables: &TypeckTables<'_>) -> usize {
2855         tables.field_indices().get(hir_id).cloned().expect("no index for a field")
2856     }
2857
2858     pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2859         variant.fields.iter().position(|field| {
2860             self.hygienic_eq(ident, field.ident, variant.def_id)
2861         })
2862     }
2863
2864     pub fn associated_items(self, def_id: DefId) -> AssocItemsIterator<'tcx> {
2865         // Ideally, we would use `-> impl Iterator` here, but it falls
2866         // afoul of the conservative "capture [restrictions]" we put
2867         // in place, so we use a hand-written iterator.
2868         //
2869         // [restrictions]: https://github.com/rust-lang/rust/issues/34511#issuecomment-373423999
2870         AssocItemsIterator {
2871             tcx: self,
2872             def_ids: self.associated_item_def_ids(def_id),
2873             next_index: 0,
2874         }
2875     }
2876
2877     /// Returns `true` if the impls are the same polarity and the trait either
2878     /// has no items or is annotated #[marker] and prevents item overrides.
2879     pub fn impls_are_allowed_to_overlap(self, def_id1: DefId, def_id2: DefId)
2880                                         -> Option<ImplOverlapKind>
2881     {
2882         // If either trait impl references an error, they're allowed to overlap,
2883         // as one of them essentially doesn't exist.
2884         if self.impl_trait_ref(def_id1).map_or(false, |tr| tr.references_error()) ||
2885             self.impl_trait_ref(def_id2).map_or(false, |tr| tr.references_error()) {
2886             return Some(ImplOverlapKind::Permitted);
2887         }
2888
2889         match (self.impl_polarity(def_id1), self.impl_polarity(def_id2)) {
2890             (ImplPolarity::Reservation, _) |
2891             (_, ImplPolarity::Reservation) => {
2892                 // `#[rustc_reservation_impl]` impls don't overlap with anything
2893                 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (reservations)",
2894                        def_id1, def_id2);
2895                 return Some(ImplOverlapKind::Permitted);
2896             }
2897             (ImplPolarity::Positive, ImplPolarity::Negative) |
2898             (ImplPolarity::Negative, ImplPolarity::Positive) => {
2899                 // `impl AutoTrait for Type` + `impl !AutoTrait for Type`
2900                 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - None (differing polarities)",
2901                        def_id1, def_id2);
2902                 return None;
2903             }
2904             (ImplPolarity::Positive, ImplPolarity::Positive) |
2905             (ImplPolarity::Negative, ImplPolarity::Negative) => {}
2906         };
2907
2908         let is_marker_overlap = if self.features().overlapping_marker_traits {
2909             let trait1_is_empty = self.impl_trait_ref(def_id1)
2910                 .map_or(false, |trait_ref| {
2911                     self.associated_item_def_ids(trait_ref.def_id).is_empty()
2912                 });
2913             let trait2_is_empty = self.impl_trait_ref(def_id2)
2914                 .map_or(false, |trait_ref| {
2915                     self.associated_item_def_ids(trait_ref.def_id).is_empty()
2916                 });
2917             trait1_is_empty && trait2_is_empty
2918         } else {
2919             let is_marker_impl = |def_id: DefId| -> bool {
2920                 let trait_ref = self.impl_trait_ref(def_id);
2921                 trait_ref.map_or(false, |tr| self.trait_def(tr.def_id).is_marker)
2922             };
2923             is_marker_impl(def_id1) && is_marker_impl(def_id2)
2924         };
2925
2926
2927         if is_marker_overlap {
2928             debug!("impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (marker overlap)",
2929                    def_id1, def_id2);
2930             Some(ImplOverlapKind::Permitted)
2931         } else {
2932             if let Some(self_ty1) = self.issue33140_self_ty(def_id1) {
2933                 if let Some(self_ty2) = self.issue33140_self_ty(def_id2) {
2934                     if self_ty1 == self_ty2 {
2935                         debug!("impls_are_allowed_to_overlap({:?}, {:?}) - issue #33140 HACK",
2936                                def_id1, def_id2);
2937                         return Some(ImplOverlapKind::Issue33140);
2938                     } else {
2939                         debug!("impls_are_allowed_to_overlap({:?}, {:?}) - found {:?} != {:?}",
2940                               def_id1, def_id2, self_ty1, self_ty2);
2941                     }
2942                 }
2943             }
2944
2945             debug!("impls_are_allowed_to_overlap({:?}, {:?}) = None",
2946                   def_id1, def_id2);
2947             None
2948         }
2949     }
2950
2951     /// Returns `ty::VariantDef` if `res` refers to a struct,
2952     /// or variant or their constructors, panics otherwise.
2953     pub fn expect_variant_res(self, res: Res) -> &'tcx VariantDef {
2954         match res {
2955             Res::Def(DefKind::Variant, did) => {
2956                 let enum_did = self.parent(did).unwrap();
2957                 self.adt_def(enum_did).variant_with_id(did)
2958             }
2959             Res::Def(DefKind::Struct, did) | Res::Def(DefKind::Union, did) => {
2960                 self.adt_def(did).non_enum_variant()
2961             }
2962             Res::Def(DefKind::Ctor(CtorOf::Variant, ..), variant_ctor_did) => {
2963                 let variant_did = self.parent(variant_ctor_did).unwrap();
2964                 let enum_did = self.parent(variant_did).unwrap();
2965                 self.adt_def(enum_did).variant_with_ctor_id(variant_ctor_did)
2966             }
2967             Res::Def(DefKind::Ctor(CtorOf::Struct, ..), ctor_did) => {
2968                 let struct_did = self.parent(ctor_did).expect("struct ctor has no parent");
2969                 self.adt_def(struct_did).non_enum_variant()
2970             }
2971             _ => bug!("expect_variant_res used with unexpected res {:?}", res)
2972         }
2973     }
2974
2975     pub fn item_name(self, id: DefId) -> Symbol {
2976         if id.index == CRATE_DEF_INDEX {
2977             self.original_crate_name(id.krate)
2978         } else {
2979             let def_key = self.def_key(id);
2980             match def_key.disambiguated_data.data {
2981                 // The name of a constructor is that of its parent.
2982                 hir_map::DefPathData::Ctor =>
2983                     self.item_name(DefId {
2984                         krate: id.krate,
2985                         index: def_key.parent.unwrap()
2986                     }),
2987                 _ => def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
2988                     bug!("item_name: no name for {:?}", self.def_path(id));
2989                 }),
2990             }
2991         }
2992     }
2993
2994     /// Returns the possibly-auto-generated MIR of a `(DefId, Subst)` pair.
2995     pub fn instance_mir(self, instance: ty::InstanceDef<'tcx>) -> ReadOnlyBodyAndCache<'tcx, 'tcx> {
2996         match instance {
2997             ty::InstanceDef::Item(did) => {
2998                 self.optimized_mir(did).unwrap_read_only()
2999             }
3000             ty::InstanceDef::VtableShim(..) |
3001             ty::InstanceDef::ReifyShim(..) |
3002             ty::InstanceDef::Intrinsic(..) |
3003             ty::InstanceDef::FnPtrShim(..) |
3004             ty::InstanceDef::Virtual(..) |
3005             ty::InstanceDef::ClosureOnceShim { .. } |
3006             ty::InstanceDef::DropGlue(..) |
3007             ty::InstanceDef::CloneShim(..) => {
3008                 self.mir_shims(instance).unwrap_read_only()
3009             }
3010         }
3011     }
3012
3013     /// Gets the attributes of a definition.
3014     pub fn get_attrs(self, did: DefId) -> Attributes<'tcx> {
3015         if let Some(id) = self.hir().as_local_hir_id(did) {
3016             Attributes::Borrowed(self.hir().attrs(id))
3017         } else {
3018             Attributes::Owned(self.item_attrs(did))
3019         }
3020     }
3021
3022     /// Determines whether an item is annotated with an attribute.
3023     pub fn has_attr(self, did: DefId, attr: Symbol) -> bool {
3024         attr::contains_name(&self.get_attrs(did), attr)
3025     }
3026
3027     /// Returns `true` if this is an `auto trait`.
3028     pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
3029         self.trait_def(trait_def_id).has_auto_impl
3030     }
3031
3032     pub fn generator_layout(self, def_id: DefId) -> &'tcx GeneratorLayout<'tcx> {
3033         self.optimized_mir(def_id).generator_layout.as_ref().unwrap()
3034     }
3035
3036     /// Given the `DefId` of an impl, returns the `DefId` of the trait it implements.
3037     /// If it implements no trait, returns `None`.
3038     pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
3039         self.impl_trait_ref(def_id).map(|tr| tr.def_id)
3040     }
3041
3042     /// If the given defid describes a method belonging to an impl, returns the
3043     /// `DefId` of the impl that the method belongs to; otherwise, returns `None`.
3044     pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
3045         let item = if def_id.krate != LOCAL_CRATE {
3046             if let Some(DefKind::Method) = self.def_kind(def_id) {
3047                 Some(self.associated_item(def_id))
3048             } else {
3049                 None
3050             }
3051         } else {
3052             self.opt_associated_item(def_id)
3053         };
3054
3055         item.and_then(|trait_item|
3056             match trait_item.container {
3057                 TraitContainer(_) => None,
3058                 ImplContainer(def_id) => Some(def_id),
3059             }
3060         )
3061     }
3062
3063     /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
3064     /// with the name of the crate containing the impl.
3065     pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
3066         if impl_did.is_local() {
3067             let hir_id = self.hir().as_local_hir_id(impl_did).unwrap();
3068             Ok(self.hir().span(hir_id))
3069         } else {
3070             Err(self.crate_name(impl_did.krate))
3071         }
3072     }
3073
3074     /// Hygienically compares a use-site name (`use_name`) for a field or an associated item with
3075     /// its supposed definition name (`def_name`). The method also needs `DefId` of the supposed
3076     /// definition's parent/scope to perform comparison.
3077     pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
3078         // We could use `Ident::eq` here, but we deliberately don't. The name
3079         // comparison fails frequently, and we want to avoid the expensive
3080         // `modern()` calls required for the span comparison whenever possible.
3081         use_name.name == def_name.name &&
3082         use_name.span.ctxt().hygienic_eq(def_name.span.ctxt(),
3083                                          self.expansion_that_defined(def_parent_def_id))
3084     }
3085
3086     fn expansion_that_defined(self, scope: DefId) -> ExpnId {
3087         match scope.krate {
3088             LOCAL_CRATE => self.hir().definitions().expansion_that_defined(scope.index),
3089             _ => ExpnId::root(),
3090         }
3091     }
3092
3093     pub fn adjust_ident(self, mut ident: Ident, scope: DefId) -> Ident {
3094         ident.span.modernize_and_adjust(self.expansion_that_defined(scope));
3095         ident
3096     }
3097
3098     pub fn adjust_ident_and_get_scope(self, mut ident: Ident, scope: DefId, block: hir::HirId)
3099                                       -> (Ident, DefId) {
3100         let scope = match ident.span.modernize_and_adjust(self.expansion_that_defined(scope)) {
3101             Some(actual_expansion) =>
3102                 self.hir().definitions().parent_module_of_macro_def(actual_expansion),
3103             None => self.hir().get_module_parent(block),
3104         };
3105         (ident, scope)
3106     }
3107 }
3108
3109 #[derive(Clone)]
3110 pub struct AssocItemsIterator<'tcx> {
3111     tcx: TyCtxt<'tcx>,
3112     def_ids: &'tcx [DefId],
3113     next_index: usize,
3114 }
3115
3116 impl Iterator for AssocItemsIterator<'_> {
3117     type Item = AssocItem;
3118
3119     fn next(&mut self) -> Option<AssocItem> {
3120         let def_id = self.def_ids.get(self.next_index)?;
3121         self.next_index += 1;
3122         Some(self.tcx.associated_item(*def_id))
3123     }
3124 }
3125
3126 fn associated_item(tcx: TyCtxt<'_>, def_id: DefId) -> AssocItem {
3127     let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3128     let parent_id = tcx.hir().get_parent_item(id);
3129     let parent_def_id = tcx.hir().local_def_id(parent_id);
3130     let parent_item = tcx.hir().expect_item(parent_id);
3131     match parent_item.kind {
3132         hir::ItemKind::Impl(.., ref impl_item_refs) => {
3133             if let Some(impl_item_ref) = impl_item_refs.iter().find(|i| i.id.hir_id == id) {
3134                 let assoc_item = tcx.associated_item_from_impl_item_ref(parent_def_id,
3135                                                                         impl_item_ref);
3136                 debug_assert_eq!(assoc_item.def_id, def_id);
3137                 return assoc_item;
3138             }
3139         }
3140
3141         hir::ItemKind::Trait(.., ref trait_item_refs) => {
3142             if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.hir_id == id) {
3143                 let assoc_item = tcx.associated_item_from_trait_item_ref(parent_def_id,
3144                                                                          &parent_item.vis,
3145                                                                          trait_item_ref);
3146                 debug_assert_eq!(assoc_item.def_id, def_id);
3147                 return assoc_item;
3148             }
3149         }
3150
3151         _ => { }
3152     }
3153
3154     span_bug!(parent_item.span,
3155               "unexpected parent of trait or impl item or item not found: {:?}",
3156               parent_item.kind)
3157 }
3158
3159 #[derive(Clone, HashStable)]
3160 pub struct AdtSizedConstraint<'tcx>(pub &'tcx [Ty<'tcx>]);
3161
3162 /// Calculates the `Sized` constraint.
3163 ///
3164 /// In fact, there are only a few options for the types in the constraint:
3165 ///     - an obviously-unsized type
3166 ///     - a type parameter or projection whose Sizedness can't be known
3167 ///     - a tuple of type parameters or projections, if there are multiple
3168 ///       such.
3169 ///     - a Error, if a type contained itself. The representability
3170 ///       check should catch this case.
3171 fn adt_sized_constraint(tcx: TyCtxt<'_>, def_id: DefId) -> AdtSizedConstraint<'_> {
3172     let def = tcx.adt_def(def_id);
3173
3174     let result = tcx.mk_type_list(def.variants.iter().flat_map(|v| {
3175         v.fields.last()
3176     }).flat_map(|f| {
3177         def.sized_constraint_for_ty(tcx, tcx.type_of(f.did))
3178     }));
3179
3180     debug!("adt_sized_constraint: {:?} => {:?}", def, result);
3181
3182     AdtSizedConstraint(result)
3183 }
3184
3185 fn associated_item_def_ids(tcx: TyCtxt<'_>, def_id: DefId) -> &[DefId] {
3186     let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3187     let item = tcx.hir().expect_item(id);
3188     match item.kind {
3189         hir::ItemKind::Trait(.., ref trait_item_refs) => {
3190             tcx.arena.alloc_from_iter(
3191                 trait_item_refs.iter()
3192                                .map(|trait_item_ref| trait_item_ref.id)
3193                                .map(|id| tcx.hir().local_def_id(id.hir_id))
3194             )
3195         }
3196         hir::ItemKind::Impl(.., ref impl_item_refs) => {
3197             tcx.arena.alloc_from_iter(
3198                 impl_item_refs.iter()
3199                               .map(|impl_item_ref| impl_item_ref.id)
3200                               .map(|id| tcx.hir().local_def_id(id.hir_id))
3201             )
3202         }
3203         hir::ItemKind::TraitAlias(..) => &[],
3204         _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait")
3205     }
3206 }
3207
3208 fn def_span(tcx: TyCtxt<'_>, def_id: DefId) -> Span {
3209     tcx.hir().span_if_local(def_id).unwrap()
3210 }
3211
3212 /// If the given `DefId` describes an item belonging to a trait,
3213 /// returns the `DefId` of the trait that the trait item belongs to;
3214 /// otherwise, returns `None`.
3215 fn trait_of_item(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
3216     tcx.opt_associated_item(def_id)
3217         .and_then(|associated_item| {
3218             match associated_item.container {
3219                 TraitContainer(def_id) => Some(def_id),
3220                 ImplContainer(_) => None
3221             }
3222         })
3223 }
3224
3225 /// Yields the parent function's `DefId` if `def_id` is an `impl Trait` definition.
3226 pub fn is_impl_trait_defn(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
3227     if let Some(hir_id) = tcx.hir().as_local_hir_id(def_id) {
3228         if let Node::Item(item) = tcx.hir().get(hir_id) {
3229             if let hir::ItemKind::OpaqueTy(ref opaque_ty) = item.kind {
3230                 return opaque_ty.impl_trait_fn;
3231             }
3232         }
3233     }
3234     None
3235 }
3236
3237 /// See `ParamEnv` struct definition for details.
3238 fn param_env(tcx: TyCtxt<'_>, def_id: DefId) -> ParamEnv<'_> {
3239     // The param_env of an impl Trait type is its defining function's param_env
3240     if let Some(parent) = is_impl_trait_defn(tcx, def_id) {
3241         return param_env(tcx, parent);
3242     }
3243     // Compute the bounds on Self and the type parameters.
3244
3245     let InstantiatedPredicates { predicates } =
3246         tcx.predicates_of(def_id).instantiate_identity(tcx);
3247
3248     // Finally, we have to normalize the bounds in the environment, in
3249     // case they contain any associated type projections. This process
3250     // can yield errors if the put in illegal associated types, like
3251     // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
3252     // report these errors right here; this doesn't actually feel
3253     // right to me, because constructing the environment feels like a
3254     // kind of a "idempotent" action, but I'm not sure where would be
3255     // a better place. In practice, we construct environments for
3256     // every fn once during type checking, and we'll abort if there
3257     // are any errors at that point, so after type checking you can be
3258     // sure that this will succeed without errors anyway.
3259
3260     let unnormalized_env = ty::ParamEnv::new(
3261         tcx.intern_predicates(&predicates),
3262         traits::Reveal::UserFacing,
3263         tcx.sess.opts.debugging_opts.chalk.then_some(def_id),
3264     );
3265
3266     let body_id = tcx.hir().as_local_hir_id(def_id).map_or(hir::DUMMY_HIR_ID, |id| {
3267         tcx.hir().maybe_body_owned_by(id).map_or(id, |body| body.hir_id)
3268     });
3269     let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
3270     traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
3271 }
3272
3273 fn crate_disambiguator(tcx: TyCtxt<'_>, crate_num: CrateNum) -> CrateDisambiguator {
3274     assert_eq!(crate_num, LOCAL_CRATE);
3275     tcx.sess.local_crate_disambiguator()
3276 }
3277
3278 fn original_crate_name(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Symbol {
3279     assert_eq!(crate_num, LOCAL_CRATE);
3280     tcx.crate_name.clone()
3281 }
3282
3283 fn crate_hash(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Svh {
3284     assert_eq!(crate_num, LOCAL_CRATE);
3285     tcx.hir().crate_hash
3286 }
3287
3288 fn instance_def_size_estimate<'tcx>(tcx: TyCtxt<'tcx>, instance_def: InstanceDef<'tcx>) -> usize {
3289     match instance_def {
3290         InstanceDef::Item(..) |
3291         InstanceDef::DropGlue(..) => {
3292             let mir = tcx.instance_mir(instance_def);
3293             mir.basic_blocks().iter().map(|bb| bb.statements.len()).sum()
3294         },
3295         // Estimate the size of other compiler-generated shims to be 1.
3296         _ => 1
3297     }
3298 }
3299
3300 /// If `def_id` is an issue 33140 hack impl, returns its self type; otherwise, returns `None`.
3301 ///
3302 /// See [`ImplOverlapKind::Issue33140`] for more details.
3303 fn issue33140_self_ty(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Ty<'_>> {
3304     debug!("issue33140_self_ty({:?})", def_id);
3305
3306     let trait_ref = tcx.impl_trait_ref(def_id).unwrap_or_else(|| {
3307         bug!("issue33140_self_ty called on inherent impl {:?}", def_id)
3308     });
3309
3310     debug!("issue33140_self_ty({:?}), trait-ref={:?}", def_id, trait_ref);
3311
3312     let is_marker_like =
3313         tcx.impl_polarity(def_id) == ty::ImplPolarity::Positive &&
3314         tcx.associated_item_def_ids(trait_ref.def_id).is_empty();
3315
3316     // Check whether these impls would be ok for a marker trait.
3317     if !is_marker_like {
3318         debug!("issue33140_self_ty - not marker-like!");
3319         return None;
3320     }
3321
3322     // impl must be `impl Trait for dyn Marker1 + Marker2 + ...`
3323     if trait_ref.substs.len() != 1 {
3324         debug!("issue33140_self_ty - impl has substs!");
3325         return None;
3326     }
3327
3328     let predicates = tcx.predicates_of(def_id);
3329     if predicates.parent.is_some() || !predicates.predicates.is_empty() {
3330         debug!("issue33140_self_ty - impl has predicates {:?}!", predicates);
3331         return None;
3332     }
3333
3334     let self_ty = trait_ref.self_ty();
3335     let self_ty_matches = match self_ty.kind {
3336         ty::Dynamic(ref data, ty::ReStatic) => data.principal().is_none(),
3337         _ => false
3338     };
3339
3340     if self_ty_matches {
3341         debug!("issue33140_self_ty - MATCHES!");
3342         Some(self_ty)
3343     } else {
3344         debug!("issue33140_self_ty - non-matching self type");
3345         None
3346     }
3347 }
3348
3349 /// Check if a function is async.
3350 fn asyncness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::IsAsync {
3351     let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap_or_else(|| {
3352         bug!("asyncness: expected local `DefId`, got `{:?}`", def_id)
3353     });
3354
3355     let node = tcx.hir().get(hir_id);
3356
3357     let fn_like = hir::map::blocks::FnLikeNode::from_node(node).unwrap_or_else(|| {
3358         bug!("asyncness: expected fn-like node but got `{:?}`", def_id);
3359     });
3360
3361     fn_like.asyncness()
3362 }
3363
3364 pub fn provide(providers: &mut ty::query::Providers<'_>) {
3365     context::provide(providers);
3366     erase_regions::provide(providers);
3367     layout::provide(providers);
3368     util::provide(providers);
3369     constness::provide(providers);
3370     *providers = ty::query::Providers {
3371         asyncness,
3372         associated_item,
3373         associated_item_def_ids,
3374         adt_sized_constraint,
3375         def_span,
3376         param_env,
3377         trait_of_item,
3378         crate_disambiguator,
3379         original_crate_name,
3380         crate_hash,
3381         trait_impls_of: trait_def::trait_impls_of_provider,
3382         instance_def_size_estimate,
3383         issue33140_self_ty,
3384         ..*providers
3385     };
3386 }
3387
3388 /// A map for the local crate mapping each type to a vector of its
3389 /// inherent impls. This is not meant to be used outside of coherence;
3390 /// rather, you should request the vector for a specific type via
3391 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
3392 /// (constructing this map requires touching the entire crate).
3393 #[derive(Clone, Debug, Default, HashStable)]
3394 pub struct CrateInherentImpls {
3395     pub inherent_impls: DefIdMap<Vec<DefId>>,
3396 }
3397
3398 #[derive(Clone, Copy, PartialEq, Eq, RustcEncodable, RustcDecodable, HashStable)]
3399 pub struct SymbolName {
3400     // FIXME: we don't rely on interning or equality here - better have
3401     // this be a `&'tcx str`.
3402     pub name: Symbol
3403 }
3404
3405 impl SymbolName {
3406     pub fn new(name: &str) -> SymbolName {
3407         SymbolName {
3408             name: Symbol::intern(name)
3409         }
3410     }
3411 }
3412
3413 impl PartialOrd for SymbolName {
3414     fn partial_cmp(&self, other: &SymbolName) -> Option<Ordering> {
3415         self.name.as_str().partial_cmp(&other.name.as_str())
3416     }
3417 }
3418
3419 /// Ordering must use the chars to ensure reproducible builds.
3420 impl Ord for SymbolName {
3421     fn cmp(&self, other: &SymbolName) -> Ordering {
3422         self.name.as_str().cmp(&other.name.as_str())
3423     }
3424 }
3425
3426 impl fmt::Display for SymbolName {
3427     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3428         fmt::Display::fmt(&self.name, fmt)
3429     }
3430 }
3431
3432 impl fmt::Debug for SymbolName {
3433     fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3434         fmt::Display::fmt(&self.name, fmt)
3435     }
3436 }