1 // ignore-tidy-filelength
3 #![allow(usage_of_ty_tykind)]
5 pub use self::Variance::*;
6 pub use self::AssocItemContainer::*;
7 pub use self::BorrowKind::*;
8 pub use self::IntVarValue::*;
9 pub use self::fold::TypeFoldable;
11 use crate::hir::{map as hir_map, GlobMap, TraitMap};
13 use crate::hir::def::{Res, DefKind, CtorOf, CtorKind, ExportMap};
14 use crate::hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
15 use rustc_data_structures::svh::Svh;
16 use rustc_macros::HashStable;
17 use crate::ich::Fingerprint;
18 use crate::ich::StableHashingContext;
19 use crate::infer::canonical::Canonical;
20 use crate::middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem, FnOnceTraitLangItem};
21 use crate::middle::resolve_lifetime::ObjectLifetimeDefault;
23 use crate::mir::interpret::{GlobalId, ErrorHandled};
24 use crate::mir::GeneratorLayout;
25 use crate::session::CrateDisambiguator;
26 use crate::traits::{self, Reveal};
28 use crate::ty::layout::VariantIdx;
29 use crate::ty::subst::{Subst, InternalSubsts, SubstsRef};
30 use crate::ty::util::{IntTypeExt, Discr};
31 use crate::ty::walk::TypeWalker;
32 use crate::util::captures::Captures;
33 use crate::util::nodemap::{NodeSet, DefIdMap, FxHashMap};
34 use arena::SyncDroplessArena;
35 use crate::session::DataTypeKind;
37 use serialize::{self, Encodable, Encoder};
38 use std::cell::RefCell;
39 use std::cmp::{self, Ordering};
41 use std::hash::{Hash, Hasher};
43 use rustc_data_structures::sync::{self, Lrc, ParallelIterator, par_iter};
47 use syntax::ast::{self, Name, Ident, NodeId};
49 use syntax::ext::hygiene::Mark;
50 use syntax::symbol::{kw, sym, Symbol, LocalInternedString, InternedString};
54 use rustc_data_structures::fx::FxIndexMap;
55 use rustc_data_structures::indexed_vec::{Idx, IndexVec};
56 use rustc_data_structures::stable_hasher::{StableHasher, StableHasherResult,
61 pub use self::sty::{Binder, BoundTy, BoundTyKind, BoundVar, DebruijnIndex, INNERMOST};
62 pub use self::sty::{FnSig, GenSig, CanonicalPolyFnSig, PolyFnSig, PolyGenSig};
63 pub use self::sty::{InferTy, ParamTy, ParamConst, InferConst, ProjectionTy, ExistentialPredicate};
64 pub use self::sty::{ClosureSubsts, GeneratorSubsts, UpvarSubsts, TypeAndMut};
65 pub use self::sty::{TraitRef, TyKind, PolyTraitRef};
66 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
67 pub use self::sty::{ExistentialProjection, PolyExistentialProjection, Const};
68 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
69 pub use self::sty::RegionKind;
70 pub use self::sty::{TyVid, IntVid, FloatVid, ConstVid, RegionVid};
71 pub use self::sty::BoundRegion::*;
72 pub use self::sty::InferTy::*;
73 pub use self::sty::RegionKind::*;
74 pub use self::sty::TyKind::*;
76 pub use self::binding::BindingMode;
77 pub use self::binding::BindingMode::*;
79 pub use self::context::{TyCtxt, FreeRegionInfo, AllArenas, tls, keep_local};
80 pub use self::context::{Lift, TypeckTables, CtxtInterners, GlobalCtxt};
81 pub use self::context::{
82 UserTypeAnnotationIndex, UserType, CanonicalUserType,
83 CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations, ResolvedOpaqueTy,
86 pub use self::instance::{Instance, InstanceDef};
88 pub use self::trait_def::TraitDef;
90 pub use self::query::queries;
103 pub mod inhabitedness;
119 mod structural_impls;
125 pub struct Resolutions {
126 pub trait_map: TraitMap,
127 pub maybe_unused_trait_imports: NodeSet,
128 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
129 pub export_map: ExportMap<NodeId>,
130 pub glob_map: GlobMap,
131 /// Extern prelude entries. The value is `true` if the entry was introduced
132 /// via `extern crate` item and not `--extern` option or compiler built-in.
133 pub extern_prelude: FxHashMap<Name, bool>,
136 #[derive(Clone, Copy, PartialEq, Eq, Debug, HashStable)]
137 pub enum AssocItemContainer {
138 TraitContainer(DefId),
139 ImplContainer(DefId),
142 impl AssocItemContainer {
143 /// Asserts that this is the `DefId` of an associated item declared
144 /// in a trait, and returns the trait `DefId`.
145 pub fn assert_trait(&self) -> DefId {
147 TraitContainer(id) => id,
148 _ => bug!("associated item has wrong container type: {:?}", self)
152 pub fn id(&self) -> DefId {
154 TraitContainer(id) => id,
155 ImplContainer(id) => id,
160 /// The "header" of an impl is everything outside the body: a Self type, a trait
161 /// ref (in the case of a trait impl), and a set of predicates (from the
162 /// bounds / where-clauses).
163 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
164 pub struct ImplHeader<'tcx> {
165 pub impl_def_id: DefId,
166 pub self_ty: Ty<'tcx>,
167 pub trait_ref: Option<TraitRef<'tcx>>,
168 pub predicates: Vec<Predicate<'tcx>>,
171 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
172 pub struct AssocItem {
174 #[stable_hasher(project(name))]
178 pub defaultness: hir::Defaultness,
179 pub container: AssocItemContainer,
181 /// Whether this is a method with an explicit self
182 /// as its first argument, allowing method calls.
183 pub method_has_self_argument: bool,
186 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, RustcEncodable, RustcDecodable, HashStable)]
195 pub fn def_kind(&self) -> DefKind {
197 AssocKind::Const => DefKind::AssocConst,
198 AssocKind::Method => DefKind::Method,
199 AssocKind::Type => DefKind::AssocTy,
200 AssocKind::Existential => DefKind::AssocExistential,
204 /// Tests whether the associated item admits a non-trivial implementation
206 pub fn relevant_for_never<'tcx>(&self) -> bool {
208 AssocKind::Existential |
210 AssocKind::Type => true,
211 // FIXME(canndrew): Be more thorough here, check if any argument is uninhabited.
212 AssocKind::Method => !self.method_has_self_argument,
216 pub fn signature<'a, 'tcx>(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> String {
218 ty::AssocKind::Method => {
219 // We skip the binder here because the binder would deanonymize all
220 // late-bound regions, and we don't want method signatures to show up
221 // `as for<'r> fn(&'r MyType)`. Pretty-printing handles late-bound
222 // regions just fine, showing `fn(&MyType)`.
223 tcx.fn_sig(self.def_id).skip_binder().to_string()
225 ty::AssocKind::Type => format!("type {};", self.ident),
226 ty::AssocKind::Existential => format!("existential type {};", self.ident),
227 ty::AssocKind::Const => {
228 format!("const {}: {:?};", self.ident, tcx.type_of(self.def_id))
234 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable, HashStable)]
235 pub enum Visibility {
236 /// Visible everywhere (including in other crates).
238 /// Visible only in the given crate-local module.
240 /// Not visible anywhere in the local crate. This is the visibility of private external items.
244 pub trait DefIdTree: Copy {
245 fn parent(self, id: DefId) -> Option<DefId>;
247 fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
248 if descendant.krate != ancestor.krate {
252 while descendant != ancestor {
253 match self.parent(descendant) {
254 Some(parent) => descendant = parent,
255 None => return false,
262 impl<'a, 'gcx, 'tcx> DefIdTree for TyCtxt<'a, 'gcx, 'tcx> {
263 fn parent(self, id: DefId) -> Option<DefId> {
264 self.def_key(id).parent.map(|index| DefId { index: index, ..id })
269 pub fn from_hir(visibility: &hir::Visibility, id: hir::HirId, tcx: TyCtxt<'_, '_, '_>) -> Self {
270 match visibility.node {
271 hir::VisibilityKind::Public => Visibility::Public,
272 hir::VisibilityKind::Crate(_) => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
273 hir::VisibilityKind::Restricted { ref path, .. } => match path.res {
274 // If there is no resolution, `resolve` will have already reported an error, so
275 // assume that the visibility is public to avoid reporting more privacy errors.
276 Res::Err => Visibility::Public,
277 def => Visibility::Restricted(def.def_id()),
279 hir::VisibilityKind::Inherited => {
280 Visibility::Restricted(tcx.hir().get_module_parent_by_hir_id(id))
285 /// Returns `true` if an item with this visibility is accessible from the given block.
286 pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
287 let restriction = match self {
288 // Public items are visible everywhere.
289 Visibility::Public => return true,
290 // Private items from other crates are visible nowhere.
291 Visibility::Invisible => return false,
292 // Restricted items are visible in an arbitrary local module.
293 Visibility::Restricted(other) if other.krate != module.krate => return false,
294 Visibility::Restricted(module) => module,
297 tree.is_descendant_of(module, restriction)
300 /// Returns `true` if this visibility is at least as accessible as the given visibility
301 pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
302 let vis_restriction = match vis {
303 Visibility::Public => return self == Visibility::Public,
304 Visibility::Invisible => return true,
305 Visibility::Restricted(module) => module,
308 self.is_accessible_from(vis_restriction, tree)
311 // Returns `true` if this item is visible anywhere in the local crate.
312 pub fn is_visible_locally(self) -> bool {
314 Visibility::Public => true,
315 Visibility::Restricted(def_id) => def_id.is_local(),
316 Visibility::Invisible => false,
321 #[derive(Copy, Clone, PartialEq, Eq, RustcDecodable, RustcEncodable, Hash, HashStable)]
323 Covariant, // T<A> <: T<B> iff A <: B -- e.g., function return type
324 Invariant, // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
325 Contravariant, // T<A> <: T<B> iff B <: A -- e.g., function param type
326 Bivariant, // T<A> <: T<B> -- e.g., unused type parameter
329 /// The crate variances map is computed during typeck and contains the
330 /// variance of every item in the local crate. You should not use it
331 /// directly, because to do so will make your pass dependent on the
332 /// HIR of every item in the local crate. Instead, use
333 /// `tcx.variances_of()` to get the variance for a *particular*
335 #[derive(HashStable)]
336 pub struct CrateVariancesMap<'tcx> {
337 /// For each item with generics, maps to a vector of the variance
338 /// of its generics. If an item has no generics, it will have no
340 pub variances: FxHashMap<DefId, &'tcx [ty::Variance]>,
344 /// `a.xform(b)` combines the variance of a context with the
345 /// variance of a type with the following meaning. If we are in a
346 /// context with variance `a`, and we encounter a type argument in
347 /// a position with variance `b`, then `a.xform(b)` is the new
348 /// variance with which the argument appears.
354 /// Here, the "ambient" variance starts as covariant. `*mut T` is
355 /// invariant with respect to `T`, so the variance in which the
356 /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
357 /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
358 /// respect to its type argument `T`, and hence the variance of
359 /// the `i32` here is `Invariant.xform(Covariant)`, which results
360 /// (again) in `Invariant`.
364 /// fn(*const Vec<i32>, *mut Vec<i32)
366 /// The ambient variance is covariant. A `fn` type is
367 /// contravariant with respect to its parameters, so the variance
368 /// within which both pointer types appear is
369 /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
370 /// T` is covariant with respect to `T`, so the variance within
371 /// which the first `Vec<i32>` appears is
372 /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
373 /// is true for its `i32` argument. In the `*mut T` case, the
374 /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
375 /// and hence the outermost type is `Invariant` with respect to
376 /// `Vec<i32>` (and its `i32` argument).
378 /// Source: Figure 1 of "Taming the Wildcards:
379 /// Combining Definition- and Use-Site Variance" published in PLDI'11.
380 pub fn xform(self, v: ty::Variance) -> ty::Variance {
382 // Figure 1, column 1.
383 (ty::Covariant, ty::Covariant) => ty::Covariant,
384 (ty::Covariant, ty::Contravariant) => ty::Contravariant,
385 (ty::Covariant, ty::Invariant) => ty::Invariant,
386 (ty::Covariant, ty::Bivariant) => ty::Bivariant,
388 // Figure 1, column 2.
389 (ty::Contravariant, ty::Covariant) => ty::Contravariant,
390 (ty::Contravariant, ty::Contravariant) => ty::Covariant,
391 (ty::Contravariant, ty::Invariant) => ty::Invariant,
392 (ty::Contravariant, ty::Bivariant) => ty::Bivariant,
394 // Figure 1, column 3.
395 (ty::Invariant, _) => ty::Invariant,
397 // Figure 1, column 4.
398 (ty::Bivariant, _) => ty::Bivariant,
403 // Contains information needed to resolve types and (in the future) look up
404 // the types of AST nodes.
405 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
406 pub struct CReaderCacheKey {
411 // Flags that we track on types. These flags are propagated upwards
412 // through the type during type construction, so that we can quickly
413 // check whether the type has various kinds of types in it without
414 // recursing over the type itself.
416 pub struct TypeFlags: u32 {
417 const HAS_PARAMS = 1 << 0;
418 const HAS_SELF = 1 << 1;
419 const HAS_TY_INFER = 1 << 2;
420 const HAS_RE_INFER = 1 << 3;
421 const HAS_RE_PLACEHOLDER = 1 << 4;
423 /// Does this have any `ReEarlyBound` regions? Used to
424 /// determine whether substitition is required, since those
425 /// represent regions that are bound in a `ty::Generics` and
426 /// hence may be substituted.
427 const HAS_RE_EARLY_BOUND = 1 << 5;
429 /// Does this have any region that "appears free" in the type?
430 /// Basically anything but `ReLateBound` and `ReErased`.
431 const HAS_FREE_REGIONS = 1 << 6;
433 /// Is an error type reachable?
434 const HAS_TY_ERR = 1 << 7;
435 const HAS_PROJECTION = 1 << 8;
437 // FIXME: Rename this to the actual property since it's used for generators too
438 const HAS_TY_CLOSURE = 1 << 9;
440 /// `true` if there are "names" of types and regions and so forth
441 /// that are local to a particular fn
442 const HAS_FREE_LOCAL_NAMES = 1 << 10;
444 /// Present if the type belongs in a local type context.
445 /// Only set for Infer other than Fresh.
446 const KEEP_IN_LOCAL_TCX = 1 << 11;
448 // Is there a projection that does not involve a bound region?
449 // Currently we can't normalize projections w/ bound regions.
450 const HAS_NORMALIZABLE_PROJECTION = 1 << 12;
452 /// Does this have any `ReLateBound` regions? Used to check
453 /// if a global bound is safe to evaluate.
454 const HAS_RE_LATE_BOUND = 1 << 13;
456 const HAS_TY_PLACEHOLDER = 1 << 14;
458 const HAS_CT_INFER = 1 << 15;
459 const HAS_CT_PLACEHOLDER = 1 << 16;
461 const NEEDS_SUBST = TypeFlags::HAS_PARAMS.bits |
462 TypeFlags::HAS_SELF.bits |
463 TypeFlags::HAS_RE_EARLY_BOUND.bits;
465 /// Flags representing the nominal content of a type,
466 /// computed by FlagsComputation. If you add a new nominal
467 /// flag, it should be added here too.
468 const NOMINAL_FLAGS = TypeFlags::HAS_PARAMS.bits |
469 TypeFlags::HAS_SELF.bits |
470 TypeFlags::HAS_TY_INFER.bits |
471 TypeFlags::HAS_RE_INFER.bits |
472 TypeFlags::HAS_CT_INFER.bits |
473 TypeFlags::HAS_RE_PLACEHOLDER.bits |
474 TypeFlags::HAS_RE_EARLY_BOUND.bits |
475 TypeFlags::HAS_FREE_REGIONS.bits |
476 TypeFlags::HAS_TY_ERR.bits |
477 TypeFlags::HAS_PROJECTION.bits |
478 TypeFlags::HAS_TY_CLOSURE.bits |
479 TypeFlags::HAS_FREE_LOCAL_NAMES.bits |
480 TypeFlags::KEEP_IN_LOCAL_TCX.bits |
481 TypeFlags::HAS_RE_LATE_BOUND.bits |
482 TypeFlags::HAS_TY_PLACEHOLDER.bits |
483 TypeFlags::HAS_CT_PLACEHOLDER.bits;
487 pub struct TyS<'tcx> {
488 pub sty: TyKind<'tcx>,
489 pub flags: TypeFlags,
491 /// This is a kind of confusing thing: it stores the smallest
494 /// (a) the binder itself captures nothing but
495 /// (b) all the late-bound things within the type are captured
496 /// by some sub-binder.
498 /// So, for a type without any late-bound things, like `u32`, this
499 /// will be *innermost*, because that is the innermost binder that
500 /// captures nothing. But for a type `&'D u32`, where `'D` is a
501 /// late-bound region with De Bruijn index `D`, this would be `D + 1`
502 /// -- the binder itself does not capture `D`, but `D` is captured
503 /// by an inner binder.
505 /// We call this concept an "exclusive" binder `D` because all
506 /// De Bruijn indices within the type are contained within `0..D`
508 outer_exclusive_binder: ty::DebruijnIndex,
511 // `TyS` is used a lot. Make sure it doesn't unintentionally get bigger.
512 #[cfg(target_arch = "x86_64")]
513 static_assert_size!(TyS<'_>, 32);
515 impl<'tcx> Ord for TyS<'tcx> {
516 fn cmp(&self, other: &TyS<'tcx>) -> Ordering {
517 self.sty.cmp(&other.sty)
521 impl<'tcx> PartialOrd for TyS<'tcx> {
522 fn partial_cmp(&self, other: &TyS<'tcx>) -> Option<Ordering> {
523 Some(self.sty.cmp(&other.sty))
527 impl<'tcx> PartialEq for TyS<'tcx> {
529 fn eq(&self, other: &TyS<'tcx>) -> bool {
533 impl<'tcx> Eq for TyS<'tcx> {}
535 impl<'tcx> Hash for TyS<'tcx> {
536 fn hash<H: Hasher>(&self, s: &mut H) {
537 (self as *const TyS<'_>).hash(s)
541 impl<'tcx> TyS<'tcx> {
542 pub fn is_primitive_ty(&self) -> bool {
549 TyKind::Infer(InferTy::IntVar(_)) |
550 TyKind::Infer(InferTy::FloatVar(_)) |
551 TyKind::Infer(InferTy::FreshIntTy(_)) |
552 TyKind::Infer(InferTy::FreshFloatTy(_)) => true,
553 TyKind::Ref(_, x, _) => x.is_primitive_ty(),
558 pub fn is_suggestable(&self) -> bool {
563 TyKind::Dynamic(..) |
564 TyKind::Closure(..) |
566 TyKind::Projection(..) => false,
572 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for ty::TyS<'gcx> {
573 fn hash_stable<W: StableHasherResult>(&self,
574 hcx: &mut StableHashingContext<'a>,
575 hasher: &mut StableHasher<W>) {
579 // The other fields just provide fast access to information that is
580 // also contained in `sty`, so no need to hash them.
583 outer_exclusive_binder: _,
586 sty.hash_stable(hcx, hasher);
590 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
592 impl<'tcx> serialize::UseSpecializedEncodable for Ty<'tcx> {}
593 impl<'tcx> serialize::UseSpecializedDecodable for Ty<'tcx> {}
595 pub type CanonicalTy<'gcx> = Canonical<'gcx, Ty<'gcx>>;
598 /// A dummy type used to force List to by unsized without requiring fat pointers
599 type OpaqueListContents;
602 /// A wrapper for slices with the additional invariant
603 /// that the slice is interned and no other slice with
604 /// the same contents can exist in the same context.
605 /// This means we can use pointer for both
606 /// equality comparisons and hashing.
607 /// Note: `Slice` was already taken by the `Ty`.
612 opaque: OpaqueListContents,
615 unsafe impl<T: Sync> Sync for List<T> {}
617 impl<T: Copy> List<T> {
619 fn from_arena<'tcx>(arena: &'tcx SyncDroplessArena, slice: &[T]) -> &'tcx List<T> {
620 assert!(!mem::needs_drop::<T>());
621 assert!(mem::size_of::<T>() != 0);
622 assert!(slice.len() != 0);
624 // Align up the size of the len (usize) field
625 let align = mem::align_of::<T>();
626 let align_mask = align - 1;
627 let offset = mem::size_of::<usize>();
628 let offset = (offset + align_mask) & !align_mask;
630 let size = offset + slice.len() * mem::size_of::<T>();
632 let mem = arena.alloc_raw(
634 cmp::max(mem::align_of::<T>(), mem::align_of::<usize>()));
636 let result = &mut *(mem.as_mut_ptr() as *mut List<T>);
638 result.len = slice.len();
640 // Write the elements
641 let arena_slice = slice::from_raw_parts_mut(result.data.as_mut_ptr(), result.len);
642 arena_slice.copy_from_slice(slice);
649 impl<T: fmt::Debug> fmt::Debug for List<T> {
650 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
655 impl<T: Encodable> Encodable for List<T> {
657 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
662 impl<T> Ord for List<T> where T: Ord {
663 fn cmp(&self, other: &List<T>) -> Ordering {
664 if self == other { Ordering::Equal } else {
665 <[T] as Ord>::cmp(&**self, &**other)
670 impl<T> PartialOrd for List<T> where T: PartialOrd {
671 fn partial_cmp(&self, other: &List<T>) -> Option<Ordering> {
672 if self == other { Some(Ordering::Equal) } else {
673 <[T] as PartialOrd>::partial_cmp(&**self, &**other)
678 impl<T: PartialEq> PartialEq for List<T> {
680 fn eq(&self, other: &List<T>) -> bool {
684 impl<T: Eq> Eq for List<T> {}
686 impl<T> Hash for List<T> {
688 fn hash<H: Hasher>(&self, s: &mut H) {
689 (self as *const List<T>).hash(s)
693 impl<T> Deref for List<T> {
696 fn deref(&self) -> &[T] {
698 slice::from_raw_parts(self.data.as_ptr(), self.len)
703 impl<'a, T> IntoIterator for &'a List<T> {
705 type IntoIter = <&'a [T] as IntoIterator>::IntoIter;
707 fn into_iter(self) -> Self::IntoIter {
712 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx List<Ty<'tcx>> {}
716 pub fn empty<'a>() -> &'a List<T> {
717 #[repr(align(64), C)]
718 struct EmptySlice([u8; 64]);
719 static EMPTY_SLICE: EmptySlice = EmptySlice([0; 64]);
720 assert!(mem::align_of::<T>() <= 64);
722 &*(&EMPTY_SLICE as *const _ as *const List<T>)
727 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
728 pub struct UpvarPath {
729 pub hir_id: hir::HirId,
732 /// Upvars do not get their own `NodeId`. Instead, we use the pair of
733 /// the original var ID (that is, the root variable that is referenced
734 /// by the upvar) and the ID of the closure expression.
735 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
737 pub var_path: UpvarPath,
738 pub closure_expr_id: LocalDefId,
741 #[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable, Copy, HashStable)]
742 pub enum BorrowKind {
743 /// Data must be immutable and is aliasable.
746 /// Data must be immutable but not aliasable. This kind of borrow
747 /// cannot currently be expressed by the user and is used only in
748 /// implicit closure bindings. It is needed when the closure
749 /// is borrowing or mutating a mutable referent, e.g.:
751 /// let x: &mut isize = ...;
752 /// let y = || *x += 5;
754 /// If we were to try to translate this closure into a more explicit
755 /// form, we'd encounter an error with the code as written:
757 /// struct Env { x: & &mut isize }
758 /// let x: &mut isize = ...;
759 /// let y = (&mut Env { &x }, fn_ptr); // Closure is pair of env and fn
760 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
762 /// This is then illegal because you cannot mutate a `&mut` found
763 /// in an aliasable location. To solve, you'd have to translate with
764 /// an `&mut` borrow:
766 /// struct Env { x: & &mut isize }
767 /// let x: &mut isize = ...;
768 /// let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
769 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
771 /// Now the assignment to `**env.x` is legal, but creating a
772 /// mutable pointer to `x` is not because `x` is not mutable. We
773 /// could fix this by declaring `x` as `let mut x`. This is ok in
774 /// user code, if awkward, but extra weird for closures, since the
775 /// borrow is hidden.
777 /// So we introduce a "unique imm" borrow -- the referent is
778 /// immutable, but not aliasable. This solves the problem. For
779 /// simplicity, we don't give users the way to express this
780 /// borrow, it's just used when translating closures.
783 /// Data is mutable and not aliasable.
787 /// Information describing the capture of an upvar. This is computed
788 /// during `typeck`, specifically by `regionck`.
789 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable, HashStable)]
790 pub enum UpvarCapture<'tcx> {
791 /// Upvar is captured by value. This is always true when the
792 /// closure is labeled `move`, but can also be true in other cases
793 /// depending on inference.
796 /// Upvar is captured by reference.
797 ByRef(UpvarBorrow<'tcx>),
800 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable, HashStable)]
801 pub struct UpvarBorrow<'tcx> {
802 /// The kind of borrow: by-ref upvars have access to shared
803 /// immutable borrows, which are not part of the normal language
805 pub kind: BorrowKind,
807 /// Region of the resulting reference.
808 pub region: ty::Region<'tcx>,
811 pub type UpvarListMap = FxHashMap<DefId, FxIndexMap<hir::HirId, UpvarId>>;
812 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
814 #[derive(Copy, Clone)]
815 pub struct ClosureUpvar<'tcx> {
821 #[derive(Clone, Copy, PartialEq, Eq)]
822 pub enum IntVarValue {
824 UintType(ast::UintTy),
827 #[derive(Clone, Copy, PartialEq, Eq)]
828 pub struct FloatVarValue(pub ast::FloatTy);
830 impl ty::EarlyBoundRegion {
831 pub fn to_bound_region(&self) -> ty::BoundRegion {
832 ty::BoundRegion::BrNamed(self.def_id, self.name)
835 /// Does this early bound region have a name? Early bound regions normally
836 /// always have names except when using anonymous lifetimes (`'_`).
837 pub fn has_name(&self) -> bool {
838 self.name != kw::UnderscoreLifetime.as_interned_str()
842 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
843 pub enum GenericParamDefKind {
847 object_lifetime_default: ObjectLifetimeDefault,
848 synthetic: Option<hir::SyntheticTyParamKind>,
853 #[derive(Clone, RustcEncodable, RustcDecodable, HashStable)]
854 pub struct GenericParamDef {
855 pub name: InternedString,
859 /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
860 /// on generic parameter `'a`/`T`, asserts data behind the parameter
861 /// `'a`/`T` won't be accessed during the parent type's `Drop` impl.
862 pub pure_wrt_drop: bool,
864 pub kind: GenericParamDefKind,
867 impl GenericParamDef {
868 pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
869 if let GenericParamDefKind::Lifetime = self.kind {
870 ty::EarlyBoundRegion {
876 bug!("cannot convert a non-lifetime parameter def to an early bound region")
880 pub fn to_bound_region(&self) -> ty::BoundRegion {
881 if let GenericParamDefKind::Lifetime = self.kind {
882 self.to_early_bound_region_data().to_bound_region()
884 bug!("cannot convert a non-lifetime parameter def to an early bound region")
890 pub struct GenericParamCount {
891 pub lifetimes: usize,
896 /// Information about the formal type/lifetime parameters associated
897 /// with an item or method. Analogous to `hir::Generics`.
899 /// The ordering of parameters is the same as in `Subst` (excluding child generics):
900 /// `Self` (optionally), `Lifetime` params..., `Type` params...
901 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
902 pub struct Generics {
903 pub parent: Option<DefId>,
904 pub parent_count: usize,
905 pub params: Vec<GenericParamDef>,
907 /// Reverse map to the `index` field of each `GenericParamDef`
908 #[stable_hasher(ignore)]
909 pub param_def_id_to_index: FxHashMap<DefId, u32>,
912 pub has_late_bound_regions: Option<Span>,
915 impl<'a, 'gcx, 'tcx> Generics {
916 pub fn count(&self) -> usize {
917 self.parent_count + self.params.len()
920 pub fn own_counts(&self) -> GenericParamCount {
921 // We could cache this as a property of `GenericParamCount`, but
922 // the aim is to refactor this away entirely eventually and the
923 // presence of this method will be a constant reminder.
924 let mut own_counts: GenericParamCount = Default::default();
926 for param in &self.params {
928 GenericParamDefKind::Lifetime => own_counts.lifetimes += 1,
929 GenericParamDefKind::Type { .. } => own_counts.types += 1,
930 GenericParamDefKind::Const => own_counts.consts += 1,
937 pub fn requires_monomorphization(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
938 if self.own_requires_monomorphization() {
942 if let Some(parent_def_id) = self.parent {
943 let parent = tcx.generics_of(parent_def_id);
944 parent.requires_monomorphization(tcx)
950 pub fn own_requires_monomorphization(&self) -> bool {
951 for param in &self.params {
953 GenericParamDefKind::Type { .. } | GenericParamDefKind::Const => return true,
954 GenericParamDefKind::Lifetime => {}
960 pub fn region_param(&'tcx self,
961 param: &EarlyBoundRegion,
962 tcx: TyCtxt<'a, 'gcx, 'tcx>)
963 -> &'tcx GenericParamDef
965 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
966 let param = &self.params[index as usize];
968 GenericParamDefKind::Lifetime => param,
969 _ => bug!("expected lifetime parameter, but found another generic parameter")
972 tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
973 .region_param(param, tcx)
977 /// Returns the `GenericParamDef` associated with this `ParamTy`.
978 pub fn type_param(&'tcx self,
980 tcx: TyCtxt<'a, 'gcx, 'tcx>)
981 -> &'tcx GenericParamDef {
982 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
983 let param = &self.params[index as usize];
985 GenericParamDefKind::Type { .. } => param,
986 _ => bug!("expected type parameter, but found another generic parameter")
989 tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
990 .type_param(param, tcx)
994 /// Returns the `ConstParameterDef` associated with this `ParamConst`.
995 pub fn const_param(&'tcx self,
997 tcx: TyCtxt<'a, 'gcx, 'tcx>)
998 -> &GenericParamDef {
999 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
1000 let param = &self.params[index as usize];
1002 GenericParamDefKind::Const => param,
1003 _ => bug!("expected const parameter, but found another generic parameter")
1006 tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
1007 .const_param(param, tcx)
1012 /// Bounds on generics.
1013 #[derive(Clone, Default, Debug, HashStable)]
1014 pub struct GenericPredicates<'tcx> {
1015 pub parent: Option<DefId>,
1016 pub predicates: Vec<(Predicate<'tcx>, Span)>,
1019 impl<'tcx> serialize::UseSpecializedEncodable for GenericPredicates<'tcx> {}
1020 impl<'tcx> serialize::UseSpecializedDecodable for GenericPredicates<'tcx> {}
1022 impl<'a, 'gcx, 'tcx> GenericPredicates<'tcx> {
1023 pub fn instantiate(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: SubstsRef<'tcx>)
1024 -> InstantiatedPredicates<'tcx> {
1025 let mut instantiated = InstantiatedPredicates::empty();
1026 self.instantiate_into(tcx, &mut instantiated, substs);
1030 pub fn instantiate_own(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: SubstsRef<'tcx>)
1031 -> InstantiatedPredicates<'tcx> {
1032 InstantiatedPredicates {
1033 predicates: self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)).collect(),
1037 fn instantiate_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1038 instantiated: &mut InstantiatedPredicates<'tcx>,
1039 substs: SubstsRef<'tcx>) {
1040 if let Some(def_id) = self.parent {
1041 tcx.predicates_of(def_id).instantiate_into(tcx, instantiated, substs);
1043 instantiated.predicates.extend(
1044 self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)),
1048 pub fn instantiate_identity(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>)
1049 -> InstantiatedPredicates<'tcx> {
1050 let mut instantiated = InstantiatedPredicates::empty();
1051 self.instantiate_identity_into(tcx, &mut instantiated);
1055 fn instantiate_identity_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1056 instantiated: &mut InstantiatedPredicates<'tcx>) {
1057 if let Some(def_id) = self.parent {
1058 tcx.predicates_of(def_id).instantiate_identity_into(tcx, instantiated);
1060 instantiated.predicates.extend(self.predicates.iter().map(|&(p, _)| p))
1063 pub fn instantiate_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1064 poly_trait_ref: &ty::PolyTraitRef<'tcx>)
1065 -> InstantiatedPredicates<'tcx>
1067 assert_eq!(self.parent, None);
1068 InstantiatedPredicates {
1069 predicates: self.predicates.iter().map(|(pred, _)| {
1070 pred.subst_supertrait(tcx, poly_trait_ref)
1076 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
1077 pub enum Predicate<'tcx> {
1078 /// Corresponds to `where Foo: Bar<A, B, C>`. `Foo` here would be
1079 /// the `Self` type of the trait reference and `A`, `B`, and `C`
1080 /// would be the type parameters.
1081 Trait(PolyTraitPredicate<'tcx>),
1084 RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
1087 TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
1089 /// `where <T as TraitRef>::Name == X`, approximately.
1090 /// See the `ProjectionPredicate` struct for details.
1091 Projection(PolyProjectionPredicate<'tcx>),
1093 /// No syntax: `T` well-formed.
1094 WellFormed(Ty<'tcx>),
1096 /// Trait must be object-safe.
1099 /// No direct syntax. May be thought of as `where T: FnFoo<...>`
1100 /// for some substitutions `...` and `T` being a closure type.
1101 /// Satisfied (or refuted) once we know the closure's kind.
1102 ClosureKind(DefId, ClosureSubsts<'tcx>, ClosureKind),
1105 Subtype(PolySubtypePredicate<'tcx>),
1107 /// Constant initializer must evaluate successfully.
1108 ConstEvaluatable(DefId, SubstsRef<'tcx>),
1111 /// The crate outlives map is computed during typeck and contains the
1112 /// outlives of every item in the local crate. You should not use it
1113 /// directly, because to do so will make your pass dependent on the
1114 /// HIR of every item in the local crate. Instead, use
1115 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
1117 #[derive(HashStable)]
1118 pub struct CratePredicatesMap<'tcx> {
1119 /// For each struct with outlive bounds, maps to a vector of the
1120 /// predicate of its outlive bounds. If an item has no outlives
1121 /// bounds, it will have no entry.
1122 pub predicates: FxHashMap<DefId, &'tcx [ty::Predicate<'tcx>]>,
1125 impl<'tcx> AsRef<Predicate<'tcx>> for Predicate<'tcx> {
1126 fn as_ref(&self) -> &Predicate<'tcx> {
1131 impl<'a, 'gcx, 'tcx> Predicate<'tcx> {
1132 /// Performs a substitution suitable for going from a
1133 /// poly-trait-ref to supertraits that must hold if that
1134 /// poly-trait-ref holds. This is slightly different from a normal
1135 /// substitution in terms of what happens with bound regions. See
1136 /// lengthy comment below for details.
1137 pub fn subst_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1138 trait_ref: &ty::PolyTraitRef<'tcx>)
1139 -> ty::Predicate<'tcx>
1141 // The interaction between HRTB and supertraits is not entirely
1142 // obvious. Let me walk you (and myself) through an example.
1144 // Let's start with an easy case. Consider two traits:
1146 // trait Foo<'a>: Bar<'a,'a> { }
1147 // trait Bar<'b,'c> { }
1149 // Now, if we have a trait reference `for<'x> T: Foo<'x>`, then
1150 // we can deduce that `for<'x> T: Bar<'x,'x>`. Basically, if we
1151 // knew that `Foo<'x>` (for any 'x) then we also know that
1152 // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
1153 // normal substitution.
1155 // In terms of why this is sound, the idea is that whenever there
1156 // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
1157 // holds. So if there is an impl of `T:Foo<'a>` that applies to
1158 // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
1161 // Another example to be careful of is this:
1163 // trait Foo1<'a>: for<'b> Bar1<'a,'b> { }
1164 // trait Bar1<'b,'c> { }
1166 // Here, if we have `for<'x> T: Foo1<'x>`, then what do we know?
1167 // The answer is that we know `for<'x,'b> T: Bar1<'x,'b>`. The
1168 // reason is similar to the previous example: any impl of
1169 // `T:Foo1<'x>` must show that `for<'b> T: Bar1<'x, 'b>`. So
1170 // basically we would want to collapse the bound lifetimes from
1171 // the input (`trait_ref`) and the supertraits.
1173 // To achieve this in practice is fairly straightforward. Let's
1174 // consider the more complicated scenario:
1176 // - We start out with `for<'x> T: Foo1<'x>`. In this case, `'x`
1177 // has a De Bruijn index of 1. We want to produce `for<'x,'b> T: Bar1<'x,'b>`,
1178 // where both `'x` and `'b` would have a DB index of 1.
1179 // The substitution from the input trait-ref is therefore going to be
1180 // `'a => 'x` (where `'x` has a DB index of 1).
1181 // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
1182 // early-bound parameter and `'b' is a late-bound parameter with a
1184 // - If we replace `'a` with `'x` from the input, it too will have
1185 // a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
1186 // just as we wanted.
1188 // There is only one catch. If we just apply the substitution `'a
1189 // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
1190 // adjust the DB index because we substituting into a binder (it
1191 // tries to be so smart...) resulting in `for<'x> for<'b>
1192 // Bar1<'x,'b>` (we have no syntax for this, so use your
1193 // imagination). Basically the 'x will have DB index of 2 and 'b
1194 // will have DB index of 1. Not quite what we want. So we apply
1195 // the substitution to the *contents* of the trait reference,
1196 // rather than the trait reference itself (put another way, the
1197 // substitution code expects equal binding levels in the values
1198 // from the substitution and the value being substituted into, and
1199 // this trick achieves that).
1201 let substs = &trait_ref.skip_binder().substs;
1203 Predicate::Trait(ref binder) =>
1204 Predicate::Trait(binder.map_bound(|data| data.subst(tcx, substs))),
1205 Predicate::Subtype(ref binder) =>
1206 Predicate::Subtype(binder.map_bound(|data| data.subst(tcx, substs))),
1207 Predicate::RegionOutlives(ref binder) =>
1208 Predicate::RegionOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1209 Predicate::TypeOutlives(ref binder) =>
1210 Predicate::TypeOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1211 Predicate::Projection(ref binder) =>
1212 Predicate::Projection(binder.map_bound(|data| data.subst(tcx, substs))),
1213 Predicate::WellFormed(data) =>
1214 Predicate::WellFormed(data.subst(tcx, substs)),
1215 Predicate::ObjectSafe(trait_def_id) =>
1216 Predicate::ObjectSafe(trait_def_id),
1217 Predicate::ClosureKind(closure_def_id, closure_substs, kind) =>
1218 Predicate::ClosureKind(closure_def_id, closure_substs.subst(tcx, substs), kind),
1219 Predicate::ConstEvaluatable(def_id, const_substs) =>
1220 Predicate::ConstEvaluatable(def_id, const_substs.subst(tcx, substs)),
1225 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
1226 pub struct TraitPredicate<'tcx> {
1227 pub trait_ref: TraitRef<'tcx>
1230 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
1232 impl<'tcx> TraitPredicate<'tcx> {
1233 pub fn def_id(&self) -> DefId {
1234 self.trait_ref.def_id
1237 pub fn input_types<'a>(&'a self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> + 'a {
1238 self.trait_ref.input_types()
1241 pub fn self_ty(&self) -> Ty<'tcx> {
1242 self.trait_ref.self_ty()
1246 impl<'tcx> PolyTraitPredicate<'tcx> {
1247 pub fn def_id(&self) -> DefId {
1248 // Ok to skip binder since trait def-ID does not care about regions.
1249 self.skip_binder().def_id()
1253 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord,
1254 Hash, Debug, RustcEncodable, RustcDecodable, HashStable)]
1255 pub struct OutlivesPredicate<A, B>(pub A, pub B); // `A: B`
1256 pub type PolyOutlivesPredicate<A, B> = ty::Binder<OutlivesPredicate<A, B>>;
1257 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>;
1258 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>;
1259 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<RegionOutlivesPredicate<'tcx>>;
1260 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<TypeOutlivesPredicate<'tcx>>;
1262 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable, HashStable)]
1263 pub struct SubtypePredicate<'tcx> {
1264 pub a_is_expected: bool,
1268 pub type PolySubtypePredicate<'tcx> = ty::Binder<SubtypePredicate<'tcx>>;
1270 /// This kind of predicate has no *direct* correspondent in the
1271 /// syntax, but it roughly corresponds to the syntactic forms:
1273 /// 1. `T: TraitRef<..., Item = Type>`
1274 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
1276 /// In particular, form #1 is "desugared" to the combination of a
1277 /// normal trait predicate (`T: TraitRef<...>`) and one of these
1278 /// predicates. Form #2 is a broader form in that it also permits
1279 /// equality between arbitrary types. Processing an instance of
1280 /// Form #2 eventually yields one of these `ProjectionPredicate`
1281 /// instances to normalize the LHS.
1282 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
1283 pub struct ProjectionPredicate<'tcx> {
1284 pub projection_ty: ProjectionTy<'tcx>,
1288 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
1290 impl<'tcx> PolyProjectionPredicate<'tcx> {
1291 /// Returns the `DefId` of the associated item being projected.
1292 pub fn item_def_id(&self) -> DefId {
1293 self.skip_binder().projection_ty.item_def_id
1297 pub fn to_poly_trait_ref(&self, tcx: TyCtxt<'_, '_, '_>) -> PolyTraitRef<'tcx> {
1298 // Note: unlike with `TraitRef::to_poly_trait_ref()`,
1299 // `self.0.trait_ref` is permitted to have escaping regions.
1300 // This is because here `self` has a `Binder` and so does our
1301 // return value, so we are preserving the number of binding
1303 self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
1306 pub fn ty(&self) -> Binder<Ty<'tcx>> {
1307 self.map_bound(|predicate| predicate.ty)
1310 /// The `DefId` of the `TraitItem` for the associated type.
1312 /// Note that this is not the `DefId` of the `TraitRef` containing this
1313 /// associated type, which is in `tcx.associated_item(projection_def_id()).container`.
1314 pub fn projection_def_id(&self) -> DefId {
1315 // Ok to skip binder since trait def-ID does not care about regions.
1316 self.skip_binder().projection_ty.item_def_id
1320 pub trait ToPolyTraitRef<'tcx> {
1321 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
1324 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
1325 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1326 ty::Binder::dummy(self.clone())
1330 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
1331 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1332 self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
1336 pub trait ToPredicate<'tcx> {
1337 fn to_predicate(&self) -> Predicate<'tcx>;
1340 impl<'tcx> ToPredicate<'tcx> for TraitRef<'tcx> {
1341 fn to_predicate(&self) -> Predicate<'tcx> {
1342 ty::Predicate::Trait(ty::Binder::dummy(ty::TraitPredicate {
1343 trait_ref: self.clone()
1348 impl<'tcx> ToPredicate<'tcx> for PolyTraitRef<'tcx> {
1349 fn to_predicate(&self) -> Predicate<'tcx> {
1350 ty::Predicate::Trait(self.to_poly_trait_predicate())
1354 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1355 fn to_predicate(&self) -> Predicate<'tcx> {
1356 Predicate::RegionOutlives(self.clone())
1360 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1361 fn to_predicate(&self) -> Predicate<'tcx> {
1362 Predicate::TypeOutlives(self.clone())
1366 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1367 fn to_predicate(&self) -> Predicate<'tcx> {
1368 Predicate::Projection(self.clone())
1372 // A custom iterator used by `Predicate::walk_tys`.
1373 enum WalkTysIter<'tcx, I, J, K>
1374 where I: Iterator<Item = Ty<'tcx>>,
1375 J: Iterator<Item = Ty<'tcx>>,
1376 K: Iterator<Item = Ty<'tcx>>
1380 Two(Ty<'tcx>, Ty<'tcx>),
1386 impl<'tcx, I, J, K> Iterator for WalkTysIter<'tcx, I, J, K>
1387 where I: Iterator<Item = Ty<'tcx>>,
1388 J: Iterator<Item = Ty<'tcx>>,
1389 K: Iterator<Item = Ty<'tcx>>
1391 type Item = Ty<'tcx>;
1393 fn next(&mut self) -> Option<Ty<'tcx>> {
1395 WalkTysIter::None => None,
1396 WalkTysIter::One(item) => {
1397 *self = WalkTysIter::None;
1400 WalkTysIter::Two(item1, item2) => {
1401 *self = WalkTysIter::One(item2);
1404 WalkTysIter::Types(ref mut iter) => {
1407 WalkTysIter::InputTypes(ref mut iter) => {
1410 WalkTysIter::ProjectionTypes(ref mut iter) => {
1417 impl<'tcx> Predicate<'tcx> {
1418 /// Iterates over the types in this predicate. Note that in all
1419 /// cases this is skipping over a binder, so late-bound regions
1420 /// with depth 0 are bound by the predicate.
1421 pub fn walk_tys(&'a self) -> impl Iterator<Item = Ty<'tcx>> + 'a {
1423 ty::Predicate::Trait(ref data) => {
1424 WalkTysIter::InputTypes(data.skip_binder().input_types())
1426 ty::Predicate::Subtype(binder) => {
1427 let SubtypePredicate { a, b, a_is_expected: _ } = binder.skip_binder();
1428 WalkTysIter::Two(a, b)
1430 ty::Predicate::TypeOutlives(binder) => {
1431 WalkTysIter::One(binder.skip_binder().0)
1433 ty::Predicate::RegionOutlives(..) => {
1436 ty::Predicate::Projection(ref data) => {
1437 let inner = data.skip_binder();
1438 WalkTysIter::ProjectionTypes(
1439 inner.projection_ty.substs.types().chain(Some(inner.ty)))
1441 ty::Predicate::WellFormed(data) => {
1442 WalkTysIter::One(data)
1444 ty::Predicate::ObjectSafe(_trait_def_id) => {
1447 ty::Predicate::ClosureKind(_closure_def_id, closure_substs, _kind) => {
1448 WalkTysIter::Types(closure_substs.substs.types())
1450 ty::Predicate::ConstEvaluatable(_, substs) => {
1451 WalkTysIter::Types(substs.types())
1456 pub fn to_opt_poly_trait_ref(&self) -> Option<PolyTraitRef<'tcx>> {
1458 Predicate::Trait(ref t) => {
1459 Some(t.to_poly_trait_ref())
1461 Predicate::Projection(..) |
1462 Predicate::Subtype(..) |
1463 Predicate::RegionOutlives(..) |
1464 Predicate::WellFormed(..) |
1465 Predicate::ObjectSafe(..) |
1466 Predicate::ClosureKind(..) |
1467 Predicate::TypeOutlives(..) |
1468 Predicate::ConstEvaluatable(..) => {
1474 pub fn to_opt_type_outlives(&self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1476 Predicate::TypeOutlives(data) => {
1479 Predicate::Trait(..) |
1480 Predicate::Projection(..) |
1481 Predicate::Subtype(..) |
1482 Predicate::RegionOutlives(..) |
1483 Predicate::WellFormed(..) |
1484 Predicate::ObjectSafe(..) |
1485 Predicate::ClosureKind(..) |
1486 Predicate::ConstEvaluatable(..) => {
1493 /// Represents the bounds declared on a particular set of type
1494 /// parameters. Should eventually be generalized into a flag list of
1495 /// where-clauses. You can obtain a `InstantiatedPredicates` list from a
1496 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1497 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1498 /// the `GenericPredicates` are expressed in terms of the bound type
1499 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1500 /// represented a set of bounds for some particular instantiation,
1501 /// meaning that the generic parameters have been substituted with
1506 /// struct Foo<T, U: Bar<T>> { ... }
1508 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1509 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1510 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1511 /// [usize:Bar<isize>]]`.
1512 #[derive(Clone, Debug)]
1513 pub struct InstantiatedPredicates<'tcx> {
1514 pub predicates: Vec<Predicate<'tcx>>,
1517 impl<'tcx> InstantiatedPredicates<'tcx> {
1518 pub fn empty() -> InstantiatedPredicates<'tcx> {
1519 InstantiatedPredicates { predicates: vec![] }
1522 pub fn is_empty(&self) -> bool {
1523 self.predicates.is_empty()
1528 /// "Universes" are used during type- and trait-checking in the
1529 /// presence of `for<..>` binders to control what sets of names are
1530 /// visible. Universes are arranged into a tree: the root universe
1531 /// contains names that are always visible. Each child then adds a new
1532 /// set of names that are visible, in addition to those of its parent.
1533 /// We say that the child universe "extends" the parent universe with
1536 /// To make this more concrete, consider this program:
1540 /// fn bar<T>(x: T) {
1541 /// let y: for<'a> fn(&'a u8, Foo) = ...;
1545 /// The struct name `Foo` is in the root universe U0. But the type
1546 /// parameter `T`, introduced on `bar`, is in an extended universe U1
1547 /// -- i.e., within `bar`, we can name both `T` and `Foo`, but outside
1548 /// of `bar`, we cannot name `T`. Then, within the type of `y`, the
1549 /// region `'a` is in a universe U2 that extends U1, because we can
1550 /// name it inside the fn type but not outside.
1552 /// Universes are used to do type- and trait-checking around these
1553 /// "forall" binders (also called **universal quantification**). The
1554 /// idea is that when, in the body of `bar`, we refer to `T` as a
1555 /// type, we aren't referring to any type in particular, but rather a
1556 /// kind of "fresh" type that is distinct from all other types we have
1557 /// actually declared. This is called a **placeholder** type, and we
1558 /// use universes to talk about this. In other words, a type name in
1559 /// universe 0 always corresponds to some "ground" type that the user
1560 /// declared, but a type name in a non-zero universe is a placeholder
1561 /// type -- an idealized representative of "types in general" that we
1562 /// use for checking generic functions.
1563 pub struct UniverseIndex {
1564 DEBUG_FORMAT = "U{}",
1568 impl_stable_hash_for!(struct UniverseIndex { private });
1570 impl UniverseIndex {
1571 pub const ROOT: UniverseIndex = UniverseIndex::from_u32_const(0);
1573 /// Returns the "next" universe index in order -- this new index
1574 /// is considered to extend all previous universes. This
1575 /// corresponds to entering a `forall` quantifier. So, for
1576 /// example, suppose we have this type in universe `U`:
1579 /// for<'a> fn(&'a u32)
1582 /// Once we "enter" into this `for<'a>` quantifier, we are in a
1583 /// new universe that extends `U` -- in this new universe, we can
1584 /// name the region `'a`, but that region was not nameable from
1585 /// `U` because it was not in scope there.
1586 pub fn next_universe(self) -> UniverseIndex {
1587 UniverseIndex::from_u32(self.private.checked_add(1).unwrap())
1590 /// Returns `true` if `self` can name a name from `other` -- in other words,
1591 /// if the set of names in `self` is a superset of those in
1592 /// `other` (`self >= other`).
1593 pub fn can_name(self, other: UniverseIndex) -> bool {
1594 self.private >= other.private
1597 /// Returns `true` if `self` cannot name some names from `other` -- in other
1598 /// words, if the set of names in `self` is a strict subset of
1599 /// those in `other` (`self < other`).
1600 pub fn cannot_name(self, other: UniverseIndex) -> bool {
1601 self.private < other.private
1605 /// The "placeholder index" fully defines a placeholder region.
1606 /// Placeholder regions are identified by both a **universe** as well
1607 /// as a "bound-region" within that universe. The `bound_region` is
1608 /// basically a name -- distinct bound regions within the same
1609 /// universe are just two regions with an unknown relationship to one
1611 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, PartialOrd, Ord)]
1612 pub struct Placeholder<T> {
1613 pub universe: UniverseIndex,
1617 impl<'a, 'gcx, T> HashStable<StableHashingContext<'a>> for Placeholder<T>
1618 where T: HashStable<StableHashingContext<'a>>
1620 fn hash_stable<W: StableHasherResult>(
1622 hcx: &mut StableHashingContext<'a>,
1623 hasher: &mut StableHasher<W>
1625 self.universe.hash_stable(hcx, hasher);
1626 self.name.hash_stable(hcx, hasher);
1630 pub type PlaceholderRegion = Placeholder<BoundRegion>;
1632 pub type PlaceholderType = Placeholder<BoundVar>;
1634 pub type PlaceholderConst = Placeholder<BoundVar>;
1636 /// When type checking, we use the `ParamEnv` to track
1637 /// details about the set of where-clauses that are in scope at this
1638 /// particular point.
1639 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
1640 pub struct ParamEnv<'tcx> {
1641 /// Obligations that the caller must satisfy. This is basically
1642 /// the set of bounds on the in-scope type parameters, translated
1643 /// into Obligations, and elaborated and normalized.
1644 pub caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1646 /// Typically, this is `Reveal::UserFacing`, but during codegen we
1647 /// want `Reveal::All` -- note that this is always paired with an
1648 /// empty environment. To get that, use `ParamEnv::reveal()`.
1649 pub reveal: traits::Reveal,
1651 /// If this `ParamEnv` comes from a call to `tcx.param_env(def_id)`,
1652 /// register that `def_id` (useful for transitioning to the chalk trait
1654 pub def_id: Option<DefId>,
1657 impl<'tcx> ParamEnv<'tcx> {
1658 /// Construct a trait environment suitable for contexts where
1659 /// there are no where-clauses in scope. Hidden types (like `impl
1660 /// Trait`) are left hidden, so this is suitable for ordinary
1663 pub fn empty() -> Self {
1664 Self::new(List::empty(), Reveal::UserFacing, None)
1667 /// Construct a trait environment with no where-clauses in scope
1668 /// where the values of all `impl Trait` and other hidden types
1669 /// are revealed. This is suitable for monomorphized, post-typeck
1670 /// environments like codegen or doing optimizations.
1672 /// N.B., if you want to have predicates in scope, use `ParamEnv::new`,
1673 /// or invoke `param_env.with_reveal_all()`.
1675 pub fn reveal_all() -> Self {
1676 Self::new(List::empty(), Reveal::All, None)
1679 /// Construct a trait environment with the given set of predicates.
1682 caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1684 def_id: Option<DefId>
1686 ty::ParamEnv { caller_bounds, reveal, def_id }
1689 /// Returns a new parameter environment with the same clauses, but
1690 /// which "reveals" the true results of projections in all cases
1691 /// (even for associated types that are specializable). This is
1692 /// the desired behavior during codegen and certain other special
1693 /// contexts; normally though we want to use `Reveal::UserFacing`,
1694 /// which is the default.
1695 pub fn with_reveal_all(self) -> Self {
1696 ty::ParamEnv { reveal: Reveal::All, ..self }
1699 /// Returns this same environment but with no caller bounds.
1700 pub fn without_caller_bounds(self) -> Self {
1701 ty::ParamEnv { caller_bounds: List::empty(), ..self }
1704 /// Creates a suitable environment in which to perform trait
1705 /// queries on the given value. When type-checking, this is simply
1706 /// the pair of the environment plus value. But when reveal is set to
1707 /// All, then if `value` does not reference any type parameters, we will
1708 /// pair it with the empty environment. This improves caching and is generally
1711 /// N.B., we preserve the environment when type-checking because it
1712 /// is possible for the user to have wacky where-clauses like
1713 /// `where Box<u32>: Copy`, which are clearly never
1714 /// satisfiable. We generally want to behave as if they were true,
1715 /// although the surrounding function is never reachable.
1716 pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
1718 Reveal::UserFacing => {
1726 if value.has_placeholders()
1727 || value.needs_infer()
1728 || value.has_param_types()
1729 || value.has_self_ty()
1737 param_env: self.without_caller_bounds(),
1746 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
1747 pub struct ParamEnvAnd<'tcx, T> {
1748 pub param_env: ParamEnv<'tcx>,
1752 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
1753 pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
1754 (self.param_env, self.value)
1758 impl<'a, 'gcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'gcx, T>
1759 where T: HashStable<StableHashingContext<'a>>
1761 fn hash_stable<W: StableHasherResult>(&self,
1762 hcx: &mut StableHashingContext<'a>,
1763 hasher: &mut StableHasher<W>) {
1769 param_env.hash_stable(hcx, hasher);
1770 value.hash_stable(hcx, hasher);
1774 #[derive(Copy, Clone, Debug, HashStable)]
1775 pub struct Destructor {
1776 /// The `DefId` of the destructor method
1781 #[derive(HashStable)]
1782 pub struct AdtFlags: u32 {
1783 const NO_ADT_FLAGS = 0;
1784 /// Indicates whether the ADT is an enum.
1785 const IS_ENUM = 1 << 0;
1786 /// Indicates whether the ADT is a union.
1787 const IS_UNION = 1 << 1;
1788 /// Indicates whether the ADT is a struct.
1789 const IS_STRUCT = 1 << 2;
1790 /// Indicates whether the ADT is a struct and has a constructor.
1791 const HAS_CTOR = 1 << 3;
1792 /// Indicates whether the type is a `PhantomData`.
1793 const IS_PHANTOM_DATA = 1 << 4;
1794 /// Indicates whether the type has a `#[fundamental]` attribute.
1795 const IS_FUNDAMENTAL = 1 << 5;
1796 /// Indicates whether the type is a `Box`.
1797 const IS_BOX = 1 << 6;
1798 /// Indicates whether the type is an `Arc`.
1799 const IS_ARC = 1 << 7;
1800 /// Indicates whether the type is an `Rc`.
1801 const IS_RC = 1 << 8;
1802 /// Indicates whether the variant list of this ADT is `#[non_exhaustive]`.
1803 /// (i.e., this flag is never set unless this ADT is an enum).
1804 const IS_VARIANT_LIST_NON_EXHAUSTIVE = 1 << 9;
1809 #[derive(HashStable)]
1810 pub struct VariantFlags: u32 {
1811 const NO_VARIANT_FLAGS = 0;
1812 /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
1813 const IS_FIELD_LIST_NON_EXHAUSTIVE = 1 << 0;
1817 /// Definition of a variant -- a struct's fields or a enum variant.
1819 pub struct VariantDef {
1820 /// `DefId` that identifies the variant itself.
1821 /// If this variant belongs to a struct or union, then this is a copy of its `DefId`.
1823 /// `DefId` that identifies the variant's constructor.
1824 /// If this variant is a struct variant, then this is `None`.
1825 pub ctor_def_id: Option<DefId>,
1826 /// Variant or struct name.
1828 /// Discriminant of this variant.
1829 pub discr: VariantDiscr,
1830 /// Fields of this variant.
1831 pub fields: Vec<FieldDef>,
1832 /// Type of constructor of variant.
1833 pub ctor_kind: CtorKind,
1834 /// Flags of the variant (e.g. is field list non-exhaustive)?
1835 flags: VariantFlags,
1837 pub recovered: bool,
1840 impl<'a, 'gcx, 'tcx> VariantDef {
1841 /// Creates a new `VariantDef`.
1843 /// `variant_did` is the `DefId` that identifies the enum variant (if this `VariantDef`
1844 /// represents an enum variant).
1846 /// `ctor_did` is the `DefId` that identifies the constructor of unit or
1847 /// tuple-variants/structs. If this is a `struct`-variant then this should be `None`.
1849 /// `parent_did` is the `DefId` of the `AdtDef` representing the enum or struct that
1850 /// owns this variant. It is used for checking if a struct has `#[non_exhaustive]` w/out having
1851 /// to go through the redirect of checking the ctor's attributes - but compiling a small crate
1852 /// requires loading the `AdtDef`s for all the structs in the universe (e.g., coherence for any
1853 /// built-in trait), and we do not want to load attributes twice.
1855 /// If someone speeds up attribute loading to not be a performance concern, they can
1856 /// remove this hack and use the constructor `DefId` everywhere.
1858 tcx: TyCtxt<'a, 'gcx, 'tcx>,
1860 variant_did: Option<DefId>,
1861 ctor_def_id: Option<DefId>,
1862 discr: VariantDiscr,
1863 fields: Vec<FieldDef>,
1864 ctor_kind: CtorKind,
1870 "VariantDef::new(ident = {:?}, variant_did = {:?}, ctor_def_id = {:?}, discr = {:?},
1871 fields = {:?}, ctor_kind = {:?}, adt_kind = {:?}, parent_did = {:?})",
1872 ident, variant_did, ctor_def_id, discr, fields, ctor_kind, adt_kind, parent_did,
1875 let mut flags = VariantFlags::NO_VARIANT_FLAGS;
1876 if adt_kind == AdtKind::Struct && tcx.has_attr(parent_did, sym::non_exhaustive) {
1877 debug!("found non-exhaustive field list for {:?}", parent_did);
1878 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1879 } else if let Some(variant_did) = variant_did {
1880 if tcx.has_attr(variant_did, sym::non_exhaustive) {
1881 debug!("found non-exhaustive field list for {:?}", variant_did);
1882 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1887 def_id: variant_did.unwrap_or(parent_did),
1898 /// Is this field list non-exhaustive?
1900 pub fn is_field_list_non_exhaustive(&self) -> bool {
1901 self.flags.intersects(VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE)
1905 impl_stable_hash_for!(struct VariantDef {
1908 ident -> (ident.name),
1916 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable, HashStable)]
1917 pub enum VariantDiscr {
1918 /// Explicit value for this variant, i.e., `X = 123`.
1919 /// The `DefId` corresponds to the embedded constant.
1922 /// The previous variant's discriminant plus one.
1923 /// For efficiency reasons, the distance from the
1924 /// last `Explicit` discriminant is being stored,
1925 /// or `0` for the first variant, if it has none.
1929 #[derive(Debug, HashStable)]
1930 pub struct FieldDef {
1932 #[stable_hasher(project(name))]
1934 pub vis: Visibility,
1937 /// The definition of an abstract data type -- a struct or enum.
1939 /// These are all interned (by `intern_adt_def`) into the `adt_defs` table.
1941 /// `DefId` of the struct, enum or union item.
1943 /// Variants of the ADT. If this is a struct or enum, then there will be a single variant.
1944 pub variants: IndexVec<self::layout::VariantIdx, VariantDef>,
1945 /// Flags of the ADT (e.g. is this a struct? is this non-exhaustive?)
1947 /// Repr options provided by the user.
1948 pub repr: ReprOptions,
1951 impl PartialOrd for AdtDef {
1952 fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering> {
1953 Some(self.cmp(&other))
1957 /// There should be only one AdtDef for each `did`, therefore
1958 /// it is fine to implement `Ord` only based on `did`.
1959 impl Ord for AdtDef {
1960 fn cmp(&self, other: &AdtDef) -> Ordering {
1961 self.did.cmp(&other.did)
1965 impl PartialEq for AdtDef {
1966 // AdtDef are always interned and this is part of TyS equality
1968 fn eq(&self, other: &Self) -> bool { ptr::eq(self, other) }
1971 impl Eq for AdtDef {}
1973 impl Hash for AdtDef {
1975 fn hash<H: Hasher>(&self, s: &mut H) {
1976 (self as *const AdtDef).hash(s)
1980 impl<'tcx> serialize::UseSpecializedEncodable for &'tcx AdtDef {
1981 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1986 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx AdtDef {}
1989 impl<'a> HashStable<StableHashingContext<'a>> for AdtDef {
1990 fn hash_stable<W: StableHasherResult>(&self,
1991 hcx: &mut StableHashingContext<'a>,
1992 hasher: &mut StableHasher<W>) {
1994 static CACHE: RefCell<FxHashMap<usize, Fingerprint>> = Default::default();
1997 let hash: Fingerprint = CACHE.with(|cache| {
1998 let addr = self as *const AdtDef as usize;
1999 *cache.borrow_mut().entry(addr).or_insert_with(|| {
2007 let mut hasher = StableHasher::new();
2008 did.hash_stable(hcx, &mut hasher);
2009 variants.hash_stable(hcx, &mut hasher);
2010 flags.hash_stable(hcx, &mut hasher);
2011 repr.hash_stable(hcx, &mut hasher);
2017 hash.hash_stable(hcx, hasher);
2021 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
2022 pub enum AdtKind { Struct, Union, Enum }
2024 impl Into<DataTypeKind> for AdtKind {
2025 fn into(self) -> DataTypeKind {
2027 AdtKind::Struct => DataTypeKind::Struct,
2028 AdtKind::Union => DataTypeKind::Union,
2029 AdtKind::Enum => DataTypeKind::Enum,
2035 #[derive(RustcEncodable, RustcDecodable, Default)]
2036 pub struct ReprFlags: u8 {
2037 const IS_C = 1 << 0;
2038 const IS_SIMD = 1 << 1;
2039 const IS_TRANSPARENT = 1 << 2;
2040 // Internal only for now. If true, don't reorder fields.
2041 const IS_LINEAR = 1 << 3;
2043 // Any of these flags being set prevent field reordering optimisation.
2044 const IS_UNOPTIMISABLE = ReprFlags::IS_C.bits |
2045 ReprFlags::IS_SIMD.bits |
2046 ReprFlags::IS_LINEAR.bits;
2050 impl_stable_hash_for!(struct ReprFlags {
2054 /// Represents the repr options provided by the user,
2055 #[derive(Copy, Clone, Debug, Eq, PartialEq, RustcEncodable, RustcDecodable, Default)]
2056 pub struct ReprOptions {
2057 pub int: Option<attr::IntType>,
2060 pub flags: ReprFlags,
2063 impl_stable_hash_for!(struct ReprOptions {
2071 pub fn new(tcx: TyCtxt<'_, '_, '_>, did: DefId) -> ReprOptions {
2072 let mut flags = ReprFlags::empty();
2073 let mut size = None;
2074 let mut max_align = 0;
2075 let mut min_pack = 0;
2076 for attr in tcx.get_attrs(did).iter() {
2077 for r in attr::find_repr_attrs(&tcx.sess.parse_sess, attr) {
2078 flags.insert(match r {
2079 attr::ReprC => ReprFlags::IS_C,
2080 attr::ReprPacked(pack) => {
2081 min_pack = if min_pack > 0 {
2082 cmp::min(pack, min_pack)
2088 attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
2089 attr::ReprSimd => ReprFlags::IS_SIMD,
2090 attr::ReprInt(i) => {
2094 attr::ReprAlign(align) => {
2095 max_align = cmp::max(align, max_align);
2102 // This is here instead of layout because the choice must make it into metadata.
2103 if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.def_path_str(did))) {
2104 flags.insert(ReprFlags::IS_LINEAR);
2106 ReprOptions { int: size, align: max_align, pack: min_pack, flags: flags }
2110 pub fn simd(&self) -> bool { self.flags.contains(ReprFlags::IS_SIMD) }
2112 pub fn c(&self) -> bool { self.flags.contains(ReprFlags::IS_C) }
2114 pub fn packed(&self) -> bool { self.pack > 0 }
2116 pub fn transparent(&self) -> bool { self.flags.contains(ReprFlags::IS_TRANSPARENT) }
2118 pub fn linear(&self) -> bool { self.flags.contains(ReprFlags::IS_LINEAR) }
2120 pub fn discr_type(&self) -> attr::IntType {
2121 self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
2124 /// Returns `true` if this `#[repr()]` should inhabit "smart enum
2125 /// layout" optimizations, such as representing `Foo<&T>` as a
2127 pub fn inhibit_enum_layout_opt(&self) -> bool {
2128 self.c() || self.int.is_some()
2131 /// Returns `true` if this `#[repr()]` should inhibit struct field reordering
2132 /// optimizations, such as with `repr(C)`, `repr(packed(1))`, or `repr(<int>)`.
2133 pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
2134 self.flags.intersects(ReprFlags::IS_UNOPTIMISABLE) || self.pack == 1 ||
2138 /// Returns `true` if this `#[repr()]` should inhibit union ABI optimisations.
2139 pub fn inhibit_union_abi_opt(&self) -> bool {
2145 impl<'a, 'gcx, 'tcx> AdtDef {
2146 /// Creates a new `AdtDef`.
2148 tcx: TyCtxt<'_, '_, '_>,
2151 variants: IndexVec<VariantIdx, VariantDef>,
2154 debug!("AdtDef::new({:?}, {:?}, {:?}, {:?})", did, kind, variants, repr);
2155 let mut flags = AdtFlags::NO_ADT_FLAGS;
2157 if kind == AdtKind::Enum && tcx.has_attr(did, sym::non_exhaustive) {
2158 debug!("found non-exhaustive variant list for {:?}", did);
2159 flags = flags | AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE;
2162 flags |= match kind {
2163 AdtKind::Enum => AdtFlags::IS_ENUM,
2164 AdtKind::Union => AdtFlags::IS_UNION,
2165 AdtKind::Struct => AdtFlags::IS_STRUCT,
2168 if kind == AdtKind::Struct && variants[VariantIdx::new(0)].ctor_def_id.is_some() {
2169 flags |= AdtFlags::HAS_CTOR;
2172 let attrs = tcx.get_attrs(did);
2173 if attr::contains_name(&attrs, sym::fundamental) {
2174 flags |= AdtFlags::IS_FUNDAMENTAL;
2176 if Some(did) == tcx.lang_items().phantom_data() {
2177 flags |= AdtFlags::IS_PHANTOM_DATA;
2179 if Some(did) == tcx.lang_items().owned_box() {
2180 flags |= AdtFlags::IS_BOX;
2182 if Some(did) == tcx.lang_items().arc() {
2183 flags |= AdtFlags::IS_ARC;
2185 if Some(did) == tcx.lang_items().rc() {
2186 flags |= AdtFlags::IS_RC;
2197 /// Returns `true` if this is a struct.
2199 pub fn is_struct(&self) -> bool {
2200 self.flags.contains(AdtFlags::IS_STRUCT)
2203 /// Returns `true` if this is a union.
2205 pub fn is_union(&self) -> bool {
2206 self.flags.contains(AdtFlags::IS_UNION)
2209 /// Returns `true` if this is a enum.
2211 pub fn is_enum(&self) -> bool {
2212 self.flags.contains(AdtFlags::IS_ENUM)
2215 /// Returns `true` if the variant list of this ADT is `#[non_exhaustive]`.
2217 pub fn is_variant_list_non_exhaustive(&self) -> bool {
2218 self.flags.contains(AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE)
2221 /// Returns the kind of the ADT.
2223 pub fn adt_kind(&self) -> AdtKind {
2226 } else if self.is_union() {
2233 /// Returns a description of this abstract data type.
2234 pub fn descr(&self) -> &'static str {
2235 match self.adt_kind() {
2236 AdtKind::Struct => "struct",
2237 AdtKind::Union => "union",
2238 AdtKind::Enum => "enum",
2242 /// Returns a description of a variant of this abstract data type.
2244 pub fn variant_descr(&self) -> &'static str {
2245 match self.adt_kind() {
2246 AdtKind::Struct => "struct",
2247 AdtKind::Union => "union",
2248 AdtKind::Enum => "variant",
2252 /// If this function returns `true`, it implies that `is_struct` must return `true`.
2254 pub fn has_ctor(&self) -> bool {
2255 self.flags.contains(AdtFlags::HAS_CTOR)
2258 /// Returns `true` if this type is `#[fundamental]` for the purposes
2259 /// of coherence checking.
2261 pub fn is_fundamental(&self) -> bool {
2262 self.flags.contains(AdtFlags::IS_FUNDAMENTAL)
2265 /// Returns `true` if this is `PhantomData<T>`.
2267 pub fn is_phantom_data(&self) -> bool {
2268 self.flags.contains(AdtFlags::IS_PHANTOM_DATA)
2271 /// Returns `true` if this is `Arc<T>`.
2272 pub fn is_arc(&self) -> bool {
2273 self.flags.contains(AdtFlags::IS_ARC)
2276 /// Returns `true` if this is `Rc<T>`.
2277 pub fn is_rc(&self) -> bool {
2278 self.flags.contains(AdtFlags::IS_RC)
2281 /// Returns `true` if this is Box<T>.
2283 pub fn is_box(&self) -> bool {
2284 self.flags.contains(AdtFlags::IS_BOX)
2287 /// Returns `true` if this type has a destructor.
2288 pub fn has_dtor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
2289 self.destructor(tcx).is_some()
2292 /// Asserts this is a struct or union and returns its unique variant.
2293 pub fn non_enum_variant(&self) -> &VariantDef {
2294 assert!(self.is_struct() || self.is_union());
2295 &self.variants[VariantIdx::new(0)]
2299 pub fn predicates(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> &'tcx GenericPredicates<'gcx> {
2300 tcx.predicates_of(self.did)
2303 /// Returns an iterator over all fields contained
2306 pub fn all_fields<'s>(&'s self) -> impl Iterator<Item = &'s FieldDef> {
2307 self.variants.iter().flat_map(|v| v.fields.iter())
2310 pub fn is_payloadfree(&self) -> bool {
2311 !self.variants.is_empty() &&
2312 self.variants.iter().all(|v| v.fields.is_empty())
2315 /// Return a `VariantDef` given a variant id.
2316 pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
2317 self.variants.iter().find(|v| v.def_id == vid)
2318 .expect("variant_with_id: unknown variant")
2321 /// Return a `VariantDef` given a constructor id.
2322 pub fn variant_with_ctor_id(&self, cid: DefId) -> &VariantDef {
2323 self.variants.iter().find(|v| v.ctor_def_id == Some(cid))
2324 .expect("variant_with_ctor_id: unknown variant")
2327 /// Return the index of `VariantDef` given a variant id.
2328 pub fn variant_index_with_id(&self, vid: DefId) -> VariantIdx {
2329 self.variants.iter_enumerated().find(|(_, v)| v.def_id == vid)
2330 .expect("variant_index_with_id: unknown variant").0
2333 /// Return the index of `VariantDef` given a constructor id.
2334 pub fn variant_index_with_ctor_id(&self, cid: DefId) -> VariantIdx {
2335 self.variants.iter_enumerated().find(|(_, v)| v.ctor_def_id == Some(cid))
2336 .expect("variant_index_with_ctor_id: unknown variant").0
2339 pub fn variant_of_res(&self, res: Res) -> &VariantDef {
2341 Res::Def(DefKind::Variant, vid) => self.variant_with_id(vid),
2342 Res::Def(DefKind::Ctor(..), cid) => self.variant_with_ctor_id(cid),
2343 Res::Def(DefKind::Struct, _) | Res::Def(DefKind::Union, _) |
2344 Res::Def(DefKind::TyAlias, _) | Res::Def(DefKind::AssocTy, _) | Res::SelfTy(..) |
2345 Res::SelfCtor(..) => self.non_enum_variant(),
2346 _ => bug!("unexpected res {:?} in variant_of_res", res)
2351 pub fn eval_explicit_discr(
2353 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2355 ) -> Option<Discr<'tcx>> {
2356 let param_env = ParamEnv::empty();
2357 let repr_type = self.repr.discr_type();
2358 let substs = InternalSubsts::identity_for_item(tcx.global_tcx(), expr_did);
2359 let instance = ty::Instance::new(expr_did, substs);
2360 let cid = GlobalId {
2364 match tcx.const_eval(param_env.and(cid)) {
2366 // FIXME: Find the right type and use it instead of `val.ty` here
2367 if let Some(b) = val.assert_bits(tcx.global_tcx(), param_env.and(val.ty)) {
2368 trace!("discriminants: {} ({:?})", b, repr_type);
2374 info!("invalid enum discriminant: {:#?}", val);
2375 crate::mir::interpret::struct_error(
2376 tcx.at(tcx.def_span(expr_did)),
2377 "constant evaluation of enum discriminant resulted in non-integer",
2382 Err(ErrorHandled::Reported) => {
2383 if !expr_did.is_local() {
2384 span_bug!(tcx.def_span(expr_did),
2385 "variant discriminant evaluation succeeded \
2386 in its crate but failed locally");
2390 Err(ErrorHandled::TooGeneric) => span_bug!(
2391 tcx.def_span(expr_did),
2392 "enum discriminant depends on generic arguments",
2398 pub fn discriminants(
2400 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2401 ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'gcx> + 'a {
2402 let repr_type = self.repr.discr_type();
2403 let initial = repr_type.initial_discriminant(tcx.global_tcx());
2404 let mut prev_discr = None::<Discr<'tcx>>;
2405 self.variants.iter_enumerated().map(move |(i, v)| {
2406 let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
2407 if let VariantDiscr::Explicit(expr_did) = v.discr {
2408 if let Some(new_discr) = self.eval_explicit_discr(tcx, expr_did) {
2412 prev_discr = Some(discr);
2419 pub fn variant_range(&self) -> Range<VariantIdx> {
2420 (VariantIdx::new(0)..VariantIdx::new(self.variants.len()))
2423 /// Computes the discriminant value used by a specific variant.
2424 /// Unlike `discriminants`, this is (amortized) constant-time,
2425 /// only doing at most one query for evaluating an explicit
2426 /// discriminant (the last one before the requested variant),
2427 /// assuming there are no constant-evaluation errors there.
2429 pub fn discriminant_for_variant(&self,
2430 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2431 variant_index: VariantIdx)
2433 let (val, offset) = self.discriminant_def_for_variant(variant_index);
2434 let explicit_value = val
2435 .and_then(|expr_did| self.eval_explicit_discr(tcx, expr_did))
2436 .unwrap_or_else(|| self.repr.discr_type().initial_discriminant(tcx.global_tcx()));
2437 explicit_value.checked_add(tcx, offset as u128).0
2440 /// Yields a `DefId` for the discriminant and an offset to add to it
2441 /// Alternatively, if there is no explicit discriminant, returns the
2442 /// inferred discriminant directly.
2443 pub fn discriminant_def_for_variant(
2445 variant_index: VariantIdx,
2446 ) -> (Option<DefId>, u32) {
2447 let mut explicit_index = variant_index.as_u32();
2450 match self.variants[VariantIdx::from_u32(explicit_index)].discr {
2451 ty::VariantDiscr::Relative(0) => {
2455 ty::VariantDiscr::Relative(distance) => {
2456 explicit_index -= distance;
2458 ty::VariantDiscr::Explicit(did) => {
2459 expr_did = Some(did);
2464 (expr_did, variant_index.as_u32() - explicit_index)
2467 pub fn destructor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Option<Destructor> {
2468 tcx.adt_destructor(self.did)
2471 /// Returns a list of types such that `Self: Sized` if and only
2472 /// if that type is `Sized`, or `TyErr` if this type is recursive.
2474 /// Oddly enough, checking that the sized-constraint is `Sized` is
2475 /// actually more expressive than checking all members:
2476 /// the `Sized` trait is inductive, so an associated type that references
2477 /// `Self` would prevent its containing ADT from being `Sized`.
2479 /// Due to normalization being eager, this applies even if
2480 /// the associated type is behind a pointer (e.g., issue #31299).
2481 pub fn sized_constraint(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> &'tcx [Ty<'tcx>] {
2482 tcx.adt_sized_constraint(self.did).0
2485 fn sized_constraint_for_ty(&self,
2486 tcx: TyCtxt<'a, 'tcx, 'tcx>,
2489 let result = match ty.sty {
2490 Bool | Char | Int(..) | Uint(..) | Float(..) |
2491 RawPtr(..) | Ref(..) | FnDef(..) | FnPtr(_) |
2492 Array(..) | Closure(..) | Generator(..) | Never => {
2501 GeneratorWitness(..) => {
2502 // these are never sized - return the target type
2509 Some(ty) => self.sized_constraint_for_ty(tcx, ty.expect_ty()),
2513 Adt(adt, substs) => {
2515 let adt_tys = adt.sized_constraint(tcx);
2516 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}",
2519 .map(|ty| ty.subst(tcx, substs))
2520 .flat_map(|ty| self.sized_constraint_for_ty(tcx, ty))
2524 Projection(..) | Opaque(..) => {
2525 // must calculate explicitly.
2526 // FIXME: consider special-casing always-Sized projections
2530 UnnormalizedProjection(..) => bug!("only used with chalk-engine"),
2533 // perf hack: if there is a `T: Sized` bound, then
2534 // we know that `T` is Sized and do not need to check
2537 let sized_trait = match tcx.lang_items().sized_trait() {
2539 _ => return vec![ty]
2541 let sized_predicate = Binder::dummy(TraitRef {
2542 def_id: sized_trait,
2543 substs: tcx.mk_substs_trait(ty, &[])
2545 let predicates = &tcx.predicates_of(self.did).predicates;
2546 if predicates.iter().any(|(p, _)| *p == sized_predicate) {
2556 bug!("unexpected type `{:?}` in sized_constraint_for_ty",
2560 debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
2565 impl<'a, 'gcx, 'tcx> FieldDef {
2566 pub fn ty(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, subst: SubstsRef<'tcx>) -> Ty<'tcx> {
2567 tcx.type_of(self.did).subst(tcx, subst)
2571 /// Represents the various closure traits in the language. This
2572 /// will determine the type of the environment (`self`, in the
2573 /// desugaring) argument that the closure expects.
2575 /// You can get the environment type of a closure using
2576 /// `tcx.closure_env_ty()`.
2577 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug,
2578 RustcEncodable, RustcDecodable, HashStable)]
2579 pub enum ClosureKind {
2580 // Warning: Ordering is significant here! The ordering is chosen
2581 // because the trait Fn is a subtrait of FnMut and so in turn, and
2582 // hence we order it so that Fn < FnMut < FnOnce.
2588 impl<'a, 'tcx> ClosureKind {
2589 // This is the initial value used when doing upvar inference.
2590 pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn;
2592 pub fn trait_did(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> DefId {
2594 ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem),
2595 ClosureKind::FnMut => {
2596 tcx.require_lang_item(FnMutTraitLangItem)
2598 ClosureKind::FnOnce => {
2599 tcx.require_lang_item(FnOnceTraitLangItem)
2604 /// Returns `true` if this a type that impls this closure kind
2605 /// must also implement `other`.
2606 pub fn extends(self, other: ty::ClosureKind) -> bool {
2607 match (self, other) {
2608 (ClosureKind::Fn, ClosureKind::Fn) => true,
2609 (ClosureKind::Fn, ClosureKind::FnMut) => true,
2610 (ClosureKind::Fn, ClosureKind::FnOnce) => true,
2611 (ClosureKind::FnMut, ClosureKind::FnMut) => true,
2612 (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
2613 (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
2618 /// Returns the representative scalar type for this closure kind.
2619 /// See `TyS::to_opt_closure_kind` for more details.
2620 pub fn to_ty(self, tcx: TyCtxt<'_, '_, 'tcx>) -> Ty<'tcx> {
2622 ty::ClosureKind::Fn => tcx.types.i8,
2623 ty::ClosureKind::FnMut => tcx.types.i16,
2624 ty::ClosureKind::FnOnce => tcx.types.i32,
2629 impl<'tcx> TyS<'tcx> {
2630 /// Iterator that walks `self` and any types reachable from
2631 /// `self`, in depth-first order. Note that just walks the types
2632 /// that appear in `self`, it does not descend into the fields of
2633 /// structs or variants. For example:
2636 /// isize => { isize }
2637 /// Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
2638 /// [isize] => { [isize], isize }
2640 pub fn walk(&'tcx self) -> TypeWalker<'tcx> {
2641 TypeWalker::new(self)
2644 /// Iterator that walks the immediate children of `self`. Hence
2645 /// `Foo<Bar<i32>, u32>` yields the sequence `[Bar<i32>, u32]`
2646 /// (but not `i32`, like `walk`).
2647 pub fn walk_shallow(&'tcx self) -> smallvec::IntoIter<walk::TypeWalkerArray<'tcx>> {
2648 walk::walk_shallow(self)
2651 /// Walks `ty` and any types appearing within `ty`, invoking the
2652 /// callback `f` on each type. If the callback returns `false`, then the
2653 /// children of the current type are ignored.
2655 /// Note: prefer `ty.walk()` where possible.
2656 pub fn maybe_walk<F>(&'tcx self, mut f: F)
2657 where F: FnMut(Ty<'tcx>) -> bool
2659 let mut walker = self.walk();
2660 while let Some(ty) = walker.next() {
2662 walker.skip_current_subtree();
2669 pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
2671 hir::MutMutable => MutBorrow,
2672 hir::MutImmutable => ImmBorrow,
2676 /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
2677 /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
2678 /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
2680 pub fn to_mutbl_lossy(self) -> hir::Mutability {
2682 MutBorrow => hir::MutMutable,
2683 ImmBorrow => hir::MutImmutable,
2685 // We have no type corresponding to a unique imm borrow, so
2686 // use `&mut`. It gives all the capabilities of an `&uniq`
2687 // and hence is a safe "over approximation".
2688 UniqueImmBorrow => hir::MutMutable,
2692 pub fn to_user_str(&self) -> &'static str {
2694 MutBorrow => "mutable",
2695 ImmBorrow => "immutable",
2696 UniqueImmBorrow => "uniquely immutable",
2701 #[derive(Debug, Clone)]
2702 pub enum Attributes<'gcx> {
2703 Owned(Lrc<[ast::Attribute]>),
2704 Borrowed(&'gcx [ast::Attribute])
2707 impl<'gcx> ::std::ops::Deref for Attributes<'gcx> {
2708 type Target = [ast::Attribute];
2710 fn deref(&self) -> &[ast::Attribute] {
2712 &Attributes::Owned(ref data) => &data,
2713 &Attributes::Borrowed(data) => data
2718 #[derive(Debug, PartialEq, Eq)]
2719 pub enum ImplOverlapKind {
2720 /// These impls are always allowed to overlap.
2722 /// These impls are allowed to overlap, but that raises
2723 /// an issue #33140 future-compatibility warning.
2725 /// Some background: in Rust 1.0, the trait-object types `Send + Sync` (today's
2726 /// `dyn Send + Sync`) and `Sync + Send` (now `dyn Sync + Send`) were different.
2728 /// The widely-used version 0.1.0 of the crate `traitobject` had accidentally relied
2729 /// that difference, making what reduces to the following set of impls:
2733 /// impl Trait for dyn Send + Sync {}
2734 /// impl Trait for dyn Sync + Send {}
2737 /// Obviously, once we made these types be identical, that code causes a coherence
2738 /// error and a fairly big headache for us. However, luckily for us, the trait
2739 /// `Trait` used in this case is basically a marker trait, and therefore having
2740 /// overlapping impls for it is sound.
2742 /// To handle this, we basically regard the trait as a marker trait, with an additional
2743 /// future-compatibility warning. To avoid accidentally "stabilizing" this feature,
2744 /// it has the following restrictions:
2746 /// 1. The trait must indeed be a marker-like trait (i.e., no items), and must be
2748 /// 2. The trait-ref of both impls must be equal.
2749 /// 3. The trait-ref of both impls must be a trait object type consisting only of
2751 /// 4. Neither of the impls can have any where-clauses.
2753 /// Once `traitobject` 0.1.0 is no longer an active concern, this hack can be removed.
2757 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2758 pub fn body_tables(self, body: hir::BodyId) -> &'gcx TypeckTables<'gcx> {
2759 self.typeck_tables_of(self.hir().body_owner_def_id(body))
2762 /// Returns an iterator of the `DefId`s for all body-owners in this
2763 /// crate. If you would prefer to iterate over the bodies
2764 /// themselves, you can do `self.hir().krate().body_ids.iter()`.
2767 ) -> impl Iterator<Item = DefId> + Captures<'tcx> + Captures<'gcx> + 'a {
2771 .map(move |&body_id| self.hir().body_owner_def_id(body_id))
2774 pub fn par_body_owners<F: Fn(DefId) + sync::Sync + sync::Send>(self, f: F) {
2775 par_iter(&self.hir().krate().body_ids).for_each(|&body_id| {
2776 f(self.hir().body_owner_def_id(body_id))
2780 pub fn expr_span(self, id: NodeId) -> Span {
2781 match self.hir().find(id) {
2782 Some(Node::Expr(e)) => {
2786 bug!("node-ID {} is not an expr: {:?}", id, f);
2789 bug!("node-ID {} is not present in the node map", id);
2794 pub fn provided_trait_methods(self, id: DefId) -> Vec<AssocItem> {
2795 self.associated_items(id)
2796 .filter(|item| item.kind == AssocKind::Method && item.defaultness.has_value())
2800 pub fn trait_relevant_for_never(self, did: DefId) -> bool {
2801 self.associated_items(did).any(|item| {
2802 item.relevant_for_never()
2806 pub fn opt_associated_item(self, def_id: DefId) -> Option<AssocItem> {
2807 let is_associated_item = if let Some(hir_id) = self.hir().as_local_hir_id(def_id) {
2808 match self.hir().get_by_hir_id(hir_id) {
2809 Node::TraitItem(_) | Node::ImplItem(_) => true,
2813 match self.def_kind(def_id).expect("no def for def-id") {
2816 | DefKind::AssocTy => true,
2821 if is_associated_item {
2822 Some(self.associated_item(def_id))
2828 fn associated_item_from_trait_item_ref(self,
2829 parent_def_id: DefId,
2830 parent_vis: &hir::Visibility,
2831 trait_item_ref: &hir::TraitItemRef)
2833 let def_id = self.hir().local_def_id_from_hir_id(trait_item_ref.id.hir_id);
2834 let (kind, has_self) = match trait_item_ref.kind {
2835 hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
2836 hir::AssocItemKind::Method { has_self } => {
2837 (ty::AssocKind::Method, has_self)
2839 hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
2840 hir::AssocItemKind::Existential => bug!("only impls can have existentials"),
2844 ident: trait_item_ref.ident,
2846 // Visibility of trait items is inherited from their traits.
2847 vis: Visibility::from_hir(parent_vis, trait_item_ref.id.hir_id, self),
2848 defaultness: trait_item_ref.defaultness,
2850 container: TraitContainer(parent_def_id),
2851 method_has_self_argument: has_self
2855 fn associated_item_from_impl_item_ref(self,
2856 parent_def_id: DefId,
2857 impl_item_ref: &hir::ImplItemRef)
2859 let def_id = self.hir().local_def_id_from_hir_id(impl_item_ref.id.hir_id);
2860 let (kind, has_self) = match impl_item_ref.kind {
2861 hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
2862 hir::AssocItemKind::Method { has_self } => {
2863 (ty::AssocKind::Method, has_self)
2865 hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
2866 hir::AssocItemKind::Existential => (ty::AssocKind::Existential, false),
2870 ident: impl_item_ref.ident,
2872 // Visibility of trait impl items doesn't matter.
2873 vis: ty::Visibility::from_hir(&impl_item_ref.vis, impl_item_ref.id.hir_id, self),
2874 defaultness: impl_item_ref.defaultness,
2876 container: ImplContainer(parent_def_id),
2877 method_has_self_argument: has_self
2881 pub fn field_index(self, hir_id: hir::HirId, tables: &TypeckTables<'_>) -> usize {
2882 tables.field_indices().get(hir_id).cloned().expect("no index for a field")
2885 pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2886 variant.fields.iter().position(|field| {
2887 self.hygienic_eq(ident, field.ident, variant.def_id)
2891 pub fn associated_items(
2894 ) -> AssocItemsIterator<'a, 'gcx, 'tcx> {
2895 // Ideally, we would use `-> impl Iterator` here, but it falls
2896 // afoul of the conservative "capture [restrictions]" we put
2897 // in place, so we use a hand-written iterator.
2899 // [restrictions]: https://github.com/rust-lang/rust/issues/34511#issuecomment-373423999
2900 AssocItemsIterator {
2902 def_ids: self.associated_item_def_ids(def_id),
2907 /// Returns `true` if the impls are the same polarity and the trait either
2908 /// has no items or is annotated #[marker] and prevents item overrides.
2909 pub fn impls_are_allowed_to_overlap(self, def_id1: DefId, def_id2: DefId)
2910 -> Option<ImplOverlapKind>
2912 let is_legit = if self.features().overlapping_marker_traits {
2913 let trait1_is_empty = self.impl_trait_ref(def_id1)
2914 .map_or(false, |trait_ref| {
2915 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2917 let trait2_is_empty = self.impl_trait_ref(def_id2)
2918 .map_or(false, |trait_ref| {
2919 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2921 self.impl_polarity(def_id1) == self.impl_polarity(def_id2)
2925 let is_marker_impl = |def_id: DefId| -> bool {
2926 let trait_ref = self.impl_trait_ref(def_id);
2927 trait_ref.map_or(false, |tr| self.trait_def(tr.def_id).is_marker)
2929 self.impl_polarity(def_id1) == self.impl_polarity(def_id2)
2930 && is_marker_impl(def_id1)
2931 && is_marker_impl(def_id2)
2935 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted)",
2937 Some(ImplOverlapKind::Permitted)
2939 if let Some(self_ty1) = self.issue33140_self_ty(def_id1) {
2940 if let Some(self_ty2) = self.issue33140_self_ty(def_id2) {
2941 if self_ty1 == self_ty2 {
2942 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - issue #33140 HACK",
2944 return Some(ImplOverlapKind::Issue33140);
2946 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - found {:?} != {:?}",
2947 def_id1, def_id2, self_ty1, self_ty2);
2952 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = None",
2958 /// Returns `ty::VariantDef` if `res` refers to a struct,
2959 /// or variant or their constructors, panics otherwise.
2960 pub fn expect_variant_res(self, res: Res) -> &'tcx VariantDef {
2962 Res::Def(DefKind::Variant, did) => {
2963 let enum_did = self.parent(did).unwrap();
2964 self.adt_def(enum_did).variant_with_id(did)
2966 Res::Def(DefKind::Struct, did) | Res::Def(DefKind::Union, did) => {
2967 self.adt_def(did).non_enum_variant()
2969 Res::Def(DefKind::Ctor(CtorOf::Variant, ..), variant_ctor_did) => {
2970 let variant_did = self.parent(variant_ctor_did).unwrap();
2971 let enum_did = self.parent(variant_did).unwrap();
2972 self.adt_def(enum_did).variant_with_ctor_id(variant_ctor_did)
2974 Res::Def(DefKind::Ctor(CtorOf::Struct, ..), ctor_did) => {
2975 let struct_did = self.parent(ctor_did).expect("struct ctor has no parent");
2976 self.adt_def(struct_did).non_enum_variant()
2978 _ => bug!("expect_variant_res used with unexpected res {:?}", res)
2982 pub fn item_name(self, id: DefId) -> Symbol {
2983 if id.index == CRATE_DEF_INDEX {
2984 self.original_crate_name(id.krate)
2986 let def_key = self.def_key(id);
2987 match def_key.disambiguated_data.data {
2988 // The name of a constructor is that of its parent.
2989 hir_map::DefPathData::Ctor =>
2990 self.item_name(DefId {
2992 index: def_key.parent.unwrap()
2994 _ => def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
2995 bug!("item_name: no name for {:?}", self.def_path(id));
3001 /// Returns the possibly-auto-generated MIR of a `(DefId, Subst)` pair.
3002 pub fn instance_mir(self, instance: ty::InstanceDef<'gcx>)
3006 ty::InstanceDef::Item(did) => {
3007 self.optimized_mir(did)
3009 ty::InstanceDef::VtableShim(..) |
3010 ty::InstanceDef::Intrinsic(..) |
3011 ty::InstanceDef::FnPtrShim(..) |
3012 ty::InstanceDef::Virtual(..) |
3013 ty::InstanceDef::ClosureOnceShim { .. } |
3014 ty::InstanceDef::DropGlue(..) |
3015 ty::InstanceDef::CloneShim(..) => {
3016 self.mir_shims(instance)
3021 /// Gets the attributes of a definition.
3022 pub fn get_attrs(self, did: DefId) -> Attributes<'gcx> {
3023 if let Some(id) = self.hir().as_local_hir_id(did) {
3024 Attributes::Borrowed(self.hir().attrs_by_hir_id(id))
3026 Attributes::Owned(self.item_attrs(did))
3030 /// Determines whether an item is annotated with an attribute.
3031 pub fn has_attr(self, did: DefId, attr: Symbol) -> bool {
3032 attr::contains_name(&self.get_attrs(did), attr)
3035 /// Returns `true` if this is an `auto trait`.
3036 pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
3037 self.trait_def(trait_def_id).has_auto_impl
3040 pub fn generator_layout(self, def_id: DefId) -> &'tcx GeneratorLayout<'tcx> {
3041 self.optimized_mir(def_id).generator_layout.as_ref().unwrap()
3044 /// Given the `DefId` of an impl, returns the `DefId` of the trait it implements.
3045 /// If it implements no trait, returns `None`.
3046 pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
3047 self.impl_trait_ref(def_id).map(|tr| tr.def_id)
3050 /// If the given defid describes a method belonging to an impl, returns the
3051 /// `DefId` of the impl that the method belongs to; otherwise, returns `None`.
3052 pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
3053 let item = if def_id.krate != LOCAL_CRATE {
3054 if let Some(DefKind::Method) = self.def_kind(def_id) {
3055 Some(self.associated_item(def_id))
3060 self.opt_associated_item(def_id)
3063 item.and_then(|trait_item|
3064 match trait_item.container {
3065 TraitContainer(_) => None,
3066 ImplContainer(def_id) => Some(def_id),
3071 /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
3072 /// with the name of the crate containing the impl.
3073 pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
3074 if impl_did.is_local() {
3075 let hir_id = self.hir().as_local_hir_id(impl_did).unwrap();
3076 Ok(self.hir().span_by_hir_id(hir_id))
3078 Err(self.crate_name(impl_did.krate))
3082 /// Hygienically compares a use-site name (`use_name`) for a field or an associated item with
3083 /// its supposed definition name (`def_name`). The method also needs `DefId` of the supposed
3084 /// definition's parent/scope to perform comparison.
3085 pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
3086 // We could use `Ident::eq` here, but we deliberately don't. The name
3087 // comparison fails frequently, and we want to avoid the expensive
3088 // `modern()` calls required for the span comparison whenever possible.
3089 use_name.name == def_name.name &&
3090 use_name.span.ctxt().hygienic_eq(def_name.span.ctxt(),
3091 self.expansion_that_defined(def_parent_def_id))
3094 fn expansion_that_defined(self, scope: DefId) -> Mark {
3096 LOCAL_CRATE => self.hir().definitions().expansion_that_defined(scope.index),
3101 pub fn adjust_ident(self, mut ident: Ident, scope: DefId) -> Ident {
3102 ident.span.modernize_and_adjust(self.expansion_that_defined(scope));
3106 pub fn adjust_ident_and_get_scope(self, mut ident: Ident, scope: DefId, block: hir::HirId)
3108 let scope = match ident.span.modernize_and_adjust(self.expansion_that_defined(scope)) {
3109 Some(actual_expansion) =>
3110 self.hir().definitions().parent_module_of_macro_def(actual_expansion),
3111 None => self.hir().get_module_parent_by_hir_id(block),
3117 pub struct AssocItemsIterator<'a, 'gcx: 'tcx, 'tcx: 'a> {
3118 tcx: TyCtxt<'a, 'gcx, 'tcx>,
3119 def_ids: &'gcx [DefId],
3123 impl Iterator for AssocItemsIterator<'_, '_, '_> {
3124 type Item = AssocItem;
3126 fn next(&mut self) -> Option<AssocItem> {
3127 let def_id = self.def_ids.get(self.next_index)?;
3128 self.next_index += 1;
3129 Some(self.tcx.associated_item(*def_id))
3133 fn associated_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> AssocItem {
3134 let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3135 let parent_id = tcx.hir().get_parent_item(id);
3136 let parent_def_id = tcx.hir().local_def_id_from_hir_id(parent_id);
3137 let parent_item = tcx.hir().expect_item_by_hir_id(parent_id);
3138 match parent_item.node {
3139 hir::ItemKind::Impl(.., ref impl_item_refs) => {
3140 if let Some(impl_item_ref) = impl_item_refs.iter().find(|i| i.id.hir_id == id) {
3141 let assoc_item = tcx.associated_item_from_impl_item_ref(parent_def_id,
3143 debug_assert_eq!(assoc_item.def_id, def_id);
3148 hir::ItemKind::Trait(.., ref trait_item_refs) => {
3149 if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.hir_id == id) {
3150 let assoc_item = tcx.associated_item_from_trait_item_ref(parent_def_id,
3153 debug_assert_eq!(assoc_item.def_id, def_id);
3161 span_bug!(parent_item.span,
3162 "unexpected parent of trait or impl item or item not found: {:?}",
3166 #[derive(Clone, HashStable)]
3167 pub struct AdtSizedConstraint<'tcx>(pub &'tcx [Ty<'tcx>]);
3169 /// Calculates the `Sized` constraint.
3171 /// In fact, there are only a few options for the types in the constraint:
3172 /// - an obviously-unsized type
3173 /// - a type parameter or projection whose Sizedness can't be known
3174 /// - a tuple of type parameters or projections, if there are multiple
3176 /// - a Error, if a type contained itself. The representability
3177 /// check should catch this case.
3178 fn adt_sized_constraint<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3180 -> AdtSizedConstraint<'tcx> {
3181 let def = tcx.adt_def(def_id);
3183 let result = tcx.mk_type_list(def.variants.iter().flat_map(|v| {
3186 def.sized_constraint_for_ty(tcx, tcx.type_of(f.did))
3189 debug!("adt_sized_constraint: {:?} => {:?}", def, result);
3191 AdtSizedConstraint(result)
3194 fn associated_item_def_ids<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3197 let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3198 let item = tcx.hir().expect_item_by_hir_id(id);
3200 hir::ItemKind::Trait(.., ref trait_item_refs) => {
3201 tcx.arena.alloc_from_iter(
3202 trait_item_refs.iter()
3203 .map(|trait_item_ref| trait_item_ref.id)
3204 .map(|id| tcx.hir().local_def_id_from_hir_id(id.hir_id))
3207 hir::ItemKind::Impl(.., ref impl_item_refs) => {
3208 tcx.arena.alloc_from_iter(
3209 impl_item_refs.iter()
3210 .map(|impl_item_ref| impl_item_ref.id)
3211 .map(|id| tcx.hir().local_def_id_from_hir_id(id.hir_id))
3214 hir::ItemKind::TraitAlias(..) => &[],
3215 _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait")
3219 fn def_span<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Span {
3220 tcx.hir().span_if_local(def_id).unwrap()
3223 /// If the given `DefId` describes an item belonging to a trait,
3224 /// returns the `DefId` of the trait that the trait item belongs to;
3225 /// otherwise, returns `None`.
3226 fn trait_of_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Option<DefId> {
3227 tcx.opt_associated_item(def_id)
3228 .and_then(|associated_item| {
3229 match associated_item.container {
3230 TraitContainer(def_id) => Some(def_id),
3231 ImplContainer(_) => None
3236 /// Yields the parent function's `DefId` if `def_id` is an `impl Trait` definition.
3237 pub fn is_impl_trait_defn(tcx: TyCtxt<'_, '_, '_>, def_id: DefId) -> Option<DefId> {
3238 if let Some(hir_id) = tcx.hir().as_local_hir_id(def_id) {
3239 if let Node::Item(item) = tcx.hir().get_by_hir_id(hir_id) {
3240 if let hir::ItemKind::Existential(ref exist_ty) = item.node {
3241 return exist_ty.impl_trait_fn;
3248 /// See `ParamEnv` struct definition for details.
3249 fn param_env<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3253 // The param_env of an impl Trait type is its defining function's param_env
3254 if let Some(parent) = is_impl_trait_defn(tcx, def_id) {
3255 return param_env(tcx, parent);
3257 // Compute the bounds on Self and the type parameters.
3259 let InstantiatedPredicates { predicates } =
3260 tcx.predicates_of(def_id).instantiate_identity(tcx);
3262 // Finally, we have to normalize the bounds in the environment, in
3263 // case they contain any associated type projections. This process
3264 // can yield errors if the put in illegal associated types, like
3265 // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
3266 // report these errors right here; this doesn't actually feel
3267 // right to me, because constructing the environment feels like a
3268 // kind of a "idempotent" action, but I'm not sure where would be
3269 // a better place. In practice, we construct environments for
3270 // every fn once during type checking, and we'll abort if there
3271 // are any errors at that point, so after type checking you can be
3272 // sure that this will succeed without errors anyway.
3274 let unnormalized_env = ty::ParamEnv::new(
3275 tcx.intern_predicates(&predicates),
3276 traits::Reveal::UserFacing,
3277 if tcx.sess.opts.debugging_opts.chalk { Some(def_id) } else { None }
3280 let body_id = tcx.hir().as_local_hir_id(def_id).map_or(hir::DUMMY_HIR_ID, |id| {
3281 tcx.hir().maybe_body_owned_by_by_hir_id(id).map_or(id, |body| body.hir_id)
3283 let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
3284 traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
3287 fn crate_disambiguator<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3288 crate_num: CrateNum) -> CrateDisambiguator {
3289 assert_eq!(crate_num, LOCAL_CRATE);
3290 tcx.sess.local_crate_disambiguator()
3293 fn original_crate_name<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3294 crate_num: CrateNum) -> Symbol {
3295 assert_eq!(crate_num, LOCAL_CRATE);
3296 tcx.crate_name.clone()
3299 fn crate_hash<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3300 crate_num: CrateNum)
3302 assert_eq!(crate_num, LOCAL_CRATE);
3303 tcx.hir().crate_hash
3306 fn instance_def_size_estimate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3307 instance_def: InstanceDef<'tcx>)
3309 match instance_def {
3310 InstanceDef::Item(..) |
3311 InstanceDef::DropGlue(..) => {
3312 let mir = tcx.instance_mir(instance_def);
3313 mir.basic_blocks().iter().map(|bb| bb.statements.len()).sum()
3315 // Estimate the size of other compiler-generated shims to be 1.
3320 /// If `def_id` is an issue 33140 hack impl, returns its self type; otherwise, returns `None`.
3322 /// See [`ImplOverlapKind::Issue33140`] for more details.
3323 fn issue33140_self_ty<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3327 debug!("issue33140_self_ty({:?})", def_id);
3329 let trait_ref = tcx.impl_trait_ref(def_id).unwrap_or_else(|| {
3330 bug!("issue33140_self_ty called on inherent impl {:?}", def_id)
3333 debug!("issue33140_self_ty({:?}), trait-ref={:?}", def_id, trait_ref);
3335 let is_marker_like =
3336 tcx.impl_polarity(def_id) == hir::ImplPolarity::Positive &&
3337 tcx.associated_item_def_ids(trait_ref.def_id).is_empty();
3339 // Check whether these impls would be ok for a marker trait.
3340 if !is_marker_like {
3341 debug!("issue33140_self_ty - not marker-like!");
3345 // impl must be `impl Trait for dyn Marker1 + Marker2 + ...`
3346 if trait_ref.substs.len() != 1 {
3347 debug!("issue33140_self_ty - impl has substs!");
3351 let predicates = tcx.predicates_of(def_id);
3352 if predicates.parent.is_some() || !predicates.predicates.is_empty() {
3353 debug!("issue33140_self_ty - impl has predicates {:?}!", predicates);
3357 let self_ty = trait_ref.self_ty();
3358 let self_ty_matches = match self_ty.sty {
3359 ty::Dynamic(ref data, ty::ReStatic) => data.principal().is_none(),
3363 if self_ty_matches {
3364 debug!("issue33140_self_ty - MATCHES!");
3367 debug!("issue33140_self_ty - non-matching self type");
3372 pub fn provide(providers: &mut ty::query::Providers<'_>) {
3373 context::provide(providers);
3374 erase_regions::provide(providers);
3375 layout::provide(providers);
3376 util::provide(providers);
3377 constness::provide(providers);
3378 *providers = ty::query::Providers {
3380 associated_item_def_ids,
3381 adt_sized_constraint,
3385 crate_disambiguator,
3386 original_crate_name,
3388 trait_impls_of: trait_def::trait_impls_of_provider,
3389 instance_def_size_estimate,
3395 /// A map for the local crate mapping each type to a vector of its
3396 /// inherent impls. This is not meant to be used outside of coherence;
3397 /// rather, you should request the vector for a specific type via
3398 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
3399 /// (constructing this map requires touching the entire crate).
3400 #[derive(Clone, Debug, Default, HashStable)]
3401 pub struct CrateInherentImpls {
3402 pub inherent_impls: DefIdMap<Vec<DefId>>,
3405 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable)]
3406 pub struct SymbolName {
3407 // FIXME: we don't rely on interning or equality here - better have
3408 // this be a `&'tcx str`.
3409 pub name: InternedString
3412 impl_stable_hash_for!(struct self::SymbolName {
3417 pub fn new(name: &str) -> SymbolName {
3419 name: InternedString::intern(name)
3423 pub fn as_str(&self) -> LocalInternedString {
3428 impl fmt::Display for SymbolName {
3429 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3430 fmt::Display::fmt(&self.name, fmt)
3434 impl fmt::Debug for SymbolName {
3435 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3436 fmt::Display::fmt(&self.name, fmt)