1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
11 pub use self::Variance::*;
12 pub use self::AssociatedItemContainer::*;
13 pub use self::BorrowKind::*;
14 pub use self::IntVarValue::*;
15 pub use self::fold::TypeFoldable;
17 use hir::{map as hir_map, FreevarMap, TraitMap};
19 use hir::def::{Def, CtorKind, ExportMap};
20 use hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
21 use hir::map::DefPathData;
22 use rustc_data_structures::svh::Svh;
24 use ich::StableHashingContext;
25 use infer::canonical::Canonical;
26 use middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem, FnOnceTraitLangItem};
27 use middle::privacy::AccessLevels;
28 use middle::resolve_lifetime::ObjectLifetimeDefault;
30 use mir::interpret::GlobalId;
31 use mir::GeneratorLayout;
32 use session::CrateDisambiguator;
33 use traits::{self, Reveal};
35 use ty::subst::{Subst, Substs};
36 use ty::util::{IntTypeExt, Discr};
37 use ty::walk::TypeWalker;
38 use util::captures::Captures;
39 use util::nodemap::{NodeSet, DefIdMap, FxHashMap};
40 use arena::SyncDroplessArena;
41 use session::DataTypeKind;
43 use serialize::{self, Encodable, Encoder};
44 use std::cell::RefCell;
45 use std::cmp::{self, Ordering};
47 use std::hash::{Hash, Hasher};
49 use rustc_data_structures::sync::{self, Lrc, ParallelIterator, par_iter};
51 use std::vec::IntoIter;
53 use syntax::ast::{self, DUMMY_NODE_ID, Name, Ident, NodeId};
55 use syntax::ext::hygiene::Mark;
56 use syntax::symbol::{keywords, Symbol, LocalInternedString, InternedString};
57 use syntax_pos::{DUMMY_SP, Span};
60 use rustc_data_structures::stable_hasher::{StableHasher, StableHasherResult,
65 pub use self::sty::{Binder, CanonicalVar, DebruijnIndex, INNERMOST};
66 pub use self::sty::{FnSig, GenSig, PolyFnSig, PolyGenSig};
67 pub use self::sty::{InferTy, ParamTy, ProjectionTy, ExistentialPredicate};
68 pub use self::sty::{ClosureSubsts, GeneratorSubsts, UpvarSubsts, TypeAndMut};
69 pub use self::sty::{TraitRef, TyKind, PolyTraitRef};
70 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
71 pub use self::sty::{ExistentialProjection, PolyExistentialProjection, Const};
72 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
73 pub use self::sty::RegionKind;
74 pub use self::sty::{TyVid, IntVid, FloatVid, RegionVid};
75 pub use self::sty::BoundRegion::*;
76 pub use self::sty::InferTy::*;
77 pub use self::sty::RegionKind::*;
78 pub use self::sty::TyKind::*;
80 pub use self::binding::BindingMode;
81 pub use self::binding::BindingMode::*;
83 pub use self::context::{TyCtxt, FreeRegionInfo, GlobalArenas, AllArenas, tls, keep_local};
84 pub use self::context::{Lift, TypeckTables};
86 pub use self::instance::{Instance, InstanceDef};
88 pub use self::trait_def::TraitDef;
90 pub use self::query::queries;
102 pub mod inhabitedness;
119 mod structural_impls;
124 /// The complete set of all analyses described in this module. This is
125 /// produced by the driver and fed to codegen and later passes.
127 /// NB: These contents are being migrated into queries using the
128 /// *on-demand* infrastructure.
130 pub struct CrateAnalysis {
131 pub access_levels: Lrc<AccessLevels>,
133 pub glob_map: Option<hir::GlobMap>,
137 pub struct Resolutions {
138 pub freevars: FreevarMap,
139 pub trait_map: TraitMap,
140 pub maybe_unused_trait_imports: NodeSet,
141 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
142 pub export_map: ExportMap,
145 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
146 pub enum AssociatedItemContainer {
147 TraitContainer(DefId),
148 ImplContainer(DefId),
151 impl AssociatedItemContainer {
152 /// Asserts that this is the def-id of an associated item declared
153 /// in a trait, and returns the trait def-id.
154 pub fn assert_trait(&self) -> DefId {
156 TraitContainer(id) => id,
157 _ => bug!("associated item has wrong container type: {:?}", self)
161 pub fn id(&self) -> DefId {
163 TraitContainer(id) => id,
164 ImplContainer(id) => id,
169 /// The "header" of an impl is everything outside the body: a Self type, a trait
170 /// ref (in the case of a trait impl), and a set of predicates (from the
171 /// bounds/where clauses).
172 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
173 pub struct ImplHeader<'tcx> {
174 pub impl_def_id: DefId,
175 pub self_ty: Ty<'tcx>,
176 pub trait_ref: Option<TraitRef<'tcx>>,
177 pub predicates: Vec<Predicate<'tcx>>,
180 #[derive(Copy, Clone, Debug, PartialEq)]
181 pub struct AssociatedItem {
184 pub kind: AssociatedKind,
186 pub defaultness: hir::Defaultness,
187 pub container: AssociatedItemContainer,
189 /// Whether this is a method with an explicit self
190 /// as its first argument, allowing method calls.
191 pub method_has_self_argument: bool,
194 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, RustcEncodable, RustcDecodable)]
195 pub enum AssociatedKind {
202 impl AssociatedItem {
203 pub fn def(&self) -> Def {
205 AssociatedKind::Const => Def::AssociatedConst(self.def_id),
206 AssociatedKind::Method => Def::Method(self.def_id),
207 AssociatedKind::Type => Def::AssociatedTy(self.def_id),
208 AssociatedKind::Existential => Def::AssociatedExistential(self.def_id),
212 /// Tests whether the associated item admits a non-trivial implementation
214 pub fn relevant_for_never<'tcx>(&self) -> bool {
216 AssociatedKind::Existential |
217 AssociatedKind::Const |
218 AssociatedKind::Type => true,
219 // FIXME(canndrew): Be more thorough here, check if any argument is uninhabited.
220 AssociatedKind::Method => !self.method_has_self_argument,
224 pub fn signature<'a, 'tcx>(&self, tcx: &TyCtxt<'a, 'tcx, 'tcx>) -> String {
226 ty::AssociatedKind::Method => {
227 // We skip the binder here because the binder would deanonymize all
228 // late-bound regions, and we don't want method signatures to show up
229 // `as for<'r> fn(&'r MyType)`. Pretty-printing handles late-bound
230 // regions just fine, showing `fn(&MyType)`.
231 tcx.fn_sig(self.def_id).skip_binder().to_string()
233 ty::AssociatedKind::Type => format!("type {};", self.ident),
234 ty::AssociatedKind::Existential => format!("existential type {};", self.ident),
235 ty::AssociatedKind::Const => {
236 format!("const {}: {:?};", self.ident, tcx.type_of(self.def_id))
242 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable)]
243 pub enum Visibility {
244 /// Visible everywhere (including in other crates).
246 /// Visible only in the given crate-local module.
248 /// Not visible anywhere in the local crate. This is the visibility of private external items.
252 pub trait DefIdTree: Copy {
253 fn parent(self, id: DefId) -> Option<DefId>;
255 fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
256 if descendant.krate != ancestor.krate {
260 while descendant != ancestor {
261 match self.parent(descendant) {
262 Some(parent) => descendant = parent,
263 None => return false,
270 impl<'a, 'gcx, 'tcx> DefIdTree for TyCtxt<'a, 'gcx, 'tcx> {
271 fn parent(self, id: DefId) -> Option<DefId> {
272 self.def_key(id).parent.map(|index| DefId { index: index, ..id })
277 pub fn from_hir(visibility: &hir::Visibility, id: NodeId, tcx: TyCtxt<'_, '_, '_>) -> Self {
278 match visibility.node {
279 hir::VisibilityKind::Public => Visibility::Public,
280 hir::VisibilityKind::Crate(_) => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
281 hir::VisibilityKind::Restricted { ref path, .. } => match path.def {
282 // If there is no resolution, `resolve` will have already reported an error, so
283 // assume that the visibility is public to avoid reporting more privacy errors.
284 Def::Err => Visibility::Public,
285 def => Visibility::Restricted(def.def_id()),
287 hir::VisibilityKind::Inherited => {
288 Visibility::Restricted(tcx.hir.get_module_parent(id))
293 /// Returns true if an item with this visibility is accessible from the given block.
294 pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
295 let restriction = match self {
296 // Public items are visible everywhere.
297 Visibility::Public => return true,
298 // Private items from other crates are visible nowhere.
299 Visibility::Invisible => return false,
300 // Restricted items are visible in an arbitrary local module.
301 Visibility::Restricted(other) if other.krate != module.krate => return false,
302 Visibility::Restricted(module) => module,
305 tree.is_descendant_of(module, restriction)
308 /// Returns true if this visibility is at least as accessible as the given visibility
309 pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
310 let vis_restriction = match vis {
311 Visibility::Public => return self == Visibility::Public,
312 Visibility::Invisible => return true,
313 Visibility::Restricted(module) => module,
316 self.is_accessible_from(vis_restriction, tree)
319 // Returns true if this item is visible anywhere in the local crate.
320 pub fn is_visible_locally(self) -> bool {
322 Visibility::Public => true,
323 Visibility::Restricted(def_id) => def_id.is_local(),
324 Visibility::Invisible => false,
329 #[derive(Clone, PartialEq, RustcDecodable, RustcEncodable, Copy)]
331 Covariant, // T<A> <: T<B> iff A <: B -- e.g., function return type
332 Invariant, // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
333 Contravariant, // T<A> <: T<B> iff B <: A -- e.g., function param type
334 Bivariant, // T<A> <: T<B> -- e.g., unused type parameter
337 /// The crate variances map is computed during typeck and contains the
338 /// variance of every item in the local crate. You should not use it
339 /// directly, because to do so will make your pass dependent on the
340 /// HIR of every item in the local crate. Instead, use
341 /// `tcx.variances_of()` to get the variance for a *particular*
343 pub struct CrateVariancesMap {
344 /// For each item with generics, maps to a vector of the variance
345 /// of its generics. If an item has no generics, it will have no
347 pub variances: FxHashMap<DefId, Lrc<Vec<ty::Variance>>>,
349 /// An empty vector, useful for cloning.
350 pub empty_variance: Lrc<Vec<ty::Variance>>,
354 /// `a.xform(b)` combines the variance of a context with the
355 /// variance of a type with the following meaning. If we are in a
356 /// context with variance `a`, and we encounter a type argument in
357 /// a position with variance `b`, then `a.xform(b)` is the new
358 /// variance with which the argument appears.
364 /// Here, the "ambient" variance starts as covariant. `*mut T` is
365 /// invariant with respect to `T`, so the variance in which the
366 /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
367 /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
368 /// respect to its type argument `T`, and hence the variance of
369 /// the `i32` here is `Invariant.xform(Covariant)`, which results
370 /// (again) in `Invariant`.
374 /// fn(*const Vec<i32>, *mut Vec<i32)
376 /// The ambient variance is covariant. A `fn` type is
377 /// contravariant with respect to its parameters, so the variance
378 /// within which both pointer types appear is
379 /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
380 /// T` is covariant with respect to `T`, so the variance within
381 /// which the first `Vec<i32>` appears is
382 /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
383 /// is true for its `i32` argument. In the `*mut T` case, the
384 /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
385 /// and hence the outermost type is `Invariant` with respect to
386 /// `Vec<i32>` (and its `i32` argument).
388 /// Source: Figure 1 of "Taming the Wildcards:
389 /// Combining Definition- and Use-Site Variance" published in PLDI'11.
390 pub fn xform(self, v: ty::Variance) -> ty::Variance {
392 // Figure 1, column 1.
393 (ty::Covariant, ty::Covariant) => ty::Covariant,
394 (ty::Covariant, ty::Contravariant) => ty::Contravariant,
395 (ty::Covariant, ty::Invariant) => ty::Invariant,
396 (ty::Covariant, ty::Bivariant) => ty::Bivariant,
398 // Figure 1, column 2.
399 (ty::Contravariant, ty::Covariant) => ty::Contravariant,
400 (ty::Contravariant, ty::Contravariant) => ty::Covariant,
401 (ty::Contravariant, ty::Invariant) => ty::Invariant,
402 (ty::Contravariant, ty::Bivariant) => ty::Bivariant,
404 // Figure 1, column 3.
405 (ty::Invariant, _) => ty::Invariant,
407 // Figure 1, column 4.
408 (ty::Bivariant, _) => ty::Bivariant,
413 // Contains information needed to resolve types and (in the future) look up
414 // the types of AST nodes.
415 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
416 pub struct CReaderCacheKey {
421 // Flags that we track on types. These flags are propagated upwards
422 // through the type during type construction, so that we can quickly
423 // check whether the type has various kinds of types in it without
424 // recursing over the type itself.
426 pub struct TypeFlags: u32 {
427 const HAS_PARAMS = 1 << 0;
428 const HAS_SELF = 1 << 1;
429 const HAS_TY_INFER = 1 << 2;
430 const HAS_RE_INFER = 1 << 3;
431 const HAS_RE_SKOL = 1 << 4;
433 /// Does this have any `ReEarlyBound` regions? Used to
434 /// determine whether substitition is required, since those
435 /// represent regions that are bound in a `ty::Generics` and
436 /// hence may be substituted.
437 const HAS_RE_EARLY_BOUND = 1 << 5;
439 /// Does this have any region that "appears free" in the type?
440 /// Basically anything but `ReLateBound` and `ReErased`.
441 const HAS_FREE_REGIONS = 1 << 6;
443 /// Is an error type reachable?
444 const HAS_TY_ERR = 1 << 7;
445 const HAS_PROJECTION = 1 << 8;
447 // FIXME: Rename this to the actual property since it's used for generators too
448 const HAS_TY_CLOSURE = 1 << 9;
450 // true if there are "names" of types and regions and so forth
451 // that are local to a particular fn
452 const HAS_FREE_LOCAL_NAMES = 1 << 10;
454 // Present if the type belongs in a local type context.
455 // Only set for Infer other than Fresh.
456 const KEEP_IN_LOCAL_TCX = 1 << 11;
458 // Is there a projection that does not involve a bound region?
459 // Currently we can't normalize projections w/ bound regions.
460 const HAS_NORMALIZABLE_PROJECTION = 1 << 12;
462 // Set if this includes a "canonical" type or region var --
463 // ought to be true only for the results of canonicalization.
464 const HAS_CANONICAL_VARS = 1 << 13;
466 /// Does this have any `ReLateBound` regions? Used to check
467 /// if a global bound is safe to evaluate.
468 const HAS_RE_LATE_BOUND = 1 << 14;
470 const NEEDS_SUBST = TypeFlags::HAS_PARAMS.bits |
471 TypeFlags::HAS_SELF.bits |
472 TypeFlags::HAS_RE_EARLY_BOUND.bits;
474 // Flags representing the nominal content of a type,
475 // computed by FlagsComputation. If you add a new nominal
476 // flag, it should be added here too.
477 const NOMINAL_FLAGS = TypeFlags::HAS_PARAMS.bits |
478 TypeFlags::HAS_SELF.bits |
479 TypeFlags::HAS_TY_INFER.bits |
480 TypeFlags::HAS_RE_INFER.bits |
481 TypeFlags::HAS_RE_SKOL.bits |
482 TypeFlags::HAS_RE_EARLY_BOUND.bits |
483 TypeFlags::HAS_FREE_REGIONS.bits |
484 TypeFlags::HAS_TY_ERR.bits |
485 TypeFlags::HAS_PROJECTION.bits |
486 TypeFlags::HAS_TY_CLOSURE.bits |
487 TypeFlags::HAS_FREE_LOCAL_NAMES.bits |
488 TypeFlags::KEEP_IN_LOCAL_TCX.bits |
489 TypeFlags::HAS_CANONICAL_VARS.bits |
490 TypeFlags::HAS_RE_LATE_BOUND.bits;
494 pub struct TyS<'tcx> {
495 pub sty: TyKind<'tcx>,
496 pub flags: TypeFlags,
498 /// This is a kind of confusing thing: it stores the smallest
501 /// (a) the binder itself captures nothing but
502 /// (b) all the late-bound things within the type are captured
503 /// by some sub-binder.
505 /// So, for a type without any late-bound things, like `u32`, this
506 /// will be INNERMOST, because that is the innermost binder that
507 /// captures nothing. But for a type `&'D u32`, where `'D` is a
508 /// late-bound region with debruijn index D, this would be D+1 --
509 /// the binder itself does not capture D, but D is captured by an
512 /// We call this concept an "exclusive" binder D (because all
513 /// debruijn indices within the type are contained within `0..D`
515 outer_exclusive_binder: ty::DebruijnIndex,
518 impl<'tcx> Ord for TyS<'tcx> {
519 fn cmp(&self, other: &TyS<'tcx>) -> Ordering {
520 self.sty.cmp(&other.sty)
524 impl<'tcx> PartialOrd for TyS<'tcx> {
525 fn partial_cmp(&self, other: &TyS<'tcx>) -> Option<Ordering> {
526 Some(self.sty.cmp(&other.sty))
530 impl<'tcx> PartialEq for TyS<'tcx> {
532 fn eq(&self, other: &TyS<'tcx>) -> bool {
536 impl<'tcx> Eq for TyS<'tcx> {}
538 impl<'tcx> Hash for TyS<'tcx> {
539 fn hash<H: Hasher>(&self, s: &mut H) {
540 (self as *const TyS<'_>).hash(s)
544 impl<'tcx> TyS<'tcx> {
545 pub fn is_primitive_ty(&self) -> bool {
552 TyKind::Infer(InferTy::IntVar(_)) |
553 TyKind::Infer(InferTy::FloatVar(_)) |
554 TyKind::Infer(InferTy::FreshIntTy(_)) |
555 TyKind::Infer(InferTy::FreshFloatTy(_)) => true,
556 TyKind::Ref(_, x, _) => x.is_primitive_ty(),
561 pub fn is_suggestable(&self) -> bool {
566 TyKind::Dynamic(..) |
567 TyKind::Closure(..) |
569 TyKind::Projection(..) => false,
575 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for ty::TyS<'gcx> {
576 fn hash_stable<W: StableHasherResult>(&self,
577 hcx: &mut StableHashingContext<'a>,
578 hasher: &mut StableHasher<W>) {
582 // The other fields just provide fast access to information that is
583 // also contained in `sty`, so no need to hash them.
586 outer_exclusive_binder: _,
589 sty.hash_stable(hcx, hasher);
593 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
595 impl<'tcx> serialize::UseSpecializedEncodable for Ty<'tcx> {}
596 impl<'tcx> serialize::UseSpecializedDecodable for Ty<'tcx> {}
598 pub type CanonicalTy<'gcx> = Canonical<'gcx, Ty<'gcx>>;
601 /// A dummy type used to force List to by unsized without requiring fat pointers
602 type OpaqueListContents;
605 /// A wrapper for slices with the additional invariant
606 /// that the slice is interned and no other slice with
607 /// the same contents can exist in the same context.
608 /// This means we can use pointer for both
609 /// equality comparisons and hashing.
610 /// Note: `Slice` was already taken by the `Ty`.
615 opaque: OpaqueListContents,
618 unsafe impl<T: Sync> Sync for List<T> {}
620 impl<T: Copy> List<T> {
622 fn from_arena<'tcx>(arena: &'tcx SyncDroplessArena, slice: &[T]) -> &'tcx List<T> {
623 assert!(!mem::needs_drop::<T>());
624 assert!(mem::size_of::<T>() != 0);
625 assert!(slice.len() != 0);
627 // Align up the size of the len (usize) field
628 let align = mem::align_of::<T>();
629 let align_mask = align - 1;
630 let offset = mem::size_of::<usize>();
631 let offset = (offset + align_mask) & !align_mask;
633 let size = offset + slice.len() * mem::size_of::<T>();
635 let mem = arena.alloc_raw(
637 cmp::max(mem::align_of::<T>(), mem::align_of::<usize>()));
639 let result = &mut *(mem.as_mut_ptr() as *mut List<T>);
641 result.len = slice.len();
643 // Write the elements
644 let arena_slice = slice::from_raw_parts_mut(result.data.as_mut_ptr(), result.len);
645 arena_slice.copy_from_slice(slice);
652 impl<T: fmt::Debug> fmt::Debug for List<T> {
653 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
658 impl<T: Encodable> Encodable for List<T> {
660 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
665 impl<T> Ord for List<T> where T: Ord {
666 fn cmp(&self, other: &List<T>) -> Ordering {
667 if self == other { Ordering::Equal } else {
668 <[T] as Ord>::cmp(&**self, &**other)
673 impl<T> PartialOrd for List<T> where T: PartialOrd {
674 fn partial_cmp(&self, other: &List<T>) -> Option<Ordering> {
675 if self == other { Some(Ordering::Equal) } else {
676 <[T] as PartialOrd>::partial_cmp(&**self, &**other)
681 impl<T: PartialEq> PartialEq for List<T> {
683 fn eq(&self, other: &List<T>) -> bool {
687 impl<T: Eq> Eq for List<T> {}
689 impl<T> Hash for List<T> {
691 fn hash<H: Hasher>(&self, s: &mut H) {
692 (self as *const List<T>).hash(s)
696 impl<T> Deref for List<T> {
699 fn deref(&self) -> &[T] {
701 slice::from_raw_parts(self.data.as_ptr(), self.len)
706 impl<'a, T> IntoIterator for &'a List<T> {
708 type IntoIter = <&'a [T] as IntoIterator>::IntoIter;
710 fn into_iter(self) -> Self::IntoIter {
715 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx List<Ty<'tcx>> {}
719 pub fn empty<'a>() -> &'a List<T> {
720 #[repr(align(64), C)]
721 struct EmptySlice([u8; 64]);
722 static EMPTY_SLICE: EmptySlice = EmptySlice([0; 64]);
723 assert!(mem::align_of::<T>() <= 64);
725 &*(&EMPTY_SLICE as *const _ as *const List<T>)
730 /// Upvars do not get their own node-id. Instead, we use the pair of
731 /// the original var id (that is, the root variable that is referenced
732 /// by the upvar) and the id of the closure expression.
733 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
735 pub var_id: hir::HirId,
736 pub closure_expr_id: LocalDefId,
739 #[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable, Copy)]
740 pub enum BorrowKind {
741 /// Data must be immutable and is aliasable.
744 /// Data must be immutable but not aliasable. This kind of borrow
745 /// cannot currently be expressed by the user and is used only in
746 /// implicit closure bindings. It is needed when the closure
747 /// is borrowing or mutating a mutable referent, e.g.:
749 /// let x: &mut isize = ...;
750 /// let y = || *x += 5;
752 /// If we were to try to translate this closure into a more explicit
753 /// form, we'd encounter an error with the code as written:
755 /// struct Env { x: & &mut isize }
756 /// let x: &mut isize = ...;
757 /// let y = (&mut Env { &x }, fn_ptr); // Closure is pair of env and fn
758 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
760 /// This is then illegal because you cannot mutate a `&mut` found
761 /// in an aliasable location. To solve, you'd have to translate with
762 /// an `&mut` borrow:
764 /// struct Env { x: & &mut isize }
765 /// let x: &mut isize = ...;
766 /// let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
767 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
769 /// Now the assignment to `**env.x` is legal, but creating a
770 /// mutable pointer to `x` is not because `x` is not mutable. We
771 /// could fix this by declaring `x` as `let mut x`. This is ok in
772 /// user code, if awkward, but extra weird for closures, since the
773 /// borrow is hidden.
775 /// So we introduce a "unique imm" borrow -- the referent is
776 /// immutable, but not aliasable. This solves the problem. For
777 /// simplicity, we don't give users the way to express this
778 /// borrow, it's just used when translating closures.
781 /// Data is mutable and not aliasable.
785 /// Information describing the capture of an upvar. This is computed
786 /// during `typeck`, specifically by `regionck`.
787 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable)]
788 pub enum UpvarCapture<'tcx> {
789 /// Upvar is captured by value. This is always true when the
790 /// closure is labeled `move`, but can also be true in other cases
791 /// depending on inference.
794 /// Upvar is captured by reference.
795 ByRef(UpvarBorrow<'tcx>),
798 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable)]
799 pub struct UpvarBorrow<'tcx> {
800 /// The kind of borrow: by-ref upvars have access to shared
801 /// immutable borrows, which are not part of the normal language
803 pub kind: BorrowKind,
805 /// Region of the resulting reference.
806 pub region: ty::Region<'tcx>,
809 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
811 #[derive(Copy, Clone)]
812 pub struct ClosureUpvar<'tcx> {
818 #[derive(Clone, Copy, PartialEq, Eq)]
819 pub enum IntVarValue {
821 UintType(ast::UintTy),
824 #[derive(Clone, Copy, PartialEq, Eq)]
825 pub struct FloatVarValue(pub ast::FloatTy);
827 impl ty::EarlyBoundRegion {
828 pub fn to_bound_region(&self) -> ty::BoundRegion {
829 ty::BoundRegion::BrNamed(self.def_id, self.name)
832 /// Does this early bound region have a name? Early bound regions normally
833 /// always have names except when using anonymous lifetimes (`'_`).
834 pub fn has_name(&self) -> bool {
835 self.name != keywords::UnderscoreLifetime.name().as_interned_str()
839 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
840 pub enum GenericParamDefKind {
844 object_lifetime_default: ObjectLifetimeDefault,
845 synthetic: Option<hir::SyntheticTyParamKind>,
849 #[derive(Clone, RustcEncodable, RustcDecodable)]
850 pub struct GenericParamDef {
851 pub name: InternedString,
855 /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
856 /// on generic parameter `'a`/`T`, asserts data behind the parameter
857 /// `'a`/`T` won't be accessed during the parent type's `Drop` impl.
858 pub pure_wrt_drop: bool,
860 pub kind: GenericParamDefKind,
863 impl GenericParamDef {
864 pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
865 if let GenericParamDefKind::Lifetime = self.kind {
866 ty::EarlyBoundRegion {
872 bug!("cannot convert a non-lifetime parameter def to an early bound region")
876 pub fn to_bound_region(&self) -> ty::BoundRegion {
877 if let GenericParamDefKind::Lifetime = self.kind {
878 self.to_early_bound_region_data().to_bound_region()
880 bug!("cannot convert a non-lifetime parameter def to an early bound region")
886 pub struct GenericParamCount {
887 pub lifetimes: usize,
891 /// Information about the formal type/lifetime parameters associated
892 /// with an item or method. Analogous to hir::Generics.
894 /// The ordering of parameters is the same as in Subst (excluding child generics):
895 /// Self (optionally), Lifetime params..., Type params...
896 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
897 pub struct Generics {
898 pub parent: Option<DefId>,
899 pub parent_count: usize,
900 pub params: Vec<GenericParamDef>,
902 /// Reverse map to the `index` field of each `GenericParamDef`
903 pub param_def_id_to_index: FxHashMap<DefId, u32>,
906 pub has_late_bound_regions: Option<Span>,
909 impl<'a, 'gcx, 'tcx> Generics {
910 pub fn count(&self) -> usize {
911 self.parent_count + self.params.len()
914 pub fn own_counts(&self) -> GenericParamCount {
915 // We could cache this as a property of `GenericParamCount`, but
916 // the aim is to refactor this away entirely eventually and the
917 // presence of this method will be a constant reminder.
918 let mut own_counts: GenericParamCount = Default::default();
920 for param in &self.params {
922 GenericParamDefKind::Lifetime => own_counts.lifetimes += 1,
923 GenericParamDefKind::Type { .. } => own_counts.types += 1,
930 pub fn requires_monomorphization(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
931 for param in &self.params {
933 GenericParamDefKind::Type { .. } => return true,
934 GenericParamDefKind::Lifetime => {}
937 if let Some(parent_def_id) = self.parent {
938 let parent = tcx.generics_of(parent_def_id);
939 parent.requires_monomorphization(tcx)
945 pub fn region_param(&'tcx self,
946 param: &EarlyBoundRegion,
947 tcx: TyCtxt<'a, 'gcx, 'tcx>)
948 -> &'tcx GenericParamDef
950 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
951 let param = &self.params[index as usize];
953 ty::GenericParamDefKind::Lifetime => param,
954 _ => bug!("expected lifetime parameter, but found another generic parameter")
957 tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
958 .region_param(param, tcx)
962 /// Returns the `GenericParamDef` associated with this `ParamTy`.
963 pub fn type_param(&'tcx self,
965 tcx: TyCtxt<'a, 'gcx, 'tcx>)
966 -> &'tcx GenericParamDef {
967 if let Some(index) = param.idx.checked_sub(self.parent_count as u32) {
968 let param = &self.params[index as usize];
970 ty::GenericParamDefKind::Type {..} => param,
971 _ => bug!("expected type parameter, but found another generic parameter")
974 tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
975 .type_param(param, tcx)
980 /// Bounds on generics.
981 #[derive(Clone, Default)]
982 pub struct GenericPredicates<'tcx> {
983 pub parent: Option<DefId>,
984 pub predicates: Vec<(Predicate<'tcx>, Span)>,
987 impl<'tcx> serialize::UseSpecializedEncodable for GenericPredicates<'tcx> {}
988 impl<'tcx> serialize::UseSpecializedDecodable for GenericPredicates<'tcx> {}
990 impl<'a, 'gcx, 'tcx> GenericPredicates<'tcx> {
991 pub fn instantiate(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: &Substs<'tcx>)
992 -> InstantiatedPredicates<'tcx> {
993 let mut instantiated = InstantiatedPredicates::empty();
994 self.instantiate_into(tcx, &mut instantiated, substs);
997 pub fn instantiate_own(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: &Substs<'tcx>)
998 -> InstantiatedPredicates<'tcx> {
999 InstantiatedPredicates {
1000 predicates: self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)).collect(),
1004 fn instantiate_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1005 instantiated: &mut InstantiatedPredicates<'tcx>,
1006 substs: &Substs<'tcx>) {
1007 if let Some(def_id) = self.parent {
1008 tcx.predicates_of(def_id).instantiate_into(tcx, instantiated, substs);
1010 instantiated.predicates.extend(
1011 self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)),
1015 pub fn instantiate_identity(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>)
1016 -> InstantiatedPredicates<'tcx> {
1017 let mut instantiated = InstantiatedPredicates::empty();
1018 self.instantiate_identity_into(tcx, &mut instantiated);
1022 fn instantiate_identity_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1023 instantiated: &mut InstantiatedPredicates<'tcx>) {
1024 if let Some(def_id) = self.parent {
1025 tcx.predicates_of(def_id).instantiate_identity_into(tcx, instantiated);
1027 instantiated.predicates.extend(self.predicates.iter().map(|&(p, _)| p))
1030 pub fn instantiate_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1031 poly_trait_ref: &ty::PolyTraitRef<'tcx>)
1032 -> InstantiatedPredicates<'tcx>
1034 assert_eq!(self.parent, None);
1035 InstantiatedPredicates {
1036 predicates: self.predicates.iter().map(|(pred, _)| {
1037 pred.subst_supertrait(tcx, poly_trait_ref)
1043 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1044 pub enum Predicate<'tcx> {
1045 /// Corresponds to `where Foo : Bar<A,B,C>`. `Foo` here would be
1046 /// the `Self` type of the trait reference and `A`, `B`, and `C`
1047 /// would be the type parameters.
1048 Trait(PolyTraitPredicate<'tcx>),
1051 RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
1054 TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
1056 /// where <T as TraitRef>::Name == X, approximately.
1057 /// See `ProjectionPredicate` struct for details.
1058 Projection(PolyProjectionPredicate<'tcx>),
1061 WellFormed(Ty<'tcx>),
1063 /// trait must be object-safe
1066 /// No direct syntax. May be thought of as `where T : FnFoo<...>`
1067 /// for some substitutions `...` and T being a closure type.
1068 /// Satisfied (or refuted) once we know the closure's kind.
1069 ClosureKind(DefId, ClosureSubsts<'tcx>, ClosureKind),
1072 Subtype(PolySubtypePredicate<'tcx>),
1074 /// Constant initializer must evaluate successfully.
1075 ConstEvaluatable(DefId, &'tcx Substs<'tcx>),
1078 /// The crate outlives map is computed during typeck and contains the
1079 /// outlives of every item in the local crate. You should not use it
1080 /// directly, because to do so will make your pass dependent on the
1081 /// HIR of every item in the local crate. Instead, use
1082 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
1084 pub struct CratePredicatesMap<'tcx> {
1085 /// For each struct with outlive bounds, maps to a vector of the
1086 /// predicate of its outlive bounds. If an item has no outlives
1087 /// bounds, it will have no entry.
1088 pub predicates: FxHashMap<DefId, Lrc<Vec<ty::Predicate<'tcx>>>>,
1090 /// An empty vector, useful for cloning.
1091 pub empty_predicate: Lrc<Vec<ty::Predicate<'tcx>>>,
1094 impl<'tcx> AsRef<Predicate<'tcx>> for Predicate<'tcx> {
1095 fn as_ref(&self) -> &Predicate<'tcx> {
1100 impl<'a, 'gcx, 'tcx> Predicate<'tcx> {
1101 /// Performs a substitution suitable for going from a
1102 /// poly-trait-ref to supertraits that must hold if that
1103 /// poly-trait-ref holds. This is slightly different from a normal
1104 /// substitution in terms of what happens with bound regions. See
1105 /// lengthy comment below for details.
1106 pub fn subst_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1107 trait_ref: &ty::PolyTraitRef<'tcx>)
1108 -> ty::Predicate<'tcx>
1110 // The interaction between HRTB and supertraits is not entirely
1111 // obvious. Let me walk you (and myself) through an example.
1113 // Let's start with an easy case. Consider two traits:
1115 // trait Foo<'a> : Bar<'a,'a> { }
1116 // trait Bar<'b,'c> { }
1118 // Now, if we have a trait reference `for<'x> T : Foo<'x>`, then
1119 // we can deduce that `for<'x> T : Bar<'x,'x>`. Basically, if we
1120 // knew that `Foo<'x>` (for any 'x) then we also know that
1121 // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
1122 // normal substitution.
1124 // In terms of why this is sound, the idea is that whenever there
1125 // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
1126 // holds. So if there is an impl of `T:Foo<'a>` that applies to
1127 // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
1130 // Another example to be careful of is this:
1132 // trait Foo1<'a> : for<'b> Bar1<'a,'b> { }
1133 // trait Bar1<'b,'c> { }
1135 // Here, if we have `for<'x> T : Foo1<'x>`, then what do we know?
1136 // The answer is that we know `for<'x,'b> T : Bar1<'x,'b>`. The
1137 // reason is similar to the previous example: any impl of
1138 // `T:Foo1<'x>` must show that `for<'b> T : Bar1<'x, 'b>`. So
1139 // basically we would want to collapse the bound lifetimes from
1140 // the input (`trait_ref`) and the supertraits.
1142 // To achieve this in practice is fairly straightforward. Let's
1143 // consider the more complicated scenario:
1145 // - We start out with `for<'x> T : Foo1<'x>`. In this case, `'x`
1146 // has a De Bruijn index of 1. We want to produce `for<'x,'b> T : Bar1<'x,'b>`,
1147 // where both `'x` and `'b` would have a DB index of 1.
1148 // The substitution from the input trait-ref is therefore going to be
1149 // `'a => 'x` (where `'x` has a DB index of 1).
1150 // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
1151 // early-bound parameter and `'b' is a late-bound parameter with a
1153 // - If we replace `'a` with `'x` from the input, it too will have
1154 // a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
1155 // just as we wanted.
1157 // There is only one catch. If we just apply the substitution `'a
1158 // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
1159 // adjust the DB index because we substituting into a binder (it
1160 // tries to be so smart...) resulting in `for<'x> for<'b>
1161 // Bar1<'x,'b>` (we have no syntax for this, so use your
1162 // imagination). Basically the 'x will have DB index of 2 and 'b
1163 // will have DB index of 1. Not quite what we want. So we apply
1164 // the substitution to the *contents* of the trait reference,
1165 // rather than the trait reference itself (put another way, the
1166 // substitution code expects equal binding levels in the values
1167 // from the substitution and the value being substituted into, and
1168 // this trick achieves that).
1170 let substs = &trait_ref.skip_binder().substs;
1172 Predicate::Trait(ref binder) =>
1173 Predicate::Trait(binder.map_bound(|data| data.subst(tcx, substs))),
1174 Predicate::Subtype(ref binder) =>
1175 Predicate::Subtype(binder.map_bound(|data| data.subst(tcx, substs))),
1176 Predicate::RegionOutlives(ref binder) =>
1177 Predicate::RegionOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1178 Predicate::TypeOutlives(ref binder) =>
1179 Predicate::TypeOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1180 Predicate::Projection(ref binder) =>
1181 Predicate::Projection(binder.map_bound(|data| data.subst(tcx, substs))),
1182 Predicate::WellFormed(data) =>
1183 Predicate::WellFormed(data.subst(tcx, substs)),
1184 Predicate::ObjectSafe(trait_def_id) =>
1185 Predicate::ObjectSafe(trait_def_id),
1186 Predicate::ClosureKind(closure_def_id, closure_substs, kind) =>
1187 Predicate::ClosureKind(closure_def_id, closure_substs.subst(tcx, substs), kind),
1188 Predicate::ConstEvaluatable(def_id, const_substs) =>
1189 Predicate::ConstEvaluatable(def_id, const_substs.subst(tcx, substs)),
1194 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1195 pub struct TraitPredicate<'tcx> {
1196 pub trait_ref: TraitRef<'tcx>
1198 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
1200 impl<'tcx> TraitPredicate<'tcx> {
1201 pub fn def_id(&self) -> DefId {
1202 self.trait_ref.def_id
1205 pub fn input_types<'a>(&'a self) -> impl DoubleEndedIterator<Item=Ty<'tcx>> + 'a {
1206 self.trait_ref.input_types()
1209 pub fn self_ty(&self) -> Ty<'tcx> {
1210 self.trait_ref.self_ty()
1214 impl<'tcx> PolyTraitPredicate<'tcx> {
1215 pub fn def_id(&self) -> DefId {
1216 // ok to skip binder since trait def-id does not care about regions
1217 self.skip_binder().def_id()
1221 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, RustcEncodable, RustcDecodable)]
1222 pub struct OutlivesPredicate<A,B>(pub A, pub B); // `A : B`
1223 pub type PolyOutlivesPredicate<A,B> = ty::Binder<OutlivesPredicate<A,B>>;
1224 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>,
1226 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>,
1228 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<RegionOutlivesPredicate<'tcx>>;
1229 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<TypeOutlivesPredicate<'tcx>>;
1231 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
1232 pub struct SubtypePredicate<'tcx> {
1233 pub a_is_expected: bool,
1237 pub type PolySubtypePredicate<'tcx> = ty::Binder<SubtypePredicate<'tcx>>;
1239 /// This kind of predicate has no *direct* correspondent in the
1240 /// syntax, but it roughly corresponds to the syntactic forms:
1242 /// 1. `T : TraitRef<..., Item=Type>`
1243 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
1245 /// In particular, form #1 is "desugared" to the combination of a
1246 /// normal trait predicate (`T : TraitRef<...>`) and one of these
1247 /// predicates. Form #2 is a broader form in that it also permits
1248 /// equality between arbitrary types. Processing an instance of
1249 /// Form #2 eventually yields one of these `ProjectionPredicate`
1250 /// instances to normalize the LHS.
1251 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1252 pub struct ProjectionPredicate<'tcx> {
1253 pub projection_ty: ProjectionTy<'tcx>,
1257 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
1259 impl<'tcx> PolyProjectionPredicate<'tcx> {
1260 /// Returns the def-id of the associated item being projected.
1261 pub fn item_def_id(&self) -> DefId {
1262 self.skip_binder().projection_ty.item_def_id
1265 pub fn to_poly_trait_ref(&self, tcx: TyCtxt<'_, '_, '_>) -> PolyTraitRef<'tcx> {
1266 // Note: unlike with TraitRef::to_poly_trait_ref(),
1267 // self.0.trait_ref is permitted to have escaping regions.
1268 // This is because here `self` has a `Binder` and so does our
1269 // return value, so we are preserving the number of binding
1271 self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
1274 pub fn ty(&self) -> Binder<Ty<'tcx>> {
1275 self.map_bound(|predicate| predicate.ty)
1278 /// The DefId of the TraitItem for the associated type.
1280 /// Note that this is not the DefId of the TraitRef containing this
1281 /// associated type, which is in tcx.associated_item(projection_def_id()).container.
1282 pub fn projection_def_id(&self) -> DefId {
1283 // ok to skip binder since trait def-id does not care about regions
1284 self.skip_binder().projection_ty.item_def_id
1288 pub trait ToPolyTraitRef<'tcx> {
1289 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
1292 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
1293 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1294 ty::Binder::dummy(self.clone())
1298 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
1299 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1300 self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
1304 pub trait ToPredicate<'tcx> {
1305 fn to_predicate(&self) -> Predicate<'tcx>;
1308 impl<'tcx> ToPredicate<'tcx> for TraitRef<'tcx> {
1309 fn to_predicate(&self) -> Predicate<'tcx> {
1310 ty::Predicate::Trait(ty::Binder::dummy(ty::TraitPredicate {
1311 trait_ref: self.clone()
1316 impl<'tcx> ToPredicate<'tcx> for PolyTraitRef<'tcx> {
1317 fn to_predicate(&self) -> Predicate<'tcx> {
1318 ty::Predicate::Trait(self.to_poly_trait_predicate())
1322 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1323 fn to_predicate(&self) -> Predicate<'tcx> {
1324 Predicate::RegionOutlives(self.clone())
1328 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1329 fn to_predicate(&self) -> Predicate<'tcx> {
1330 Predicate::TypeOutlives(self.clone())
1334 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1335 fn to_predicate(&self) -> Predicate<'tcx> {
1336 Predicate::Projection(self.clone())
1340 impl<'tcx> Predicate<'tcx> {
1341 /// Iterates over the types in this predicate. Note that in all
1342 /// cases this is skipping over a binder, so late-bound regions
1343 /// with depth 0 are bound by the predicate.
1344 pub fn walk_tys(&self) -> IntoIter<Ty<'tcx>> {
1345 let vec: Vec<_> = match *self {
1346 ty::Predicate::Trait(ref data) => {
1347 data.skip_binder().input_types().collect()
1349 ty::Predicate::Subtype(binder) => {
1350 let SubtypePredicate { a, b, a_is_expected: _ } = binder.skip_binder();
1353 ty::Predicate::TypeOutlives(binder) => {
1354 vec![binder.skip_binder().0]
1356 ty::Predicate::RegionOutlives(..) => {
1359 ty::Predicate::Projection(ref data) => {
1360 let inner = data.skip_binder();
1361 inner.projection_ty.substs.types().chain(Some(inner.ty)).collect()
1363 ty::Predicate::WellFormed(data) => {
1366 ty::Predicate::ObjectSafe(_trait_def_id) => {
1369 ty::Predicate::ClosureKind(_closure_def_id, closure_substs, _kind) => {
1370 closure_substs.substs.types().collect()
1372 ty::Predicate::ConstEvaluatable(_, substs) => {
1373 substs.types().collect()
1377 // FIXME: The only reason to collect into a vector here is that I was
1378 // too lazy to make the full (somewhat complicated) iterator
1379 // type that would be needed here. But I wanted this fn to
1380 // return an iterator conceptually, rather than a `Vec`, so as
1381 // to be closer to `Ty::walk`.
1385 pub fn to_opt_poly_trait_ref(&self) -> Option<PolyTraitRef<'tcx>> {
1387 Predicate::Trait(ref t) => {
1388 Some(t.to_poly_trait_ref())
1390 Predicate::Projection(..) |
1391 Predicate::Subtype(..) |
1392 Predicate::RegionOutlives(..) |
1393 Predicate::WellFormed(..) |
1394 Predicate::ObjectSafe(..) |
1395 Predicate::ClosureKind(..) |
1396 Predicate::TypeOutlives(..) |
1397 Predicate::ConstEvaluatable(..) => {
1403 pub fn to_opt_type_outlives(&self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1405 Predicate::TypeOutlives(data) => {
1408 Predicate::Trait(..) |
1409 Predicate::Projection(..) |
1410 Predicate::Subtype(..) |
1411 Predicate::RegionOutlives(..) |
1412 Predicate::WellFormed(..) |
1413 Predicate::ObjectSafe(..) |
1414 Predicate::ClosureKind(..) |
1415 Predicate::ConstEvaluatable(..) => {
1422 /// Represents the bounds declared on a particular set of type
1423 /// parameters. Should eventually be generalized into a flag list of
1424 /// where clauses. You can obtain a `InstantiatedPredicates` list from a
1425 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1426 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1427 /// the `GenericPredicates` are expressed in terms of the bound type
1428 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1429 /// represented a set of bounds for some particular instantiation,
1430 /// meaning that the generic parameters have been substituted with
1435 /// struct Foo<T,U:Bar<T>> { ... }
1437 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1438 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1439 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1440 /// [usize:Bar<isize>]]`.
1442 pub struct InstantiatedPredicates<'tcx> {
1443 pub predicates: Vec<Predicate<'tcx>>,
1446 impl<'tcx> InstantiatedPredicates<'tcx> {
1447 pub fn empty() -> InstantiatedPredicates<'tcx> {
1448 InstantiatedPredicates { predicates: vec![] }
1451 pub fn is_empty(&self) -> bool {
1452 self.predicates.is_empty()
1456 /// "Universes" are used during type- and trait-checking in the
1457 /// presence of `for<..>` binders to control what sets of names are
1458 /// visible. Universes are arranged into a tree: the root universe
1459 /// contains names that are always visible. But when you enter into
1460 /// some subuniverse, then it may add names that are only visible
1461 /// within that subtree (but it can still name the names of its
1462 /// ancestor universes).
1464 /// To make this more concrete, consider this program:
1468 /// fn bar<T>(x: T) {
1469 /// let y: for<'a> fn(&'a u8, Foo) = ...;
1473 /// The struct name `Foo` is in the root universe U0. But the type
1474 /// parameter `T`, introduced on `bar`, is in a subuniverse U1 --
1475 /// i.e., within `bar`, we can name both `T` and `Foo`, but outside of
1476 /// `bar`, we cannot name `T`. Then, within the type of `y`, the
1477 /// region `'a` is in a subuniverse U2 of U1, because we can name it
1478 /// inside the fn type but not outside.
1480 /// Universes are used to do type- and trait-checking around these
1481 /// "forall" binders (also called **universal quantification**). The
1482 /// idea is that when, in the body of `bar`, we refer to `T` as a
1483 /// type, we aren't referring to any type in particular, but rather a
1484 /// kind of "fresh" type that is distinct from all other types we have
1485 /// actually declared. This is called a **placeholder** type, and we
1486 /// use universes to talk about this. In other words, a type name in
1487 /// universe 0 always corresponds to some "ground" type that the user
1488 /// declared, but a type name in a non-zero universe is a placeholder
1489 /// type -- an idealized representative of "types in general" that we
1490 /// use for checking generic functions.
1491 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
1492 pub struct UniverseIndex(u32);
1494 impl UniverseIndex {
1495 /// The root universe, where things that the user defined are
1497 pub const ROOT: Self = UniverseIndex(0);
1499 /// The "max universe" -- this isn't really a valid universe, but
1500 /// it's useful sometimes as a "starting value" when you are
1501 /// taking the minimum of a (non-empty!) set of universes.
1502 pub const MAX: Self = UniverseIndex(::std::u32::MAX);
1504 /// Creates a universe index from the given integer. Not to be
1505 /// used lightly lest you pick a bad value. But sometimes we
1506 /// convert universe indices into integers and back for various
1508 pub fn from_u32(index: u32) -> Self {
1509 UniverseIndex(index)
1512 /// A "subuniverse" corresponds to being inside a `forall` quantifier.
1513 /// So, for example, suppose we have this type in universe `U`:
1516 /// for<'a> fn(&'a u32)
1519 /// Once we "enter" into this `for<'a>` quantifier, we are in a
1520 /// subuniverse of `U` -- in this new universe, we can name the
1521 /// region `'a`, but that region was not nameable from `U` because
1522 /// it was not in scope there.
1523 pub fn subuniverse(self) -> UniverseIndex {
1524 UniverseIndex(self.0.checked_add(1).unwrap())
1527 /// True if the names in this universe are a subset of the names in `other`.
1528 pub fn is_subset_of(self, other: UniverseIndex) -> bool {
1532 pub fn as_u32(&self) -> u32 {
1536 pub fn as_usize(&self) -> usize {
1541 impl fmt::Debug for UniverseIndex {
1542 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
1543 write!(fmt, "U{}", self.as_u32())
1547 impl From<u32> for UniverseIndex {
1548 fn from(index: u32) -> Self {
1549 UniverseIndex(index)
1553 /// The "placeholder index" fully defines a placeholder region.
1554 /// Placeholder regions are identified by both a **universe** as well
1555 /// as a "bound-region" within that universe. The `bound_region` is
1556 /// basically a name -- distinct bound regions within the same
1557 /// universe are just two regions with an unknown relationship to one
1559 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, PartialOrd, Ord)]
1560 pub struct Placeholder {
1561 pub universe: UniverseIndex,
1562 pub name: BoundRegion,
1565 /// When type checking, we use the `ParamEnv` to track
1566 /// details about the set of where-clauses that are in scope at this
1567 /// particular point.
1568 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
1569 pub struct ParamEnv<'tcx> {
1570 /// Obligations that the caller must satisfy. This is basically
1571 /// the set of bounds on the in-scope type parameters, translated
1572 /// into Obligations, and elaborated and normalized.
1573 pub caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1575 /// Typically, this is `Reveal::UserFacing`, but during codegen we
1576 /// want `Reveal::All` -- note that this is always paired with an
1577 /// empty environment. To get that, use `ParamEnv::reveal()`.
1578 pub reveal: traits::Reveal,
1581 impl<'tcx> ParamEnv<'tcx> {
1582 /// Construct a trait environment suitable for contexts where
1583 /// there are no where clauses in scope. Hidden types (like `impl
1584 /// Trait`) are left hidden, so this is suitable for ordinary
1586 pub fn empty() -> Self {
1587 Self::new(List::empty(), Reveal::UserFacing)
1590 /// Construct a trait environment with no where clauses in scope
1591 /// where the values of all `impl Trait` and other hidden types
1592 /// are revealed. This is suitable for monomorphized, post-typeck
1593 /// environments like codegen or doing optimizations.
1595 /// NB. If you want to have predicates in scope, use `ParamEnv::new`,
1596 /// or invoke `param_env.with_reveal_all()`.
1597 pub fn reveal_all() -> Self {
1598 Self::new(List::empty(), Reveal::All)
1601 /// Construct a trait environment with the given set of predicates.
1602 pub fn new(caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1605 ty::ParamEnv { caller_bounds, reveal }
1608 /// Returns a new parameter environment with the same clauses, but
1609 /// which "reveals" the true results of projections in all cases
1610 /// (even for associated types that are specializable). This is
1611 /// the desired behavior during codegen and certain other special
1612 /// contexts; normally though we want to use `Reveal::UserFacing`,
1613 /// which is the default.
1614 pub fn with_reveal_all(self) -> Self {
1615 ty::ParamEnv { reveal: Reveal::All, ..self }
1618 /// Returns this same environment but with no caller bounds.
1619 pub fn without_caller_bounds(self) -> Self {
1620 ty::ParamEnv { caller_bounds: List::empty(), ..self }
1623 /// Creates a suitable environment in which to perform trait
1624 /// queries on the given value. When type-checking, this is simply
1625 /// the pair of the environment plus value. But when reveal is set to
1626 /// All, then if `value` does not reference any type parameters, we will
1627 /// pair it with the empty environment. This improves caching and is generally
1630 /// NB: We preserve the environment when type-checking because it
1631 /// is possible for the user to have wacky where-clauses like
1632 /// `where Box<u32>: Copy`, which are clearly never
1633 /// satisfiable. We generally want to behave as if they were true,
1634 /// although the surrounding function is never reachable.
1635 pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
1637 Reveal::UserFacing => {
1646 || value.needs_infer()
1647 || value.has_param_types()
1648 || value.has_self_ty()
1656 param_env: self.without_caller_bounds(),
1665 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
1666 pub struct ParamEnvAnd<'tcx, T> {
1667 pub param_env: ParamEnv<'tcx>,
1671 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
1672 pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
1673 (self.param_env, self.value)
1677 impl<'a, 'gcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'gcx, T>
1678 where T: HashStable<StableHashingContext<'a>>
1680 fn hash_stable<W: StableHasherResult>(&self,
1681 hcx: &mut StableHashingContext<'a>,
1682 hasher: &mut StableHasher<W>) {
1688 param_env.hash_stable(hcx, hasher);
1689 value.hash_stable(hcx, hasher);
1693 #[derive(Copy, Clone, Debug)]
1694 pub struct Destructor {
1695 /// The def-id of the destructor method
1700 pub struct AdtFlags: u32 {
1701 const NO_ADT_FLAGS = 0;
1702 const IS_ENUM = 1 << 0;
1703 const IS_PHANTOM_DATA = 1 << 1;
1704 const IS_FUNDAMENTAL = 1 << 2;
1705 const IS_UNION = 1 << 3;
1706 const IS_BOX = 1 << 4;
1707 /// Indicates whether the type is an `Arc`.
1708 const IS_ARC = 1 << 5;
1709 /// Indicates whether the type is an `Rc`.
1710 const IS_RC = 1 << 6;
1711 /// Indicates whether the variant list of this ADT is `#[non_exhaustive]`.
1712 /// (i.e., this flag is never set unless this ADT is an enum).
1713 const IS_VARIANT_LIST_NON_EXHAUSTIVE = 1 << 7;
1718 pub struct VariantFlags: u32 {
1719 const NO_VARIANT_FLAGS = 0;
1720 /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
1721 const IS_FIELD_LIST_NON_EXHAUSTIVE = 1 << 0;
1726 pub struct VariantDef {
1727 /// The variant's DefId. If this is a tuple-like struct,
1728 /// this is the DefId of the struct's ctor.
1730 pub name: Name, // struct's name if this is a struct
1731 pub discr: VariantDiscr,
1732 pub fields: Vec<FieldDef>,
1733 pub ctor_kind: CtorKind,
1734 flags: VariantFlags,
1737 impl<'a, 'gcx, 'tcx> VariantDef {
1738 /// Create a new `VariantDef`.
1740 /// - `did` is the DefId used for the variant - for tuple-structs, it is the constructor DefId,
1741 /// and for everything else, it is the variant DefId.
1742 /// - `attribute_def_id` is the DefId that has the variant's attributes.
1743 /// this is the struct DefId for structs, and the variant DefId for variants.
1745 /// Note that we *could* use the constructor DefId, because the constructor attributes
1746 /// redirect to the base attributes, but compiling a small crate requires
1747 /// loading the AdtDefs for all the structs in the universe (e.g. coherence for any
1748 /// built-in trait), and we do not want to load attributes twice.
1750 /// If someone speeds up attribute loading to not be a performance concern, they can
1751 /// remove this hack and use the constructor DefId everywhere.
1752 pub fn new(tcx: TyCtxt<'a, 'gcx, 'tcx>,
1755 discr: VariantDiscr,
1756 fields: Vec<FieldDef>,
1758 ctor_kind: CtorKind,
1759 attribute_def_id: DefId)
1762 debug!("VariantDef::new({:?}, {:?}, {:?}, {:?}, {:?}, {:?}, {:?})", did, name, discr,
1763 fields, adt_kind, ctor_kind, attribute_def_id);
1764 let mut flags = VariantFlags::NO_VARIANT_FLAGS;
1765 if adt_kind == AdtKind::Struct && tcx.has_attr(attribute_def_id, "non_exhaustive") {
1766 debug!("found non-exhaustive field list for {:?}", did);
1767 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1780 pub fn is_field_list_non_exhaustive(&self) -> bool {
1781 self.flags.intersects(VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE)
1785 impl_stable_hash_for!(struct VariantDef {
1794 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
1795 pub enum VariantDiscr {
1796 /// Explicit value for this variant, i.e. `X = 123`.
1797 /// The `DefId` corresponds to the embedded constant.
1800 /// The previous variant's discriminant plus one.
1801 /// For efficiency reasons, the distance from the
1802 /// last `Explicit` discriminant is being stored,
1803 /// or `0` for the first variant, if it has none.
1808 pub struct FieldDef {
1811 pub vis: Visibility,
1814 /// The definition of an abstract data type - a struct or enum.
1816 /// These are all interned (by intern_adt_def) into the adt_defs
1820 pub variants: Vec<VariantDef>,
1822 pub repr: ReprOptions,
1825 impl PartialOrd for AdtDef {
1826 fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering> {
1827 Some(self.cmp(&other))
1831 /// There should be only one AdtDef for each `did`, therefore
1832 /// it is fine to implement `Ord` only based on `did`.
1833 impl Ord for AdtDef {
1834 fn cmp(&self, other: &AdtDef) -> Ordering {
1835 self.did.cmp(&other.did)
1839 impl PartialEq for AdtDef {
1840 // AdtDef are always interned and this is part of TyS equality
1842 fn eq(&self, other: &Self) -> bool { ptr::eq(self, other) }
1845 impl Eq for AdtDef {}
1847 impl Hash for AdtDef {
1849 fn hash<H: Hasher>(&self, s: &mut H) {
1850 (self as *const AdtDef).hash(s)
1854 impl<'tcx> serialize::UseSpecializedEncodable for &'tcx AdtDef {
1855 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1860 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx AdtDef {}
1863 impl<'a> HashStable<StableHashingContext<'a>> for AdtDef {
1864 fn hash_stable<W: StableHasherResult>(&self,
1865 hcx: &mut StableHashingContext<'a>,
1866 hasher: &mut StableHasher<W>) {
1868 static CACHE: RefCell<FxHashMap<usize, Fingerprint>> =
1869 RefCell::new(FxHashMap());
1872 let hash: Fingerprint = CACHE.with(|cache| {
1873 let addr = self as *const AdtDef as usize;
1874 *cache.borrow_mut().entry(addr).or_insert_with(|| {
1882 let mut hasher = StableHasher::new();
1883 did.hash_stable(hcx, &mut hasher);
1884 variants.hash_stable(hcx, &mut hasher);
1885 flags.hash_stable(hcx, &mut hasher);
1886 repr.hash_stable(hcx, &mut hasher);
1892 hash.hash_stable(hcx, hasher);
1896 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
1897 pub enum AdtKind { Struct, Union, Enum }
1899 impl Into<DataTypeKind> for AdtKind {
1900 fn into(self) -> DataTypeKind {
1902 AdtKind::Struct => DataTypeKind::Struct,
1903 AdtKind::Union => DataTypeKind::Union,
1904 AdtKind::Enum => DataTypeKind::Enum,
1910 #[derive(RustcEncodable, RustcDecodable, Default)]
1911 pub struct ReprFlags: u8 {
1912 const IS_C = 1 << 0;
1913 const IS_SIMD = 1 << 1;
1914 const IS_TRANSPARENT = 1 << 2;
1915 // Internal only for now. If true, don't reorder fields.
1916 const IS_LINEAR = 1 << 3;
1918 // Any of these flags being set prevent field reordering optimisation.
1919 const IS_UNOPTIMISABLE = ReprFlags::IS_C.bits |
1920 ReprFlags::IS_SIMD.bits |
1921 ReprFlags::IS_LINEAR.bits;
1925 impl_stable_hash_for!(struct ReprFlags {
1931 /// Represents the repr options provided by the user,
1932 #[derive(Copy, Clone, Debug, Eq, PartialEq, RustcEncodable, RustcDecodable, Default)]
1933 pub struct ReprOptions {
1934 pub int: Option<attr::IntType>,
1937 pub flags: ReprFlags,
1940 impl_stable_hash_for!(struct ReprOptions {
1948 pub fn new(tcx: TyCtxt<'_, '_, '_>, did: DefId) -> ReprOptions {
1949 let mut flags = ReprFlags::empty();
1950 let mut size = None;
1951 let mut max_align = 0;
1952 let mut min_pack = 0;
1953 for attr in tcx.get_attrs(did).iter() {
1954 for r in attr::find_repr_attrs(tcx.sess.diagnostic(), attr) {
1955 flags.insert(match r {
1956 attr::ReprC => ReprFlags::IS_C,
1957 attr::ReprPacked(pack) => {
1958 min_pack = if min_pack > 0 {
1959 cmp::min(pack, min_pack)
1965 attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
1966 attr::ReprSimd => ReprFlags::IS_SIMD,
1967 attr::ReprInt(i) => {
1971 attr::ReprAlign(align) => {
1972 max_align = cmp::max(align, max_align);
1979 // This is here instead of layout because the choice must make it into metadata.
1980 if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.item_path_str(did))) {
1981 flags.insert(ReprFlags::IS_LINEAR);
1983 ReprOptions { int: size, align: max_align, pack: min_pack, flags: flags }
1987 pub fn simd(&self) -> bool { self.flags.contains(ReprFlags::IS_SIMD) }
1989 pub fn c(&self) -> bool { self.flags.contains(ReprFlags::IS_C) }
1991 pub fn packed(&self) -> bool { self.pack > 0 }
1993 pub fn transparent(&self) -> bool { self.flags.contains(ReprFlags::IS_TRANSPARENT) }
1995 pub fn linear(&self) -> bool { self.flags.contains(ReprFlags::IS_LINEAR) }
1997 pub fn discr_type(&self) -> attr::IntType {
1998 self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
2001 /// Returns true if this `#[repr()]` should inhabit "smart enum
2002 /// layout" optimizations, such as representing `Foo<&T>` as a
2004 pub fn inhibit_enum_layout_opt(&self) -> bool {
2005 self.c() || self.int.is_some()
2008 /// Returns true if this `#[repr()]` should inhibit struct field reordering
2009 /// optimizations, such as with repr(C) or repr(packed(1)).
2010 pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
2011 !(self.flags & ReprFlags::IS_UNOPTIMISABLE).is_empty() || (self.pack == 1)
2015 impl<'a, 'gcx, 'tcx> AdtDef {
2016 fn new(tcx: TyCtxt<'_, '_, '_>,
2019 variants: Vec<VariantDef>,
2020 repr: ReprOptions) -> Self {
2021 debug!("AdtDef::new({:?}, {:?}, {:?}, {:?})", did, kind, variants, repr);
2022 let mut flags = AdtFlags::NO_ADT_FLAGS;
2023 let attrs = tcx.get_attrs(did);
2024 if attr::contains_name(&attrs, "fundamental") {
2025 flags = flags | AdtFlags::IS_FUNDAMENTAL;
2027 if Some(did) == tcx.lang_items().phantom_data() {
2028 flags = flags | AdtFlags::IS_PHANTOM_DATA;
2030 if Some(did) == tcx.lang_items().owned_box() {
2031 flags = flags | AdtFlags::IS_BOX;
2033 if Some(did) == tcx.lang_items().arc() {
2034 flags = flags | AdtFlags::IS_ARC;
2036 if Some(did) == tcx.lang_items().rc() {
2037 flags = flags | AdtFlags::IS_RC;
2039 if kind == AdtKind::Enum && tcx.has_attr(did, "non_exhaustive") {
2040 debug!("found non-exhaustive variant list for {:?}", did);
2041 flags = flags | AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE;
2044 AdtKind::Enum => flags = flags | AdtFlags::IS_ENUM,
2045 AdtKind::Union => flags = flags | AdtFlags::IS_UNION,
2046 AdtKind::Struct => {}
2057 pub fn is_struct(&self) -> bool {
2058 !self.is_union() && !self.is_enum()
2062 pub fn is_union(&self) -> bool {
2063 self.flags.intersects(AdtFlags::IS_UNION)
2067 pub fn is_enum(&self) -> bool {
2068 self.flags.intersects(AdtFlags::IS_ENUM)
2072 pub fn is_variant_list_non_exhaustive(&self) -> bool {
2073 self.flags.intersects(AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE)
2076 /// Returns the kind of the ADT - Struct or Enum.
2078 pub fn adt_kind(&self) -> AdtKind {
2081 } else if self.is_union() {
2088 pub fn descr(&self) -> &'static str {
2089 match self.adt_kind() {
2090 AdtKind::Struct => "struct",
2091 AdtKind::Union => "union",
2092 AdtKind::Enum => "enum",
2096 pub fn variant_descr(&self) -> &'static str {
2097 match self.adt_kind() {
2098 AdtKind::Struct => "struct",
2099 AdtKind::Union => "union",
2100 AdtKind::Enum => "variant",
2104 /// Returns whether this type is #[fundamental] for the purposes
2105 /// of coherence checking.
2107 pub fn is_fundamental(&self) -> bool {
2108 self.flags.intersects(AdtFlags::IS_FUNDAMENTAL)
2111 /// Returns true if this is PhantomData<T>.
2113 pub fn is_phantom_data(&self) -> bool {
2114 self.flags.intersects(AdtFlags::IS_PHANTOM_DATA)
2117 /// Returns `true` if this is `Arc<T>`.
2118 pub fn is_arc(&self) -> bool {
2119 self.flags.intersects(AdtFlags::IS_ARC)
2122 /// Returns `true` if this is `Rc<T>`.
2123 pub fn is_rc(&self) -> bool {
2124 self.flags.intersects(AdtFlags::IS_RC)
2127 /// Returns true if this is Box<T>.
2129 pub fn is_box(&self) -> bool {
2130 self.flags.intersects(AdtFlags::IS_BOX)
2133 /// Returns whether this type has a destructor.
2134 pub fn has_dtor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
2135 self.destructor(tcx).is_some()
2138 /// Asserts this is a struct or union and returns its unique variant.
2139 pub fn non_enum_variant(&self) -> &VariantDef {
2140 assert!(self.is_struct() || self.is_union());
2145 pub fn predicates(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> GenericPredicates<'gcx> {
2146 tcx.predicates_of(self.did)
2149 /// Returns an iterator over all fields contained
2152 pub fn all_fields<'s>(&'s self) -> impl Iterator<Item = &'s FieldDef> {
2153 self.variants.iter().flat_map(|v| v.fields.iter())
2156 pub fn is_payloadfree(&self) -> bool {
2157 !self.variants.is_empty() &&
2158 self.variants.iter().all(|v| v.fields.is_empty())
2161 pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
2164 .find(|v| v.did == vid)
2165 .expect("variant_with_id: unknown variant")
2168 pub fn variant_index_with_id(&self, vid: DefId) -> usize {
2171 .position(|v| v.did == vid)
2172 .expect("variant_index_with_id: unknown variant")
2175 pub fn variant_of_def(&self, def: Def) -> &VariantDef {
2177 Def::Variant(vid) | Def::VariantCtor(vid, ..) => self.variant_with_id(vid),
2178 Def::Struct(..) | Def::StructCtor(..) | Def::Union(..) |
2179 Def::TyAlias(..) | Def::AssociatedTy(..) | Def::SelfTy(..) |
2180 Def::SelfCtor(..) => self.non_enum_variant(),
2181 _ => bug!("unexpected def {:?} in variant_of_def", def)
2186 pub fn eval_explicit_discr(
2188 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2190 ) -> Option<Discr<'tcx>> {
2191 let param_env = ParamEnv::empty();
2192 let repr_type = self.repr.discr_type();
2193 let substs = Substs::identity_for_item(tcx.global_tcx(), expr_did);
2194 let instance = ty::Instance::new(expr_did, substs);
2195 let cid = GlobalId {
2199 match tcx.const_eval(param_env.and(cid)) {
2201 // FIXME: Find the right type and use it instead of `val.ty` here
2202 if let Some(b) = val.assert_bits(tcx.global_tcx(), param_env.and(val.ty)) {
2203 trace!("discriminants: {} ({:?})", b, repr_type);
2209 info!("invalid enum discriminant: {:#?}", val);
2210 ::mir::interpret::struct_error(
2211 tcx.at(tcx.def_span(expr_did)),
2212 "constant evaluation of enum discriminant resulted in non-integer",
2218 err.report_as_error(
2219 tcx.at(tcx.def_span(expr_did)),
2220 "could not evaluate enum discriminant",
2222 if !expr_did.is_local() {
2223 span_bug!(tcx.def_span(expr_did),
2224 "variant discriminant evaluation succeeded \
2225 in its crate but failed locally");
2233 pub fn discriminants(
2235 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2236 ) -> impl Iterator<Item=Discr<'tcx>> + Captures<'gcx> + 'a {
2237 let repr_type = self.repr.discr_type();
2238 let initial = repr_type.initial_discriminant(tcx.global_tcx());
2239 let mut prev_discr = None::<Discr<'tcx>>;
2240 self.variants.iter().map(move |v| {
2241 let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
2242 if let VariantDiscr::Explicit(expr_did) = v.discr {
2243 if let Some(new_discr) = self.eval_explicit_discr(tcx, expr_did) {
2247 prev_discr = Some(discr);
2253 /// Compute the discriminant value used by a specific variant.
2254 /// Unlike `discriminants`, this is (amortized) constant-time,
2255 /// only doing at most one query for evaluating an explicit
2256 /// discriminant (the last one before the requested variant),
2257 /// assuming there are no constant-evaluation errors there.
2258 pub fn discriminant_for_variant(&self,
2259 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2260 variant_index: usize)
2262 let (val, offset) = self.discriminant_def_for_variant(variant_index);
2263 let explicit_value = val
2264 .and_then(|expr_did| self.eval_explicit_discr(tcx, expr_did))
2265 .unwrap_or_else(|| self.repr.discr_type().initial_discriminant(tcx.global_tcx()));
2266 explicit_value.checked_add(tcx, offset as u128).0
2269 /// Yields a DefId for the discriminant and an offset to add to it
2270 /// Alternatively, if there is no explicit discriminant, returns the
2271 /// inferred discriminant directly
2272 pub fn discriminant_def_for_variant(
2274 variant_index: usize,
2275 ) -> (Option<DefId>, usize) {
2276 let mut explicit_index = variant_index;
2279 match self.variants[explicit_index].discr {
2280 ty::VariantDiscr::Relative(0) => {
2284 ty::VariantDiscr::Relative(distance) => {
2285 explicit_index -= distance;
2287 ty::VariantDiscr::Explicit(did) => {
2288 expr_did = Some(did);
2293 (expr_did, variant_index - explicit_index)
2296 pub fn destructor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Option<Destructor> {
2297 tcx.adt_destructor(self.did)
2300 /// Returns a list of types such that `Self: Sized` if and only
2301 /// if that type is Sized, or `TyErr` if this type is recursive.
2303 /// Oddly enough, checking that the sized-constraint is Sized is
2304 /// actually more expressive than checking all members:
2305 /// the Sized trait is inductive, so an associated type that references
2306 /// Self would prevent its containing ADT from being Sized.
2308 /// Due to normalization being eager, this applies even if
2309 /// the associated type is behind a pointer, e.g. issue #31299.
2310 pub fn sized_constraint(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> &'tcx [Ty<'tcx>] {
2311 match tcx.try_adt_sized_constraint(DUMMY_SP, self.did) {
2314 debug!("adt_sized_constraint: {:?} is recursive", self);
2315 // This should be reported as an error by `check_representable`.
2317 // Consider the type as Sized in the meanwhile to avoid
2318 // further errors. Delay our `bug` diagnostic here to get
2319 // emitted later as well in case we accidentally otherwise don't
2322 tcx.intern_type_list(&[tcx.types.err])
2327 fn sized_constraint_for_ty(&self,
2328 tcx: TyCtxt<'a, 'tcx, 'tcx>,
2331 let result = match ty.sty {
2332 Bool | Char | Int(..) | Uint(..) | Float(..) |
2333 RawPtr(..) | Ref(..) | FnDef(..) | FnPtr(_) |
2334 Array(..) | Closure(..) | Generator(..) | Never => {
2343 GeneratorWitness(..) => {
2344 // these are never sized - return the target type
2351 Some(ty) => self.sized_constraint_for_ty(tcx, ty)
2355 Adt(adt, substs) => {
2357 let adt_tys = adt.sized_constraint(tcx);
2358 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}",
2361 .map(|ty| ty.subst(tcx, substs))
2362 .flat_map(|ty| self.sized_constraint_for_ty(tcx, ty))
2366 Projection(..) | Opaque(..) => {
2367 // must calculate explicitly.
2368 // FIXME: consider special-casing always-Sized projections
2372 UnnormalizedProjection(..) => bug!("only used with chalk-engine"),
2375 // perf hack: if there is a `T: Sized` bound, then
2376 // we know that `T` is Sized and do not need to check
2379 let sized_trait = match tcx.lang_items().sized_trait() {
2381 _ => return vec![ty]
2383 let sized_predicate = Binder::dummy(TraitRef {
2384 def_id: sized_trait,
2385 substs: tcx.mk_substs_trait(ty, &[])
2387 let predicates = tcx.predicates_of(self.did).predicates;
2388 if predicates.into_iter().any(|(p, _)| p == sized_predicate) {
2396 bug!("unexpected type `{:?}` in sized_constraint_for_ty",
2400 debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
2405 impl<'a, 'gcx, 'tcx> FieldDef {
2406 pub fn ty(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, subst: &Substs<'tcx>) -> Ty<'tcx> {
2407 tcx.type_of(self.did).subst(tcx, subst)
2411 /// Represents the various closure traits in the Rust language. This
2412 /// will determine the type of the environment (`self`, in the
2413 /// desuaring) argument that the closure expects.
2415 /// You can get the environment type of a closure using
2416 /// `tcx.closure_env_ty()`.
2417 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
2418 pub enum ClosureKind {
2419 // Warning: Ordering is significant here! The ordering is chosen
2420 // because the trait Fn is a subtrait of FnMut and so in turn, and
2421 // hence we order it so that Fn < FnMut < FnOnce.
2427 impl<'a, 'tcx> ClosureKind {
2428 // This is the initial value used when doing upvar inference.
2429 pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn;
2431 pub fn trait_did(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> DefId {
2433 ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem),
2434 ClosureKind::FnMut => {
2435 tcx.require_lang_item(FnMutTraitLangItem)
2437 ClosureKind::FnOnce => {
2438 tcx.require_lang_item(FnOnceTraitLangItem)
2443 /// True if this a type that impls this closure kind
2444 /// must also implement `other`.
2445 pub fn extends(self, other: ty::ClosureKind) -> bool {
2446 match (self, other) {
2447 (ClosureKind::Fn, ClosureKind::Fn) => true,
2448 (ClosureKind::Fn, ClosureKind::FnMut) => true,
2449 (ClosureKind::Fn, ClosureKind::FnOnce) => true,
2450 (ClosureKind::FnMut, ClosureKind::FnMut) => true,
2451 (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
2452 (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
2457 /// Returns the representative scalar type for this closure kind.
2458 /// See `TyS::to_opt_closure_kind` for more details.
2459 pub fn to_ty(self, tcx: TyCtxt<'_, '_, 'tcx>) -> Ty<'tcx> {
2461 ty::ClosureKind::Fn => tcx.types.i8,
2462 ty::ClosureKind::FnMut => tcx.types.i16,
2463 ty::ClosureKind::FnOnce => tcx.types.i32,
2468 impl<'tcx> TyS<'tcx> {
2469 /// Iterator that walks `self` and any types reachable from
2470 /// `self`, in depth-first order. Note that just walks the types
2471 /// that appear in `self`, it does not descend into the fields of
2472 /// structs or variants. For example:
2475 /// isize => { isize }
2476 /// Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
2477 /// [isize] => { [isize], isize }
2479 pub fn walk(&'tcx self) -> TypeWalker<'tcx> {
2480 TypeWalker::new(self)
2483 /// Iterator that walks the immediate children of `self`. Hence
2484 /// `Foo<Bar<i32>, u32>` yields the sequence `[Bar<i32>, u32]`
2485 /// (but not `i32`, like `walk`).
2486 pub fn walk_shallow(&'tcx self) -> smallvec::IntoIter<walk::TypeWalkerArray<'tcx>> {
2487 walk::walk_shallow(self)
2490 /// Walks `ty` and any types appearing within `ty`, invoking the
2491 /// callback `f` on each type. If the callback returns false, then the
2492 /// children of the current type are ignored.
2494 /// Note: prefer `ty.walk()` where possible.
2495 pub fn maybe_walk<F>(&'tcx self, mut f: F)
2496 where F : FnMut(Ty<'tcx>) -> bool
2498 let mut walker = self.walk();
2499 while let Some(ty) = walker.next() {
2501 walker.skip_current_subtree();
2508 pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
2510 hir::MutMutable => MutBorrow,
2511 hir::MutImmutable => ImmBorrow,
2515 /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
2516 /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
2517 /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
2519 pub fn to_mutbl_lossy(self) -> hir::Mutability {
2521 MutBorrow => hir::MutMutable,
2522 ImmBorrow => hir::MutImmutable,
2524 // We have no type corresponding to a unique imm borrow, so
2525 // use `&mut`. It gives all the capabilities of an `&uniq`
2526 // and hence is a safe "over approximation".
2527 UniqueImmBorrow => hir::MutMutable,
2531 pub fn to_user_str(&self) -> &'static str {
2533 MutBorrow => "mutable",
2534 ImmBorrow => "immutable",
2535 UniqueImmBorrow => "uniquely immutable",
2540 #[derive(Debug, Clone)]
2541 pub enum Attributes<'gcx> {
2542 Owned(Lrc<[ast::Attribute]>),
2543 Borrowed(&'gcx [ast::Attribute])
2546 impl<'gcx> ::std::ops::Deref for Attributes<'gcx> {
2547 type Target = [ast::Attribute];
2549 fn deref(&self) -> &[ast::Attribute] {
2551 &Attributes::Owned(ref data) => &data,
2552 &Attributes::Borrowed(data) => data
2557 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2558 pub fn body_tables(self, body: hir::BodyId) -> &'gcx TypeckTables<'gcx> {
2559 self.typeck_tables_of(self.hir.body_owner_def_id(body))
2562 /// Returns an iterator of the def-ids for all body-owners in this
2563 /// crate. If you would prefer to iterate over the bodies
2564 /// themselves, you can do `self.hir.krate().body_ids.iter()`.
2567 ) -> impl Iterator<Item = DefId> + Captures<'tcx> + Captures<'gcx> + 'a {
2571 .map(move |&body_id| self.hir.body_owner_def_id(body_id))
2574 pub fn par_body_owners<F: Fn(DefId) + sync::Sync + sync::Send>(self, f: F) {
2575 par_iter(&self.hir.krate().body_ids).for_each(|&body_id| {
2576 f(self.hir.body_owner_def_id(body_id))
2580 pub fn expr_span(self, id: NodeId) -> Span {
2581 match self.hir.find(id) {
2582 Some(Node::Expr(e)) => {
2586 bug!("Node id {} is not an expr: {:?}", id, f);
2589 bug!("Node id {} is not present in the node map", id);
2594 pub fn provided_trait_methods(self, id: DefId) -> Vec<AssociatedItem> {
2595 self.associated_items(id)
2596 .filter(|item| item.kind == AssociatedKind::Method && item.defaultness.has_value())
2600 pub fn trait_relevant_for_never(self, did: DefId) -> bool {
2601 self.associated_items(did).any(|item| {
2602 item.relevant_for_never()
2606 pub fn opt_associated_item(self, def_id: DefId) -> Option<AssociatedItem> {
2607 let is_associated_item = if let Some(node_id) = self.hir.as_local_node_id(def_id) {
2608 match self.hir.get(node_id) {
2609 Node::TraitItem(_) | Node::ImplItem(_) => true,
2613 match self.describe_def(def_id).expect("no def for def-id") {
2614 Def::AssociatedConst(_) | Def::Method(_) | Def::AssociatedTy(_) => true,
2619 if is_associated_item {
2620 Some(self.associated_item(def_id))
2626 fn associated_item_from_trait_item_ref(self,
2627 parent_def_id: DefId,
2628 parent_vis: &hir::Visibility,
2629 trait_item_ref: &hir::TraitItemRef)
2631 let def_id = self.hir.local_def_id(trait_item_ref.id.node_id);
2632 let (kind, has_self) = match trait_item_ref.kind {
2633 hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2634 hir::AssociatedItemKind::Method { has_self } => {
2635 (ty::AssociatedKind::Method, has_self)
2637 hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2638 hir::AssociatedItemKind::Existential => bug!("only impls can have existentials"),
2642 ident: trait_item_ref.ident,
2644 // Visibility of trait items is inherited from their traits.
2645 vis: Visibility::from_hir(parent_vis, trait_item_ref.id.node_id, self),
2646 defaultness: trait_item_ref.defaultness,
2648 container: TraitContainer(parent_def_id),
2649 method_has_self_argument: has_self
2653 fn associated_item_from_impl_item_ref(self,
2654 parent_def_id: DefId,
2655 impl_item_ref: &hir::ImplItemRef)
2657 let def_id = self.hir.local_def_id(impl_item_ref.id.node_id);
2658 let (kind, has_self) = match impl_item_ref.kind {
2659 hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2660 hir::AssociatedItemKind::Method { has_self } => {
2661 (ty::AssociatedKind::Method, has_self)
2663 hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2664 hir::AssociatedItemKind::Existential => (ty::AssociatedKind::Existential, false),
2668 ident: impl_item_ref.ident,
2670 // Visibility of trait impl items doesn't matter.
2671 vis: ty::Visibility::from_hir(&impl_item_ref.vis, impl_item_ref.id.node_id, self),
2672 defaultness: impl_item_ref.defaultness,
2674 container: ImplContainer(parent_def_id),
2675 method_has_self_argument: has_self
2679 pub fn field_index(self, node_id: NodeId, tables: &TypeckTables<'_>) -> usize {
2680 let hir_id = self.hir.node_to_hir_id(node_id);
2681 tables.field_indices().get(hir_id).cloned().expect("no index for a field")
2684 pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2685 variant.fields.iter().position(|field| {
2686 self.adjust_ident(ident, variant.did, DUMMY_NODE_ID).0 == field.ident.modern()
2690 pub fn associated_items(
2693 ) -> impl Iterator<Item = AssociatedItem> + 'a {
2694 let def_ids = self.associated_item_def_ids(def_id);
2695 Box::new((0..def_ids.len()).map(move |i| self.associated_item(def_ids[i])))
2696 as Box<dyn Iterator<Item = AssociatedItem> + 'a>
2699 /// Returns true if the impls are the same polarity and the trait either
2700 /// has no items or is annotated #[marker] and prevents item overrides.
2701 pub fn impls_are_allowed_to_overlap(self, def_id1: DefId, def_id2: DefId) -> bool {
2702 if self.features().overlapping_marker_traits {
2703 let trait1_is_empty = self.impl_trait_ref(def_id1)
2704 .map_or(false, |trait_ref| {
2705 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2707 let trait2_is_empty = self.impl_trait_ref(def_id2)
2708 .map_or(false, |trait_ref| {
2709 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2711 self.impl_polarity(def_id1) == self.impl_polarity(def_id2)
2714 } else if self.features().marker_trait_attr {
2715 let is_marker_impl = |def_id: DefId| -> bool {
2716 let trait_ref = self.impl_trait_ref(def_id);
2717 trait_ref.map_or(false, |tr| self.trait_def(tr.def_id).is_marker)
2719 self.impl_polarity(def_id1) == self.impl_polarity(def_id2)
2720 && is_marker_impl(def_id1)
2721 && is_marker_impl(def_id2)
2727 // Returns `ty::VariantDef` if `def` refers to a struct,
2728 // or variant or their constructors, panics otherwise.
2729 pub fn expect_variant_def(self, def: Def) -> &'tcx VariantDef {
2731 Def::Variant(did) | Def::VariantCtor(did, ..) => {
2732 let enum_did = self.parent_def_id(did).unwrap();
2733 self.adt_def(enum_did).variant_with_id(did)
2735 Def::Struct(did) | Def::Union(did) => {
2736 self.adt_def(did).non_enum_variant()
2738 Def::StructCtor(ctor_did, ..) => {
2739 let did = self.parent_def_id(ctor_did).expect("struct ctor has no parent");
2740 self.adt_def(did).non_enum_variant()
2742 _ => bug!("expect_variant_def used with unexpected def {:?}", def)
2746 /// Given a `VariantDef`, returns the def-id of the `AdtDef` of which it is a part.
2747 pub fn adt_def_id_of_variant(self, variant_def: &'tcx VariantDef) -> DefId {
2748 let def_key = self.def_key(variant_def.did);
2749 match def_key.disambiguated_data.data {
2750 // for enum variants and tuple structs, the def-id of the ADT itself
2751 // is the *parent* of the variant
2752 DefPathData::EnumVariant(..) | DefPathData::StructCtor =>
2753 DefId { krate: variant_def.did.krate, index: def_key.parent.unwrap() },
2755 // otherwise, for structs and unions, they share a def-id
2756 _ => variant_def.did,
2760 pub fn item_name(self, id: DefId) -> InternedString {
2761 if id.index == CRATE_DEF_INDEX {
2762 self.original_crate_name(id.krate).as_interned_str()
2764 let def_key = self.def_key(id);
2765 // The name of a StructCtor is that of its struct parent.
2766 if let hir_map::DefPathData::StructCtor = def_key.disambiguated_data.data {
2767 self.item_name(DefId {
2769 index: def_key.parent.unwrap()
2772 def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
2773 bug!("item_name: no name for {:?}", self.def_path(id));
2779 /// Return the possibly-auto-generated MIR of a (DefId, Subst) pair.
2780 pub fn instance_mir(self, instance: ty::InstanceDef<'gcx>)
2784 ty::InstanceDef::Item(did) => {
2785 self.optimized_mir(did)
2787 ty::InstanceDef::Intrinsic(..) |
2788 ty::InstanceDef::FnPtrShim(..) |
2789 ty::InstanceDef::Virtual(..) |
2790 ty::InstanceDef::ClosureOnceShim { .. } |
2791 ty::InstanceDef::DropGlue(..) |
2792 ty::InstanceDef::CloneShim(..) => {
2793 self.mir_shims(instance)
2798 /// Given the DefId of an item, returns its MIR, borrowed immutably.
2799 /// Returns None if there is no MIR for the DefId
2800 pub fn maybe_optimized_mir(self, did: DefId) -> Option<&'gcx Mir<'gcx>> {
2801 if self.is_mir_available(did) {
2802 Some(self.optimized_mir(did))
2808 /// Get the attributes of a definition.
2809 pub fn get_attrs(self, did: DefId) -> Attributes<'gcx> {
2810 if let Some(id) = self.hir.as_local_node_id(did) {
2811 Attributes::Borrowed(self.hir.attrs(id))
2813 Attributes::Owned(self.item_attrs(did))
2817 /// Determine whether an item is annotated with an attribute
2818 pub fn has_attr(self, did: DefId, attr: &str) -> bool {
2819 attr::contains_name(&self.get_attrs(did), attr)
2822 /// Returns true if this is an `auto trait`.
2823 pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
2824 self.trait_def(trait_def_id).has_auto_impl
2827 pub fn generator_layout(self, def_id: DefId) -> &'tcx GeneratorLayout<'tcx> {
2828 self.optimized_mir(def_id).generator_layout.as_ref().unwrap()
2831 /// Given the def_id of an impl, return the def_id of the trait it implements.
2832 /// If it implements no trait, return `None`.
2833 pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
2834 self.impl_trait_ref(def_id).map(|tr| tr.def_id)
2837 /// If the given def ID describes a method belonging to an impl, return the
2838 /// ID of the impl that the method belongs to. Otherwise, return `None`.
2839 pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
2840 let item = if def_id.krate != LOCAL_CRATE {
2841 if let Some(Def::Method(_)) = self.describe_def(def_id) {
2842 Some(self.associated_item(def_id))
2847 self.opt_associated_item(def_id)
2850 item.and_then(|trait_item|
2851 match trait_item.container {
2852 TraitContainer(_) => None,
2853 ImplContainer(def_id) => Some(def_id),
2858 /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
2859 /// with the name of the crate containing the impl.
2860 pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
2861 if impl_did.is_local() {
2862 let node_id = self.hir.as_local_node_id(impl_did).unwrap();
2863 Ok(self.hir.span(node_id))
2865 Err(self.crate_name(impl_did.krate))
2869 // Hygienically compare a use-site name (`use_name`) for a field or an associated item with its
2870 // supposed definition name (`def_name`). The method also needs `DefId` of the supposed
2871 // definition's parent/scope to perform comparison.
2872 pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
2873 self.adjust_ident(use_name, def_parent_def_id, DUMMY_NODE_ID).0 == def_name.modern()
2876 pub fn adjust_ident(self, mut ident: Ident, scope: DefId, block: NodeId) -> (Ident, DefId) {
2877 ident = ident.modern();
2878 let target_expansion = match scope.krate {
2879 LOCAL_CRATE => self.hir.definitions().expansion_that_defined(scope.index),
2882 let scope = match ident.span.adjust(target_expansion) {
2883 Some(actual_expansion) =>
2884 self.hir.definitions().parent_module_of_macro_def(actual_expansion),
2885 None if block == DUMMY_NODE_ID => DefId::local(CRATE_DEF_INDEX), // Dummy DefId
2886 None => self.hir.get_module_parent(block),
2892 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2893 pub fn with_freevars<T, F>(self, fid: NodeId, f: F) -> T where
2894 F: FnOnce(&[hir::Freevar]) -> T,
2896 let def_id = self.hir.local_def_id(fid);
2897 match self.freevars(def_id) {
2904 fn associated_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> AssociatedItem {
2905 let id = tcx.hir.as_local_node_id(def_id).unwrap();
2906 let parent_id = tcx.hir.get_parent(id);
2907 let parent_def_id = tcx.hir.local_def_id(parent_id);
2908 let parent_item = tcx.hir.expect_item(parent_id);
2909 match parent_item.node {
2910 hir::ItemKind::Impl(.., ref impl_item_refs) => {
2911 if let Some(impl_item_ref) = impl_item_refs.iter().find(|i| i.id.node_id == id) {
2912 let assoc_item = tcx.associated_item_from_impl_item_ref(parent_def_id,
2914 debug_assert_eq!(assoc_item.def_id, def_id);
2919 hir::ItemKind::Trait(.., ref trait_item_refs) => {
2920 if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.node_id == id) {
2921 let assoc_item = tcx.associated_item_from_trait_item_ref(parent_def_id,
2924 debug_assert_eq!(assoc_item.def_id, def_id);
2932 span_bug!(parent_item.span,
2933 "unexpected parent of trait or impl item or item not found: {:?}",
2937 /// Calculates the Sized-constraint.
2939 /// In fact, there are only a few options for the types in the constraint:
2940 /// - an obviously-unsized type
2941 /// - a type parameter or projection whose Sizedness can't be known
2942 /// - a tuple of type parameters or projections, if there are multiple
2944 /// - a Error, if a type contained itself. The representability
2945 /// check should catch this case.
2946 fn adt_sized_constraint<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2948 -> &'tcx [Ty<'tcx>] {
2949 let def = tcx.adt_def(def_id);
2951 let result = tcx.mk_type_list(def.variants.iter().flat_map(|v| {
2954 def.sized_constraint_for_ty(tcx, tcx.type_of(f.did))
2957 debug!("adt_sized_constraint: {:?} => {:?}", def, result);
2962 fn associated_item_def_ids<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2964 -> Lrc<Vec<DefId>> {
2965 let id = tcx.hir.as_local_node_id(def_id).unwrap();
2966 let item = tcx.hir.expect_item(id);
2967 let vec: Vec<_> = match item.node {
2968 hir::ItemKind::Trait(.., ref trait_item_refs) => {
2969 trait_item_refs.iter()
2970 .map(|trait_item_ref| trait_item_ref.id)
2971 .map(|id| tcx.hir.local_def_id(id.node_id))
2974 hir::ItemKind::Impl(.., ref impl_item_refs) => {
2975 impl_item_refs.iter()
2976 .map(|impl_item_ref| impl_item_ref.id)
2977 .map(|id| tcx.hir.local_def_id(id.node_id))
2980 hir::ItemKind::TraitAlias(..) => vec![],
2981 _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait")
2986 fn def_span<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Span {
2987 tcx.hir.span_if_local(def_id).unwrap()
2990 /// If the given def ID describes an item belonging to a trait,
2991 /// return the ID of the trait that the trait item belongs to.
2992 /// Otherwise, return `None`.
2993 fn trait_of_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Option<DefId> {
2994 tcx.opt_associated_item(def_id)
2995 .and_then(|associated_item| {
2996 match associated_item.container {
2997 TraitContainer(def_id) => Some(def_id),
2998 ImplContainer(_) => None
3003 /// Yields the parent function's `DefId` if `def_id` is an `impl Trait` definition
3004 pub fn is_impl_trait_defn(tcx: TyCtxt<'_, '_, '_>, def_id: DefId) -> Option<DefId> {
3005 if let Some(node_id) = tcx.hir.as_local_node_id(def_id) {
3006 if let Node::Item(item) = tcx.hir.get(node_id) {
3007 if let hir::ItemKind::Existential(ref exist_ty) = item.node {
3008 return exist_ty.impl_trait_fn;
3015 /// See `ParamEnv` struct def'n for details.
3016 fn param_env<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3020 // The param_env of an impl Trait type is its defining function's param_env
3021 if let Some(parent) = is_impl_trait_defn(tcx, def_id) {
3022 return param_env(tcx, parent);
3024 // Compute the bounds on Self and the type parameters.
3026 let InstantiatedPredicates { predicates } =
3027 tcx.predicates_of(def_id).instantiate_identity(tcx);
3029 // Finally, we have to normalize the bounds in the environment, in
3030 // case they contain any associated type projections. This process
3031 // can yield errors if the put in illegal associated types, like
3032 // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
3033 // report these errors right here; this doesn't actually feel
3034 // right to me, because constructing the environment feels like a
3035 // kind of a "idempotent" action, but I'm not sure where would be
3036 // a better place. In practice, we construct environments for
3037 // every fn once during type checking, and we'll abort if there
3038 // are any errors at that point, so after type checking you can be
3039 // sure that this will succeed without errors anyway.
3041 let unnormalized_env = ty::ParamEnv::new(tcx.intern_predicates(&predicates),
3042 traits::Reveal::UserFacing);
3044 let body_id = tcx.hir.as_local_node_id(def_id).map_or(DUMMY_NODE_ID, |id| {
3045 tcx.hir.maybe_body_owned_by(id).map_or(id, |body| body.node_id)
3047 let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
3048 traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
3051 fn crate_disambiguator<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3052 crate_num: CrateNum) -> CrateDisambiguator {
3053 assert_eq!(crate_num, LOCAL_CRATE);
3054 tcx.sess.local_crate_disambiguator()
3057 fn original_crate_name<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3058 crate_num: CrateNum) -> Symbol {
3059 assert_eq!(crate_num, LOCAL_CRATE);
3060 tcx.crate_name.clone()
3063 fn crate_hash<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3064 crate_num: CrateNum)
3066 assert_eq!(crate_num, LOCAL_CRATE);
3070 fn instance_def_size_estimate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
3071 instance_def: InstanceDef<'tcx>)
3073 match instance_def {
3074 InstanceDef::Item(..) |
3075 InstanceDef::DropGlue(..) => {
3076 let mir = tcx.instance_mir(instance_def);
3077 mir.basic_blocks().iter().map(|bb| bb.statements.len()).sum()
3079 // Estimate the size of other compiler-generated shims to be 1.
3084 pub fn provide(providers: &mut ty::query::Providers<'_>) {
3085 context::provide(providers);
3086 erase_regions::provide(providers);
3087 layout::provide(providers);
3088 util::provide(providers);
3089 constness::provide(providers);
3090 *providers = ty::query::Providers {
3092 associated_item_def_ids,
3093 adt_sized_constraint,
3097 crate_disambiguator,
3098 original_crate_name,
3100 trait_impls_of: trait_def::trait_impls_of_provider,
3101 instance_def_size_estimate,
3106 /// A map for the local crate mapping each type to a vector of its
3107 /// inherent impls. This is not meant to be used outside of coherence;
3108 /// rather, you should request the vector for a specific type via
3109 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
3110 /// (constructing this map requires touching the entire crate).
3111 #[derive(Clone, Debug)]
3112 pub struct CrateInherentImpls {
3113 pub inherent_impls: DefIdMap<Lrc<Vec<DefId>>>,
3116 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable)]
3117 pub struct SymbolName {
3118 // FIXME: we don't rely on interning or equality here - better have
3119 // this be a `&'tcx str`.
3120 pub name: InternedString
3123 impl_stable_hash_for!(struct self::SymbolName {
3128 pub fn new(name: &str) -> SymbolName {
3130 name: Symbol::intern(name).as_interned_str()
3134 pub fn as_str(&self) -> LocalInternedString {
3139 impl fmt::Display for SymbolName {
3140 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3141 fmt::Display::fmt(&self.name, fmt)
3145 impl fmt::Debug for SymbolName {
3146 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3147 fmt::Display::fmt(&self.name, fmt)