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};
18 use hir::def::{Def, CtorKind, ExportMap};
19 use hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
20 use hir::map::DefPathData;
23 use ich::StableHashingContext;
24 use infer::canonical::Canonical;
25 use middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem, FnOnceTraitLangItem};
26 use middle::privacy::AccessLevels;
27 use middle::resolve_lifetime::ObjectLifetimeDefault;
29 use mir::interpret::GlobalId;
30 use mir::GeneratorLayout;
31 use session::CrateDisambiguator;
32 use traits::{self, Reveal};
34 use ty::subst::{Subst, Substs};
35 use ty::util::{IntTypeExt, Discr};
36 use ty::walk::TypeWalker;
37 use util::captures::Captures;
38 use util::nodemap::{NodeSet, DefIdMap, FxHashMap};
39 use arena::SyncDroplessArena;
41 use serialize::{self, Encodable, Encoder};
42 use std::cell::RefCell;
43 use std::cmp::{self, Ordering};
45 use std::hash::{Hash, Hasher};
47 use rustc_data_structures::sync::{self, Lrc, ParallelIterator, par_iter};
49 use std::vec::IntoIter;
51 use syntax::ast::{self, DUMMY_NODE_ID, Name, Ident, NodeId};
53 use syntax::ext::hygiene::Mark;
54 use syntax::symbol::{Symbol, LocalInternedString, InternedString};
55 use syntax_pos::{DUMMY_SP, Span};
57 use rustc_data_structures::accumulate_vec::IntoIter as AccIntoIter;
58 use rustc_data_structures::stable_hasher::{StableHasher, StableHasherResult,
63 pub use self::sty::{Binder, CanonicalVar, DebruijnIndex, INNERMOST};
64 pub use self::sty::{FnSig, GenSig, PolyFnSig, PolyGenSig};
65 pub use self::sty::{InferTy, ParamTy, ProjectionTy, ExistentialPredicate};
66 pub use self::sty::{ClosureSubsts, GeneratorSubsts, UpvarSubsts, TypeAndMut};
67 pub use self::sty::{TraitRef, TypeVariants, PolyTraitRef};
68 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
69 pub use self::sty::{ExistentialProjection, PolyExistentialProjection, Const};
70 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
71 pub use self::sty::RegionKind;
72 pub use self::sty::{TyVid, IntVid, FloatVid, RegionVid};
73 pub use self::sty::BoundRegion::*;
74 pub use self::sty::InferTy::*;
75 pub use self::sty::RegionKind::*;
76 pub use self::sty::TypeVariants::*;
78 pub use self::binding::BindingMode;
79 pub use self::binding::BindingMode::*;
81 pub use self::context::{TyCtxt, GlobalArenas, AllArenas, tls, keep_local};
82 pub use self::context::{Lift, TypeckTables};
84 pub use self::instance::{Instance, InstanceDef};
86 pub use self::trait_def::TraitDef;
88 pub use self::query::queries;
99 pub mod inhabitedness;
116 mod structural_impls;
121 /// The complete set of all analyses described in this module. This is
122 /// produced by the driver and fed to codegen and later passes.
124 /// NB: These contents are being migrated into queries using the
125 /// *on-demand* infrastructure.
127 pub struct CrateAnalysis {
128 pub access_levels: Lrc<AccessLevels>,
130 pub glob_map: Option<hir::GlobMap>,
134 pub struct Resolutions {
135 pub freevars: FreevarMap,
136 pub trait_map: TraitMap,
137 pub maybe_unused_trait_imports: NodeSet,
138 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
139 pub export_map: ExportMap,
142 #[derive(Clone, Copy, PartialEq, Eq, Debug)]
143 pub enum AssociatedItemContainer {
144 TraitContainer(DefId),
145 ImplContainer(DefId),
148 impl AssociatedItemContainer {
149 /// Asserts that this is the def-id of an associated item declared
150 /// in a trait, and returns the trait def-id.
151 pub fn assert_trait(&self) -> DefId {
153 TraitContainer(id) => id,
154 _ => bug!("associated item has wrong container type: {:?}", self)
158 pub fn id(&self) -> DefId {
160 TraitContainer(id) => id,
161 ImplContainer(id) => id,
166 /// The "header" of an impl is everything outside the body: a Self type, a trait
167 /// ref (in the case of a trait impl), and a set of predicates (from the
168 /// bounds/where clauses).
169 #[derive(Clone, PartialEq, Eq, Hash, Debug)]
170 pub struct ImplHeader<'tcx> {
171 pub impl_def_id: DefId,
172 pub self_ty: Ty<'tcx>,
173 pub trait_ref: Option<TraitRef<'tcx>>,
174 pub predicates: Vec<Predicate<'tcx>>,
177 #[derive(Copy, Clone, Debug, PartialEq, Eq)]
178 pub struct AssociatedItem {
181 pub kind: AssociatedKind,
183 pub defaultness: hir::Defaultness,
184 pub container: AssociatedItemContainer,
186 /// Whether this is a method with an explicit self
187 /// as its first argument, allowing method calls.
188 pub method_has_self_argument: bool,
191 #[derive(Copy, Clone, PartialEq, Eq, Debug, Hash, RustcEncodable, RustcDecodable)]
192 pub enum AssociatedKind {
198 impl AssociatedItem {
199 pub fn def(&self) -> Def {
201 AssociatedKind::Const => Def::AssociatedConst(self.def_id),
202 AssociatedKind::Method => Def::Method(self.def_id),
203 AssociatedKind::Type => Def::AssociatedTy(self.def_id),
207 /// Tests whether the associated item admits a non-trivial implementation
209 pub fn relevant_for_never<'tcx>(&self) -> bool {
211 AssociatedKind::Const => true,
212 AssociatedKind::Type => true,
213 // FIXME(canndrew): Be more thorough here, check if any argument is uninhabited.
214 AssociatedKind::Method => !self.method_has_self_argument,
218 pub fn signature<'a, 'tcx>(&self, tcx: &TyCtxt<'a, 'tcx, 'tcx>) -> String {
220 ty::AssociatedKind::Method => {
221 // We skip the binder here because the binder would deanonymize all
222 // late-bound regions, and we don't want method signatures to show up
223 // `as for<'r> fn(&'r MyType)`. Pretty-printing handles late-bound
224 // regions just fine, showing `fn(&MyType)`.
225 format!("{}", tcx.fn_sig(self.def_id).skip_binder())
227 ty::AssociatedKind::Type => format!("type {};", self.ident),
228 ty::AssociatedKind::Const => {
229 format!("const {}: {:?};", self.ident, tcx.type_of(self.def_id))
235 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable)]
236 pub enum Visibility {
237 /// Visible everywhere (including in other crates).
239 /// Visible only in the given crate-local module.
241 /// Not visible anywhere in the local crate. This is the visibility of private external items.
245 pub trait DefIdTree: Copy {
246 fn parent(self, id: DefId) -> Option<DefId>;
248 fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
249 if descendant.krate != ancestor.krate {
253 while descendant != ancestor {
254 match self.parent(descendant) {
255 Some(parent) => descendant = parent,
256 None => return false,
263 impl<'a, 'gcx, 'tcx> DefIdTree for TyCtxt<'a, 'gcx, 'tcx> {
264 fn parent(self, id: DefId) -> Option<DefId> {
265 self.def_key(id).parent.map(|index| DefId { index: index, ..id })
270 pub fn from_hir(visibility: &hir::Visibility, id: NodeId, tcx: TyCtxt) -> Self {
272 hir::Public => Visibility::Public,
273 hir::Visibility::Crate(_) => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
274 hir::Visibility::Restricted { ref path, .. } => match path.def {
275 // If there is no resolution, `resolve` will have already reported an error, so
276 // assume that the visibility is public to avoid reporting more privacy errors.
277 Def::Err => Visibility::Public,
278 def => Visibility::Restricted(def.def_id()),
281 Visibility::Restricted(tcx.hir.get_module_parent(id))
286 /// Returns true if an item with this visibility is accessible from the given block.
287 pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
288 let restriction = match self {
289 // Public items are visible everywhere.
290 Visibility::Public => return true,
291 // Private items from other crates are visible nowhere.
292 Visibility::Invisible => return false,
293 // Restricted items are visible in an arbitrary local module.
294 Visibility::Restricted(other) if other.krate != module.krate => return false,
295 Visibility::Restricted(module) => module,
298 tree.is_descendant_of(module, restriction)
301 /// Returns true if this visibility is at least as accessible as the given visibility
302 pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
303 let vis_restriction = match vis {
304 Visibility::Public => return self == Visibility::Public,
305 Visibility::Invisible => return true,
306 Visibility::Restricted(module) => module,
309 self.is_accessible_from(vis_restriction, tree)
312 // Returns true if this item is visible anywhere in the local crate.
313 pub fn is_visible_locally(self) -> bool {
315 Visibility::Public => true,
316 Visibility::Restricted(def_id) => def_id.is_local(),
317 Visibility::Invisible => false,
322 #[derive(Clone, PartialEq, RustcDecodable, RustcEncodable, Copy)]
324 Covariant, // T<A> <: T<B> iff A <: B -- e.g., function return type
325 Invariant, // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
326 Contravariant, // T<A> <: T<B> iff B <: A -- e.g., function param type
327 Bivariant, // T<A> <: T<B> -- e.g., unused type parameter
330 /// The crate variances map is computed during typeck and contains the
331 /// variance of every item in the local crate. You should not use it
332 /// directly, because to do so will make your pass dependent on the
333 /// HIR of every item in the local crate. Instead, use
334 /// `tcx.variances_of()` to get the variance for a *particular*
336 pub struct CrateVariancesMap {
337 /// For each item with generics, maps to a vector of the variance
338 /// of its generics. If an item has no generics, it will have no
340 pub variances: FxHashMap<DefId, Lrc<Vec<ty::Variance>>>,
342 /// An empty vector, useful for cloning.
343 pub empty_variance: Lrc<Vec<ty::Variance>>,
347 /// `a.xform(b)` combines the variance of a context with the
348 /// variance of a type with the following meaning. If we are in a
349 /// context with variance `a`, and we encounter a type argument in
350 /// a position with variance `b`, then `a.xform(b)` is the new
351 /// variance with which the argument appears.
357 /// Here, the "ambient" variance starts as covariant. `*mut T` is
358 /// invariant with respect to `T`, so the variance in which the
359 /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
360 /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
361 /// respect to its type argument `T`, and hence the variance of
362 /// the `i32` here is `Invariant.xform(Covariant)`, which results
363 /// (again) in `Invariant`.
367 /// fn(*const Vec<i32>, *mut Vec<i32)
369 /// The ambient variance is covariant. A `fn` type is
370 /// contravariant with respect to its parameters, so the variance
371 /// within which both pointer types appear is
372 /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
373 /// T` is covariant with respect to `T`, so the variance within
374 /// which the first `Vec<i32>` appears is
375 /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
376 /// is true for its `i32` argument. In the `*mut T` case, the
377 /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
378 /// and hence the outermost type is `Invariant` with respect to
379 /// `Vec<i32>` (and its `i32` argument).
381 /// Source: Figure 1 of "Taming the Wildcards:
382 /// Combining Definition- and Use-Site Variance" published in PLDI'11.
383 pub fn xform(self, v: ty::Variance) -> ty::Variance {
385 // Figure 1, column 1.
386 (ty::Covariant, ty::Covariant) => ty::Covariant,
387 (ty::Covariant, ty::Contravariant) => ty::Contravariant,
388 (ty::Covariant, ty::Invariant) => ty::Invariant,
389 (ty::Covariant, ty::Bivariant) => ty::Bivariant,
391 // Figure 1, column 2.
392 (ty::Contravariant, ty::Covariant) => ty::Contravariant,
393 (ty::Contravariant, ty::Contravariant) => ty::Covariant,
394 (ty::Contravariant, ty::Invariant) => ty::Invariant,
395 (ty::Contravariant, ty::Bivariant) => ty::Bivariant,
397 // Figure 1, column 3.
398 (ty::Invariant, _) => ty::Invariant,
400 // Figure 1, column 4.
401 (ty::Bivariant, _) => ty::Bivariant,
406 // Contains information needed to resolve types and (in the future) look up
407 // the types of AST nodes.
408 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
409 pub struct CReaderCacheKey {
414 // Flags that we track on types. These flags are propagated upwards
415 // through the type during type construction, so that we can quickly
416 // check whether the type has various kinds of types in it without
417 // recursing over the type itself.
419 pub struct TypeFlags: u32 {
420 const HAS_PARAMS = 1 << 0;
421 const HAS_SELF = 1 << 1;
422 const HAS_TY_INFER = 1 << 2;
423 const HAS_RE_INFER = 1 << 3;
424 const HAS_RE_SKOL = 1 << 4;
426 /// Does this have any `ReEarlyBound` regions? Used to
427 /// determine whether substitition is required, since those
428 /// represent regions that are bound in a `ty::Generics` and
429 /// hence may be substituted.
430 const HAS_RE_EARLY_BOUND = 1 << 5;
432 /// Does this have any region that "appears free" in the type?
433 /// Basically anything but `ReLateBound` and `ReErased`.
434 const HAS_FREE_REGIONS = 1 << 6;
436 /// Is an error type reachable?
437 const HAS_TY_ERR = 1 << 7;
438 const HAS_PROJECTION = 1 << 8;
440 // FIXME: Rename this to the actual property since it's used for generators too
441 const HAS_TY_CLOSURE = 1 << 9;
443 // true if there are "names" of types and regions and so forth
444 // that are local to a particular fn
445 const HAS_FREE_LOCAL_NAMES = 1 << 10;
447 // Present if the type belongs in a local type context.
448 // Only set for TyInfer other than Fresh.
449 const KEEP_IN_LOCAL_TCX = 1 << 11;
451 // Is there a projection that does not involve a bound region?
452 // Currently we can't normalize projections w/ bound regions.
453 const HAS_NORMALIZABLE_PROJECTION = 1 << 12;
455 // Set if this includes a "canonical" type or region var --
456 // ought to be true only for the results of canonicalization.
457 const HAS_CANONICAL_VARS = 1 << 13;
459 /// Does this have any `ReLateBound` regions? Used to check
460 /// if a global bound is safe to evaluate.
461 const HAS_RE_LATE_BOUND = 1 << 14;
463 const NEEDS_SUBST = TypeFlags::HAS_PARAMS.bits |
464 TypeFlags::HAS_SELF.bits |
465 TypeFlags::HAS_RE_EARLY_BOUND.bits;
467 // Flags representing the nominal content of a type,
468 // computed by FlagsComputation. If you add a new nominal
469 // flag, it should be added here too.
470 const NOMINAL_FLAGS = TypeFlags::HAS_PARAMS.bits |
471 TypeFlags::HAS_SELF.bits |
472 TypeFlags::HAS_TY_INFER.bits |
473 TypeFlags::HAS_RE_INFER.bits |
474 TypeFlags::HAS_RE_SKOL.bits |
475 TypeFlags::HAS_RE_EARLY_BOUND.bits |
476 TypeFlags::HAS_FREE_REGIONS.bits |
477 TypeFlags::HAS_TY_ERR.bits |
478 TypeFlags::HAS_PROJECTION.bits |
479 TypeFlags::HAS_TY_CLOSURE.bits |
480 TypeFlags::HAS_FREE_LOCAL_NAMES.bits |
481 TypeFlags::KEEP_IN_LOCAL_TCX.bits |
482 TypeFlags::HAS_CANONICAL_VARS.bits |
483 TypeFlags::HAS_RE_LATE_BOUND.bits;
487 pub struct TyS<'tcx> {
488 pub sty: TypeVariants<'tcx>,
489 pub flags: TypeFlags,
491 /// This is a kind of confusing thing: it stores the smallest
494 /// (a) the binder itself captures nothing but
495 /// (b) all the late-bound things within the type are captured
496 /// by some sub-binder.
498 /// So, for a type without any late-bound things, like `u32`, this
499 /// will be INNERMOST, because that is the innermost binder that
500 /// captures nothing. But for a type `&'D u32`, where `'D` is a
501 /// late-bound region with debruijn index D, this would be D+1 --
502 /// the binder itself does not capture D, but D is captured by an
505 /// We call this concept an "exclusive" binder D (because all
506 /// debruijn indices within the type are contained within `0..D`
508 outer_exclusive_binder: ty::DebruijnIndex,
511 impl<'tcx> Ord for TyS<'tcx> {
512 fn cmp(&self, other: &TyS<'tcx>) -> Ordering {
513 self.sty.cmp(&other.sty)
517 impl<'tcx> PartialOrd for TyS<'tcx> {
518 fn partial_cmp(&self, other: &TyS<'tcx>) -> Option<Ordering> {
519 Some(self.sty.cmp(&other.sty))
523 impl<'tcx> PartialEq for TyS<'tcx> {
525 fn eq(&self, other: &TyS<'tcx>) -> bool {
526 // (self as *const _) == (other as *const _)
527 (self as *const TyS<'tcx>) == (other as *const TyS<'tcx>)
530 impl<'tcx> Eq for TyS<'tcx> {}
532 impl<'tcx> Hash for TyS<'tcx> {
533 fn hash<H: Hasher>(&self, s: &mut H) {
534 (self as *const TyS).hash(s)
538 impl<'tcx> TyS<'tcx> {
539 pub fn is_primitive_ty(&self) -> bool {
541 TypeVariants::TyBool |
542 TypeVariants::TyChar |
543 TypeVariants::TyInt(_) |
544 TypeVariants::TyUint(_) |
545 TypeVariants::TyFloat(_) |
546 TypeVariants::TyInfer(InferTy::IntVar(_)) |
547 TypeVariants::TyInfer(InferTy::FloatVar(_)) |
548 TypeVariants::TyInfer(InferTy::FreshIntTy(_)) |
549 TypeVariants::TyInfer(InferTy::FreshFloatTy(_)) => true,
550 TypeVariants::TyRef(_, x, _) => x.is_primitive_ty(),
555 pub fn is_suggestable(&self) -> bool {
557 TypeVariants::TyAnon(..) |
558 TypeVariants::TyFnDef(..) |
559 TypeVariants::TyFnPtr(..) |
560 TypeVariants::TyDynamic(..) |
561 TypeVariants::TyClosure(..) |
562 TypeVariants::TyInfer(..) |
563 TypeVariants::TyProjection(..) => false,
569 impl<'a, 'gcx> HashStable<StableHashingContext<'a>> for ty::TyS<'gcx> {
570 fn hash_stable<W: StableHasherResult>(&self,
571 hcx: &mut StableHashingContext<'a>,
572 hasher: &mut StableHasher<W>) {
576 // The other fields just provide fast access to information that is
577 // also contained in `sty`, so no need to hash them.
580 outer_exclusive_binder: _,
583 sty.hash_stable(hcx, hasher);
587 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
589 impl<'tcx> serialize::UseSpecializedEncodable for Ty<'tcx> {}
590 impl<'tcx> serialize::UseSpecializedDecodable for Ty<'tcx> {}
592 pub type CanonicalTy<'gcx> = Canonical<'gcx, Ty<'gcx>>;
595 /// A dummy type used to force Slice to by unsized without requiring fat pointers
596 type OpaqueSliceContents;
599 /// A wrapper for slices with the additional invariant
600 /// that the slice is interned and no other slice with
601 /// the same contents can exist in the same context.
602 /// This means we can use pointer for both
603 /// equality comparisons and hashing.
605 pub struct Slice<T> {
608 opaque: OpaqueSliceContents,
611 unsafe impl<T: Sync> Sync for Slice<T> {}
613 impl<T: Copy> Slice<T> {
615 fn from_arena<'tcx>(arena: &'tcx SyncDroplessArena, slice: &[T]) -> &'tcx Slice<T> {
616 assert!(!mem::needs_drop::<T>());
617 assert!(mem::size_of::<T>() != 0);
618 assert!(slice.len() != 0);
620 // Align up the size of the len (usize) field
621 let align = mem::align_of::<T>();
622 let align_mask = align - 1;
623 let offset = mem::size_of::<usize>();
624 let offset = (offset + align_mask) & !align_mask;
626 let size = offset + slice.len() * mem::size_of::<T>();
628 let mem = arena.alloc_raw(
630 cmp::max(mem::align_of::<T>(), mem::align_of::<usize>()));
632 let result = &mut *(mem.as_mut_ptr() as *mut Slice<T>);
634 result.len = slice.len();
636 // Write the elements
637 let arena_slice = slice::from_raw_parts_mut(result.data.as_mut_ptr(), result.len);
638 arena_slice.copy_from_slice(slice);
645 impl<T: fmt::Debug> fmt::Debug for Slice<T> {
646 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
651 impl<T: Encodable> Encodable for Slice<T> {
653 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
658 impl<T> Ord for Slice<T> where T: Ord {
659 fn cmp(&self, other: &Slice<T>) -> Ordering {
660 if self == other { Ordering::Equal } else {
661 <[T] as Ord>::cmp(&**self, &**other)
666 impl<T> PartialOrd for Slice<T> where T: PartialOrd {
667 fn partial_cmp(&self, other: &Slice<T>) -> Option<Ordering> {
668 if self == other { Some(Ordering::Equal) } else {
669 <[T] as PartialOrd>::partial_cmp(&**self, &**other)
674 impl<T: PartialEq> PartialEq for Slice<T> {
676 fn eq(&self, other: &Slice<T>) -> bool {
677 (self as *const _) == (other as *const _)
680 impl<T: Eq> Eq for Slice<T> {}
682 impl<T> Hash for Slice<T> {
684 fn hash<H: Hasher>(&self, s: &mut H) {
685 (self as *const Slice<T>).hash(s)
689 impl<T> Deref for Slice<T> {
692 fn deref(&self) -> &[T] {
694 slice::from_raw_parts(self.data.as_ptr(), self.len)
699 impl<'a, T> IntoIterator for &'a Slice<T> {
701 type IntoIter = <&'a [T] as IntoIterator>::IntoIter;
703 fn into_iter(self) -> Self::IntoIter {
708 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx Slice<Ty<'tcx>> {}
712 pub fn empty<'a>() -> &'a Slice<T> {
713 #[repr(align(64), C)]
714 struct EmptySlice([u8; 64]);
715 static EMPTY_SLICE: EmptySlice = EmptySlice([0; 64]);
716 assert!(mem::align_of::<T>() <= 64);
718 &*(&EMPTY_SLICE as *const _ as *const Slice<T>)
723 /// Upvars do not get their own node-id. Instead, we use the pair of
724 /// the original var id (that is, the root variable that is referenced
725 /// by the upvar) and the id of the closure expression.
726 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
728 pub var_id: hir::HirId,
729 pub closure_expr_id: LocalDefId,
732 #[derive(Clone, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable, Copy)]
733 pub enum BorrowKind {
734 /// Data must be immutable and is aliasable.
737 /// Data must be immutable but not aliasable. This kind of borrow
738 /// cannot currently be expressed by the user and is used only in
739 /// implicit closure bindings. It is needed when the closure
740 /// is borrowing or mutating a mutable referent, e.g.:
742 /// let x: &mut isize = ...;
743 /// let y = || *x += 5;
745 /// If we were to try to translate this closure into a more explicit
746 /// form, we'd encounter an error with the code as written:
748 /// struct Env { x: & &mut isize }
749 /// let x: &mut isize = ...;
750 /// let y = (&mut Env { &x }, fn_ptr); // Closure is pair of env and fn
751 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
753 /// This is then illegal because you cannot mutate a `&mut` found
754 /// in an aliasable location. To solve, you'd have to translate with
755 /// an `&mut` borrow:
757 /// struct Env { x: & &mut isize }
758 /// let x: &mut isize = ...;
759 /// let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
760 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
762 /// Now the assignment to `**env.x` is legal, but creating a
763 /// mutable pointer to `x` is not because `x` is not mutable. We
764 /// could fix this by declaring `x` as `let mut x`. This is ok in
765 /// user code, if awkward, but extra weird for closures, since the
766 /// borrow is hidden.
768 /// So we introduce a "unique imm" borrow -- the referent is
769 /// immutable, but not aliasable. This solves the problem. For
770 /// simplicity, we don't give users the way to express this
771 /// borrow, it's just used when translating closures.
774 /// Data is mutable and not aliasable.
778 /// Information describing the capture of an upvar. This is computed
779 /// during `typeck`, specifically by `regionck`.
780 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable)]
781 pub enum UpvarCapture<'tcx> {
782 /// Upvar is captured by value. This is always true when the
783 /// closure is labeled `move`, but can also be true in other cases
784 /// depending on inference.
787 /// Upvar is captured by reference.
788 ByRef(UpvarBorrow<'tcx>),
791 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable)]
792 pub struct UpvarBorrow<'tcx> {
793 /// The kind of borrow: by-ref upvars have access to shared
794 /// immutable borrows, which are not part of the normal language
796 pub kind: BorrowKind,
798 /// Region of the resulting reference.
799 pub region: ty::Region<'tcx>,
802 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
804 #[derive(Copy, Clone)]
805 pub struct ClosureUpvar<'tcx> {
811 #[derive(Clone, Copy, PartialEq, Eq)]
812 pub enum IntVarValue {
814 UintType(ast::UintTy),
817 #[derive(Clone, Copy, PartialEq, Eq)]
818 pub struct FloatVarValue(pub ast::FloatTy);
820 impl ty::EarlyBoundRegion {
821 pub fn to_bound_region(&self) -> ty::BoundRegion {
822 ty::BoundRegion::BrNamed(self.def_id, self.name)
826 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
827 pub enum GenericParamDefKind {
831 object_lifetime_default: ObjectLifetimeDefault,
832 synthetic: Option<hir::SyntheticTyParamKind>,
836 #[derive(Clone, RustcEncodable, RustcDecodable)]
837 pub struct GenericParamDef {
838 pub name: InternedString,
842 /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
843 /// on generic parameter `'a`/`T`, asserts data behind the parameter
844 /// `'a`/`T` won't be accessed during the parent type's `Drop` impl.
845 pub pure_wrt_drop: bool,
847 pub kind: GenericParamDefKind,
850 impl GenericParamDef {
851 pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
853 GenericParamDefKind::Lifetime => {
854 ty::EarlyBoundRegion {
860 _ => bug!("cannot convert a non-lifetime parameter def to an early bound region")
864 pub fn to_bound_region(&self) -> ty::BoundRegion {
866 GenericParamDefKind::Lifetime => {
867 self.to_early_bound_region_data().to_bound_region()
869 _ => bug!("cannot convert a non-lifetime parameter def to an early bound region")
874 pub struct GenericParamCount {
875 pub lifetimes: usize,
879 /// Information about the formal type/lifetime parameters associated
880 /// with an item or method. Analogous to hir::Generics.
882 /// The ordering of parameters is the same as in Subst (excluding child generics):
883 /// Self (optionally), Lifetime params..., Type params...
884 #[derive(Clone, Debug, RustcEncodable, RustcDecodable)]
885 pub struct Generics {
886 pub parent: Option<DefId>,
887 pub parent_count: usize,
888 pub params: Vec<GenericParamDef>,
890 /// Reverse map to the `index` field of each `GenericParamDef`
891 pub param_def_id_to_index: FxHashMap<DefId, u32>,
894 pub has_late_bound_regions: Option<Span>,
897 impl<'a, 'gcx, 'tcx> Generics {
898 pub fn count(&self) -> usize {
899 self.parent_count + self.params.len()
902 pub fn own_counts(&self) -> GenericParamCount {
903 // We could cache this as a property of `GenericParamCount`, but
904 // the aim is to refactor this away entirely eventually and the
905 // presence of this method will be a constant reminder.
906 let mut own_counts = GenericParamCount {
911 for param in &self.params {
913 GenericParamDefKind::Lifetime => own_counts.lifetimes += 1,
914 GenericParamDefKind::Type {..} => own_counts.types += 1,
921 pub fn requires_monomorphization(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
922 for param in &self.params {
924 GenericParamDefKind::Type {..} => return true,
925 GenericParamDefKind::Lifetime => {}
928 if let Some(parent_def_id) = self.parent {
929 let parent = tcx.generics_of(parent_def_id);
930 parent.requires_monomorphization(tcx)
936 pub fn region_param(&'tcx self,
937 param: &EarlyBoundRegion,
938 tcx: TyCtxt<'a, 'gcx, 'tcx>)
939 -> &'tcx GenericParamDef
941 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
942 let param = &self.params[index as usize];
944 ty::GenericParamDefKind::Lifetime => param,
945 _ => bug!("expected lifetime parameter, but found another generic parameter")
948 tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
949 .region_param(param, tcx)
953 /// Returns the `GenericParamDef` associated with this `ParamTy`.
954 pub fn type_param(&'tcx self,
956 tcx: TyCtxt<'a, 'gcx, 'tcx>)
957 -> &'tcx GenericParamDef {
958 if let Some(index) = param.idx.checked_sub(self.parent_count as u32) {
959 let param = &self.params[index as usize];
961 ty::GenericParamDefKind::Type {..} => param,
962 _ => bug!("expected type parameter, but found another generic parameter")
965 tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
966 .type_param(param, tcx)
971 /// Bounds on generics.
972 #[derive(Clone, Default)]
973 pub struct GenericPredicates<'tcx> {
974 pub parent: Option<DefId>,
975 pub predicates: Vec<Predicate<'tcx>>,
978 impl<'tcx> serialize::UseSpecializedEncodable for GenericPredicates<'tcx> {}
979 impl<'tcx> serialize::UseSpecializedDecodable for GenericPredicates<'tcx> {}
981 impl<'a, 'gcx, 'tcx> GenericPredicates<'tcx> {
982 pub fn instantiate(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: &Substs<'tcx>)
983 -> InstantiatedPredicates<'tcx> {
984 let mut instantiated = InstantiatedPredicates::empty();
985 self.instantiate_into(tcx, &mut instantiated, substs);
988 pub fn instantiate_own(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, substs: &Substs<'tcx>)
989 -> InstantiatedPredicates<'tcx> {
990 InstantiatedPredicates {
991 predicates: self.predicates.subst(tcx, substs)
995 fn instantiate_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
996 instantiated: &mut InstantiatedPredicates<'tcx>,
997 substs: &Substs<'tcx>) {
998 if let Some(def_id) = self.parent {
999 tcx.predicates_of(def_id).instantiate_into(tcx, instantiated, substs);
1001 instantiated.predicates.extend(self.predicates.iter().map(|p| p.subst(tcx, substs)))
1004 pub fn instantiate_identity(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>)
1005 -> InstantiatedPredicates<'tcx> {
1006 let mut instantiated = InstantiatedPredicates::empty();
1007 self.instantiate_identity_into(tcx, &mut instantiated);
1011 fn instantiate_identity_into(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1012 instantiated: &mut InstantiatedPredicates<'tcx>) {
1013 if let Some(def_id) = self.parent {
1014 tcx.predicates_of(def_id).instantiate_identity_into(tcx, instantiated);
1016 instantiated.predicates.extend(&self.predicates)
1019 pub fn instantiate_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1020 poly_trait_ref: &ty::PolyTraitRef<'tcx>)
1021 -> InstantiatedPredicates<'tcx>
1023 assert_eq!(self.parent, None);
1024 InstantiatedPredicates {
1025 predicates: self.predicates.iter().map(|pred| {
1026 pred.subst_supertrait(tcx, poly_trait_ref)
1032 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1033 pub enum Predicate<'tcx> {
1034 /// Corresponds to `where Foo : Bar<A,B,C>`. `Foo` here would be
1035 /// the `Self` type of the trait reference and `A`, `B`, and `C`
1036 /// would be the type parameters.
1037 Trait(PolyTraitPredicate<'tcx>),
1040 RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
1043 TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
1045 /// where <T as TraitRef>::Name == X, approximately.
1046 /// See `ProjectionPredicate` struct for details.
1047 Projection(PolyProjectionPredicate<'tcx>),
1050 WellFormed(Ty<'tcx>),
1052 /// trait must be object-safe
1055 /// No direct syntax. May be thought of as `where T : FnFoo<...>`
1056 /// for some substitutions `...` and T being a closure type.
1057 /// Satisfied (or refuted) once we know the closure's kind.
1058 ClosureKind(DefId, ClosureSubsts<'tcx>, ClosureKind),
1061 Subtype(PolySubtypePredicate<'tcx>),
1063 /// Constant initializer must evaluate successfully.
1064 ConstEvaluatable(DefId, &'tcx Substs<'tcx>),
1067 /// The crate outlives map is computed during typeck and contains the
1068 /// outlives of every item in the local crate. You should not use it
1069 /// directly, because to do so will make your pass dependent on the
1070 /// HIR of every item in the local crate. Instead, use
1071 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
1073 pub struct CratePredicatesMap<'tcx> {
1074 /// For each struct with outlive bounds, maps to a vector of the
1075 /// predicate of its outlive bounds. If an item has no outlives
1076 /// bounds, it will have no entry.
1077 pub predicates: FxHashMap<DefId, Lrc<Vec<ty::Predicate<'tcx>>>>,
1079 /// An empty vector, useful for cloning.
1080 pub empty_predicate: Lrc<Vec<ty::Predicate<'tcx>>>,
1083 impl<'tcx> AsRef<Predicate<'tcx>> for Predicate<'tcx> {
1084 fn as_ref(&self) -> &Predicate<'tcx> {
1089 impl<'a, 'gcx, 'tcx> Predicate<'tcx> {
1090 /// Performs a substitution suitable for going from a
1091 /// poly-trait-ref to supertraits that must hold if that
1092 /// poly-trait-ref holds. This is slightly different from a normal
1093 /// substitution in terms of what happens with bound regions. See
1094 /// lengthy comment below for details.
1095 pub fn subst_supertrait(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>,
1096 trait_ref: &ty::PolyTraitRef<'tcx>)
1097 -> ty::Predicate<'tcx>
1099 // The interaction between HRTB and supertraits is not entirely
1100 // obvious. Let me walk you (and myself) through an example.
1102 // Let's start with an easy case. Consider two traits:
1104 // trait Foo<'a> : Bar<'a,'a> { }
1105 // trait Bar<'b,'c> { }
1107 // Now, if we have a trait reference `for<'x> T : Foo<'x>`, then
1108 // we can deduce that `for<'x> T : Bar<'x,'x>`. Basically, if we
1109 // knew that `Foo<'x>` (for any 'x) then we also know that
1110 // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
1111 // normal substitution.
1113 // In terms of why this is sound, the idea is that whenever there
1114 // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
1115 // holds. So if there is an impl of `T:Foo<'a>` that applies to
1116 // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
1119 // Another example to be careful of is this:
1121 // trait Foo1<'a> : for<'b> Bar1<'a,'b> { }
1122 // trait Bar1<'b,'c> { }
1124 // Here, if we have `for<'x> T : Foo1<'x>`, then what do we know?
1125 // The answer is that we know `for<'x,'b> T : Bar1<'x,'b>`. The
1126 // reason is similar to the previous example: any impl of
1127 // `T:Foo1<'x>` must show that `for<'b> T : Bar1<'x, 'b>`. So
1128 // basically we would want to collapse the bound lifetimes from
1129 // the input (`trait_ref`) and the supertraits.
1131 // To achieve this in practice is fairly straightforward. Let's
1132 // consider the more complicated scenario:
1134 // - We start out with `for<'x> T : Foo1<'x>`. In this case, `'x`
1135 // has a De Bruijn index of 1. We want to produce `for<'x,'b> T : Bar1<'x,'b>`,
1136 // where both `'x` and `'b` would have a DB index of 1.
1137 // The substitution from the input trait-ref is therefore going to be
1138 // `'a => 'x` (where `'x` has a DB index of 1).
1139 // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
1140 // early-bound parameter and `'b' is a late-bound parameter with a
1142 // - If we replace `'a` with `'x` from the input, it too will have
1143 // a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
1144 // just as we wanted.
1146 // There is only one catch. If we just apply the substitution `'a
1147 // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
1148 // adjust the DB index because we substituting into a binder (it
1149 // tries to be so smart...) resulting in `for<'x> for<'b>
1150 // Bar1<'x,'b>` (we have no syntax for this, so use your
1151 // imagination). Basically the 'x will have DB index of 2 and 'b
1152 // will have DB index of 1. Not quite what we want. So we apply
1153 // the substitution to the *contents* of the trait reference,
1154 // rather than the trait reference itself (put another way, the
1155 // substitution code expects equal binding levels in the values
1156 // from the substitution and the value being substituted into, and
1157 // this trick achieves that).
1159 let substs = &trait_ref.skip_binder().substs;
1161 Predicate::Trait(ref binder) =>
1162 Predicate::Trait(binder.map_bound(|data| data.subst(tcx, substs))),
1163 Predicate::Subtype(ref binder) =>
1164 Predicate::Subtype(binder.map_bound(|data| data.subst(tcx, substs))),
1165 Predicate::RegionOutlives(ref binder) =>
1166 Predicate::RegionOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1167 Predicate::TypeOutlives(ref binder) =>
1168 Predicate::TypeOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1169 Predicate::Projection(ref binder) =>
1170 Predicate::Projection(binder.map_bound(|data| data.subst(tcx, substs))),
1171 Predicate::WellFormed(data) =>
1172 Predicate::WellFormed(data.subst(tcx, substs)),
1173 Predicate::ObjectSafe(trait_def_id) =>
1174 Predicate::ObjectSafe(trait_def_id),
1175 Predicate::ClosureKind(closure_def_id, closure_substs, kind) =>
1176 Predicate::ClosureKind(closure_def_id, closure_substs.subst(tcx, substs), kind),
1177 Predicate::ConstEvaluatable(def_id, const_substs) =>
1178 Predicate::ConstEvaluatable(def_id, const_substs.subst(tcx, substs)),
1183 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1184 pub struct TraitPredicate<'tcx> {
1185 pub trait_ref: TraitRef<'tcx>
1187 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
1189 impl<'tcx> TraitPredicate<'tcx> {
1190 pub fn def_id(&self) -> DefId {
1191 self.trait_ref.def_id
1194 pub fn input_types<'a>(&'a self) -> impl DoubleEndedIterator<Item=Ty<'tcx>> + 'a {
1195 self.trait_ref.input_types()
1198 pub fn self_ty(&self) -> Ty<'tcx> {
1199 self.trait_ref.self_ty()
1203 impl<'tcx> PolyTraitPredicate<'tcx> {
1204 pub fn def_id(&self) -> DefId {
1205 // ok to skip binder since trait def-id does not care about regions
1206 self.skip_binder().def_id()
1210 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, RustcEncodable, RustcDecodable)]
1211 pub struct OutlivesPredicate<A,B>(pub A, pub B); // `A : B`
1212 pub type PolyOutlivesPredicate<A,B> = ty::Binder<OutlivesPredicate<A,B>>;
1213 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>,
1215 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>,
1217 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<RegionOutlivesPredicate<'tcx>>;
1218 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<TypeOutlivesPredicate<'tcx>>;
1220 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
1221 pub struct SubtypePredicate<'tcx> {
1222 pub a_is_expected: bool,
1226 pub type PolySubtypePredicate<'tcx> = ty::Binder<SubtypePredicate<'tcx>>;
1228 /// This kind of predicate has no *direct* correspondent in the
1229 /// syntax, but it roughly corresponds to the syntactic forms:
1231 /// 1. `T : TraitRef<..., Item=Type>`
1232 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
1234 /// In particular, form #1 is "desugared" to the combination of a
1235 /// normal trait predicate (`T : TraitRef<...>`) and one of these
1236 /// predicates. Form #2 is a broader form in that it also permits
1237 /// equality between arbitrary types. Processing an instance of
1238 /// Form #2 eventually yields one of these `ProjectionPredicate`
1239 /// instances to normalize the LHS.
1240 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1241 pub struct ProjectionPredicate<'tcx> {
1242 pub projection_ty: ProjectionTy<'tcx>,
1246 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
1248 impl<'tcx> PolyProjectionPredicate<'tcx> {
1249 /// Returns the def-id of the associated item being projected.
1250 pub fn item_def_id(&self) -> DefId {
1251 self.skip_binder().projection_ty.item_def_id
1254 pub fn to_poly_trait_ref(&self, tcx: TyCtxt) -> PolyTraitRef<'tcx> {
1255 // Note: unlike with TraitRef::to_poly_trait_ref(),
1256 // self.0.trait_ref is permitted to have escaping regions.
1257 // This is because here `self` has a `Binder` and so does our
1258 // return value, so we are preserving the number of binding
1260 self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
1263 pub fn ty(&self) -> Binder<Ty<'tcx>> {
1264 self.map_bound(|predicate| predicate.ty)
1267 /// The DefId of the TraitItem for the associated type.
1269 /// Note that this is not the DefId of the TraitRef containing this
1270 /// associated type, which is in tcx.associated_item(projection_def_id()).container.
1271 pub fn projection_def_id(&self) -> DefId {
1272 // ok to skip binder since trait def-id does not care about regions
1273 self.skip_binder().projection_ty.item_def_id
1277 pub trait ToPolyTraitRef<'tcx> {
1278 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
1281 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
1282 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1283 ty::Binder::dummy(self.clone())
1287 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
1288 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1289 self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
1293 pub trait ToPredicate<'tcx> {
1294 fn to_predicate(&self) -> Predicate<'tcx>;
1297 impl<'tcx> ToPredicate<'tcx> for TraitRef<'tcx> {
1298 fn to_predicate(&self) -> Predicate<'tcx> {
1299 ty::Predicate::Trait(ty::Binder::dummy(ty::TraitPredicate {
1300 trait_ref: self.clone()
1305 impl<'tcx> ToPredicate<'tcx> for PolyTraitRef<'tcx> {
1306 fn to_predicate(&self) -> Predicate<'tcx> {
1307 ty::Predicate::Trait(self.to_poly_trait_predicate())
1311 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1312 fn to_predicate(&self) -> Predicate<'tcx> {
1313 Predicate::RegionOutlives(self.clone())
1317 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1318 fn to_predicate(&self) -> Predicate<'tcx> {
1319 Predicate::TypeOutlives(self.clone())
1323 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1324 fn to_predicate(&self) -> Predicate<'tcx> {
1325 Predicate::Projection(self.clone())
1329 impl<'tcx> Predicate<'tcx> {
1330 /// Iterates over the types in this predicate. Note that in all
1331 /// cases this is skipping over a binder, so late-bound regions
1332 /// with depth 0 are bound by the predicate.
1333 pub fn walk_tys(&self) -> IntoIter<Ty<'tcx>> {
1334 let vec: Vec<_> = match *self {
1335 ty::Predicate::Trait(ref data) => {
1336 data.skip_binder().input_types().collect()
1338 ty::Predicate::Subtype(binder) => {
1339 let SubtypePredicate { a, b, a_is_expected: _ } = binder.skip_binder();
1342 ty::Predicate::TypeOutlives(binder) => {
1343 vec![binder.skip_binder().0]
1345 ty::Predicate::RegionOutlives(..) => {
1348 ty::Predicate::Projection(ref data) => {
1349 let inner = data.skip_binder();
1350 inner.projection_ty.substs.types().chain(Some(inner.ty)).collect()
1352 ty::Predicate::WellFormed(data) => {
1355 ty::Predicate::ObjectSafe(_trait_def_id) => {
1358 ty::Predicate::ClosureKind(_closure_def_id, closure_substs, _kind) => {
1359 closure_substs.substs.types().collect()
1361 ty::Predicate::ConstEvaluatable(_, substs) => {
1362 substs.types().collect()
1366 // The only reason to collect into a vector here is that I was
1367 // too lazy to make the full (somewhat complicated) iterator
1368 // type that would be needed here. But I wanted this fn to
1369 // return an iterator conceptually, rather than a `Vec`, so as
1370 // to be closer to `Ty::walk`.
1374 pub fn to_opt_poly_trait_ref(&self) -> Option<PolyTraitRef<'tcx>> {
1376 Predicate::Trait(ref t) => {
1377 Some(t.to_poly_trait_ref())
1379 Predicate::Projection(..) |
1380 Predicate::Subtype(..) |
1381 Predicate::RegionOutlives(..) |
1382 Predicate::WellFormed(..) |
1383 Predicate::ObjectSafe(..) |
1384 Predicate::ClosureKind(..) |
1385 Predicate::TypeOutlives(..) |
1386 Predicate::ConstEvaluatable(..) => {
1392 pub fn to_opt_type_outlives(&self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1394 Predicate::TypeOutlives(data) => {
1397 Predicate::Trait(..) |
1398 Predicate::Projection(..) |
1399 Predicate::Subtype(..) |
1400 Predicate::RegionOutlives(..) |
1401 Predicate::WellFormed(..) |
1402 Predicate::ObjectSafe(..) |
1403 Predicate::ClosureKind(..) |
1404 Predicate::ConstEvaluatable(..) => {
1411 /// Represents the bounds declared on a particular set of type
1412 /// parameters. Should eventually be generalized into a flag list of
1413 /// where clauses. You can obtain a `InstantiatedPredicates` list from a
1414 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1415 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1416 /// the `GenericPredicates` are expressed in terms of the bound type
1417 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1418 /// represented a set of bounds for some particular instantiation,
1419 /// meaning that the generic parameters have been substituted with
1424 /// struct Foo<T,U:Bar<T>> { ... }
1426 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1427 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1428 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1429 /// [usize:Bar<isize>]]`.
1431 pub struct InstantiatedPredicates<'tcx> {
1432 pub predicates: Vec<Predicate<'tcx>>,
1435 impl<'tcx> InstantiatedPredicates<'tcx> {
1436 pub fn empty() -> InstantiatedPredicates<'tcx> {
1437 InstantiatedPredicates { predicates: vec![] }
1440 pub fn is_empty(&self) -> bool {
1441 self.predicates.is_empty()
1445 /// "Universes" are used during type- and trait-checking in the
1446 /// presence of `for<..>` binders to control what sets of names are
1447 /// visible. Universes are arranged into a tree: the root universe
1448 /// contains names that are always visible. But when you enter into
1449 /// some subuniverse, then it may add names that are only visible
1450 /// within that subtree (but it can still name the names of its
1451 /// ancestor universes).
1453 /// To make this more concrete, consider this program:
1457 /// fn bar<T>(x: T) {
1458 /// let y: for<'a> fn(&'a u8, Foo) = ...;
1462 /// The struct name `Foo` is in the root universe U0. But the type
1463 /// parameter `T`, introduced on `bar`, is in a subuniverse U1 --
1464 /// i.e., within `bar`, we can name both `T` and `Foo`, but outside of
1465 /// `bar`, we cannot name `T`. Then, within the type of `y`, the
1466 /// region `'a` is in a subuniverse U2 of U1, because we can name it
1467 /// inside the fn type but not outside.
1469 /// Universes are related to **skolemization** -- which is a way of
1470 /// doing type- and trait-checking around these "forall" binders (also
1471 /// called **universal quantification**). The idea is that when, in
1472 /// the body of `bar`, we refer to `T` as a type, we aren't referring
1473 /// to any type in particular, but rather a kind of "fresh" type that
1474 /// is distinct from all other types we have actually declared. This
1475 /// is called a **skolemized** type, and we use universes to talk
1476 /// about this. In other words, a type name in universe 0 always
1477 /// corresponds to some "ground" type that the user declared, but a
1478 /// type name in a non-zero universe is a skolemized type -- an
1479 /// idealized representative of "types in general" that we use for
1480 /// checking generic functions.
1481 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, RustcEncodable, RustcDecodable)]
1482 pub struct UniverseIndex(u32);
1484 impl UniverseIndex {
1485 /// The root universe, where things that the user defined are
1487 pub const ROOT: Self = UniverseIndex(0);
1489 /// A "subuniverse" corresponds to being inside a `forall` quantifier.
1490 /// So, for example, suppose we have this type in universe `U`:
1493 /// for<'a> fn(&'a u32)
1496 /// Once we "enter" into this `for<'a>` quantifier, we are in a
1497 /// subuniverse of `U` -- in this new universe, we can name the
1498 /// region `'a`, but that region was not nameable from `U` because
1499 /// it was not in scope there.
1500 pub fn subuniverse(self) -> UniverseIndex {
1501 UniverseIndex(self.0.checked_add(1).unwrap())
1504 pub fn as_u32(&self) -> u32 {
1508 pub fn as_usize(&self) -> usize {
1513 impl From<u32> for UniverseIndex {
1514 fn from(index: u32) -> Self {
1515 UniverseIndex(index)
1519 /// When type checking, we use the `ParamEnv` to track
1520 /// details about the set of where-clauses that are in scope at this
1521 /// particular point.
1522 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
1523 pub struct ParamEnv<'tcx> {
1524 /// Obligations that the caller must satisfy. This is basically
1525 /// the set of bounds on the in-scope type parameters, translated
1526 /// into Obligations, and elaborated and normalized.
1527 pub caller_bounds: &'tcx Slice<ty::Predicate<'tcx>>,
1529 /// Typically, this is `Reveal::UserFacing`, but during codegen we
1530 /// want `Reveal::All` -- note that this is always paired with an
1531 /// empty environment. To get that, use `ParamEnv::reveal()`.
1532 pub reveal: traits::Reveal,
1535 impl<'tcx> ParamEnv<'tcx> {
1536 /// Construct a trait environment suitable for contexts where
1537 /// there are no where clauses in scope. Hidden types (like `impl
1538 /// Trait`) are left hidden, so this is suitable for ordinary
1540 pub fn empty() -> Self {
1541 Self::new(ty::Slice::empty(), Reveal::UserFacing)
1544 /// Construct a trait environment with no where clauses in scope
1545 /// where the values of all `impl Trait` and other hidden types
1546 /// are revealed. This is suitable for monomorphized, post-typeck
1547 /// environments like codegen or doing optimizations.
1549 /// NB. If you want to have predicates in scope, use `ParamEnv::new`,
1550 /// or invoke `param_env.with_reveal_all()`.
1551 pub fn reveal_all() -> Self {
1552 Self::new(ty::Slice::empty(), Reveal::All)
1555 /// Construct a trait environment with the given set of predicates.
1556 pub fn new(caller_bounds: &'tcx ty::Slice<ty::Predicate<'tcx>>,
1559 ty::ParamEnv { caller_bounds, reveal }
1562 /// Returns a new parameter environment with the same clauses, but
1563 /// which "reveals" the true results of projections in all cases
1564 /// (even for associated types that are specializable). This is
1565 /// the desired behavior during codegen and certain other special
1566 /// contexts; normally though we want to use `Reveal::UserFacing`,
1567 /// which is the default.
1568 pub fn with_reveal_all(self) -> Self {
1569 ty::ParamEnv { reveal: Reveal::All, ..self }
1572 /// Returns this same environment but with no caller bounds.
1573 pub fn without_caller_bounds(self) -> Self {
1574 ty::ParamEnv { caller_bounds: ty::Slice::empty(), ..self }
1577 /// Creates a suitable environment in which to perform trait
1578 /// queries on the given value. When type-checking, this is simply
1579 /// the pair of the environment plus value. But when reveal is set to
1580 /// All, then if `value` does not reference any type parameters, we will
1581 /// pair it with the empty environment. This improves caching and is generally
1584 /// NB: We preserve the environment when type-checking because it
1585 /// is possible for the user to have wacky where-clauses like
1586 /// `where Box<u32>: Copy`, which are clearly never
1587 /// satisfiable. We generally want to behave as if they were true,
1588 /// although the surrounding function is never reachable.
1589 pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
1591 Reveal::UserFacing => {
1600 || value.needs_infer()
1601 || value.has_param_types()
1602 || value.has_self_ty()
1610 param_env: self.without_caller_bounds(),
1619 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
1620 pub struct ParamEnvAnd<'tcx, T> {
1621 pub param_env: ParamEnv<'tcx>,
1625 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
1626 pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
1627 (self.param_env, self.value)
1631 impl<'a, 'gcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'gcx, T>
1632 where T: HashStable<StableHashingContext<'a>>
1634 fn hash_stable<W: StableHasherResult>(&self,
1635 hcx: &mut StableHashingContext<'a>,
1636 hasher: &mut StableHasher<W>) {
1642 param_env.hash_stable(hcx, hasher);
1643 value.hash_stable(hcx, hasher);
1647 #[derive(Copy, Clone, Debug)]
1648 pub struct Destructor {
1649 /// The def-id of the destructor method
1654 pub struct AdtFlags: u32 {
1655 const NO_ADT_FLAGS = 0;
1656 const IS_ENUM = 1 << 0;
1657 const IS_PHANTOM_DATA = 1 << 1;
1658 const IS_FUNDAMENTAL = 1 << 2;
1659 const IS_UNION = 1 << 3;
1660 const IS_BOX = 1 << 4;
1661 /// Indicates whether this abstract data type will be expanded on in future (new
1662 /// fields/variants) and as such, whether downstream crates must match exhaustively on the
1663 /// fields/variants of this data type.
1665 /// See RFC 2008 (<https://github.com/rust-lang/rfcs/pull/2008>).
1666 const IS_NON_EXHAUSTIVE = 1 << 5;
1671 pub struct VariantDef {
1672 /// The variant's DefId. If this is a tuple-like struct,
1673 /// this is the DefId of the struct's ctor.
1675 pub name: Name, // struct's name if this is a struct
1676 pub discr: VariantDiscr,
1677 pub fields: Vec<FieldDef>,
1678 pub ctor_kind: CtorKind,
1681 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable)]
1682 pub enum VariantDiscr {
1683 /// Explicit value for this variant, i.e. `X = 123`.
1684 /// The `DefId` corresponds to the embedded constant.
1687 /// The previous variant's discriminant plus one.
1688 /// For efficiency reasons, the distance from the
1689 /// last `Explicit` discriminant is being stored,
1690 /// or `0` for the first variant, if it has none.
1695 pub struct FieldDef {
1698 pub vis: Visibility,
1701 /// The definition of an abstract data type - a struct or enum.
1703 /// These are all interned (by intern_adt_def) into the adt_defs
1707 pub variants: Vec<VariantDef>,
1709 pub repr: ReprOptions,
1712 impl PartialOrd for AdtDef {
1713 fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering> {
1714 Some(self.cmp(&other))
1718 /// There should be only one AdtDef for each `did`, therefore
1719 /// it is fine to implement `Ord` only based on `did`.
1720 impl Ord for AdtDef {
1721 fn cmp(&self, other: &AdtDef) -> Ordering {
1722 self.did.cmp(&other.did)
1726 impl PartialEq for AdtDef {
1727 // AdtDef are always interned and this is part of TyS equality
1729 fn eq(&self, other: &Self) -> bool { self as *const _ == other as *const _ }
1732 impl Eq for AdtDef {}
1734 impl Hash for AdtDef {
1736 fn hash<H: Hasher>(&self, s: &mut H) {
1737 (self as *const AdtDef).hash(s)
1741 impl<'tcx> serialize::UseSpecializedEncodable for &'tcx AdtDef {
1742 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
1747 impl<'tcx> serialize::UseSpecializedDecodable for &'tcx AdtDef {}
1750 impl<'a> HashStable<StableHashingContext<'a>> for AdtDef {
1751 fn hash_stable<W: StableHasherResult>(&self,
1752 hcx: &mut StableHashingContext<'a>,
1753 hasher: &mut StableHasher<W>) {
1755 static CACHE: RefCell<FxHashMap<usize, Fingerprint>> =
1756 RefCell::new(FxHashMap());
1759 let hash: Fingerprint = CACHE.with(|cache| {
1760 let addr = self as *const AdtDef as usize;
1761 *cache.borrow_mut().entry(addr).or_insert_with(|| {
1769 let mut hasher = StableHasher::new();
1770 did.hash_stable(hcx, &mut hasher);
1771 variants.hash_stable(hcx, &mut hasher);
1772 flags.hash_stable(hcx, &mut hasher);
1773 repr.hash_stable(hcx, &mut hasher);
1779 hash.hash_stable(hcx, hasher);
1783 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
1784 pub enum AdtKind { Struct, Union, Enum }
1787 #[derive(RustcEncodable, RustcDecodable, Default)]
1788 pub struct ReprFlags: u8 {
1789 const IS_C = 1 << 0;
1790 const IS_SIMD = 1 << 1;
1791 const IS_TRANSPARENT = 1 << 2;
1792 // Internal only for now. If true, don't reorder fields.
1793 const IS_LINEAR = 1 << 3;
1795 // Any of these flags being set prevent field reordering optimisation.
1796 const IS_UNOPTIMISABLE = ReprFlags::IS_C.bits |
1797 ReprFlags::IS_SIMD.bits |
1798 ReprFlags::IS_LINEAR.bits;
1802 impl_stable_hash_for!(struct ReprFlags {
1808 /// Represents the repr options provided by the user,
1809 #[derive(Copy, Clone, Eq, PartialEq, RustcEncodable, RustcDecodable, Default)]
1810 pub struct ReprOptions {
1811 pub int: Option<attr::IntType>,
1814 pub flags: ReprFlags,
1817 impl_stable_hash_for!(struct ReprOptions {
1825 pub fn new(tcx: TyCtxt, did: DefId) -> ReprOptions {
1826 let mut flags = ReprFlags::empty();
1827 let mut size = None;
1828 let mut max_align = 0;
1829 let mut min_pack = 0;
1830 for attr in tcx.get_attrs(did).iter() {
1831 for r in attr::find_repr_attrs(tcx.sess.diagnostic(), attr) {
1832 flags.insert(match r {
1833 attr::ReprC => ReprFlags::IS_C,
1834 attr::ReprPacked(pack) => {
1835 min_pack = if min_pack > 0 {
1836 cmp::min(pack, min_pack)
1842 attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
1843 attr::ReprSimd => ReprFlags::IS_SIMD,
1844 attr::ReprInt(i) => {
1848 attr::ReprAlign(align) => {
1849 max_align = cmp::max(align, max_align);
1856 // This is here instead of layout because the choice must make it into metadata.
1857 if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.item_path_str(did))) {
1858 flags.insert(ReprFlags::IS_LINEAR);
1860 ReprOptions { int: size, align: max_align, pack: min_pack, flags: flags }
1864 pub fn simd(&self) -> bool { self.flags.contains(ReprFlags::IS_SIMD) }
1866 pub fn c(&self) -> bool { self.flags.contains(ReprFlags::IS_C) }
1868 pub fn packed(&self) -> bool { self.pack > 0 }
1870 pub fn transparent(&self) -> bool { self.flags.contains(ReprFlags::IS_TRANSPARENT) }
1872 pub fn linear(&self) -> bool { self.flags.contains(ReprFlags::IS_LINEAR) }
1874 pub fn discr_type(&self) -> attr::IntType {
1875 self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
1878 /// Returns true if this `#[repr()]` should inhabit "smart enum
1879 /// layout" optimizations, such as representing `Foo<&T>` as a
1881 pub fn inhibit_enum_layout_opt(&self) -> bool {
1882 self.c() || self.int.is_some()
1885 /// Returns true if this `#[repr()]` should inhibit struct field reordering
1886 /// optimizations, such as with repr(C) or repr(packed(1)).
1887 pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
1888 !(self.flags & ReprFlags::IS_UNOPTIMISABLE).is_empty() || (self.pack == 1)
1892 impl<'a, 'gcx, 'tcx> AdtDef {
1896 variants: Vec<VariantDef>,
1897 repr: ReprOptions) -> Self {
1898 let mut flags = AdtFlags::NO_ADT_FLAGS;
1899 let attrs = tcx.get_attrs(did);
1900 if attr::contains_name(&attrs, "fundamental") {
1901 flags = flags | AdtFlags::IS_FUNDAMENTAL;
1903 if Some(did) == tcx.lang_items().phantom_data() {
1904 flags = flags | AdtFlags::IS_PHANTOM_DATA;
1906 if Some(did) == tcx.lang_items().owned_box() {
1907 flags = flags | AdtFlags::IS_BOX;
1909 if tcx.has_attr(did, "non_exhaustive") {
1910 flags = flags | AdtFlags::IS_NON_EXHAUSTIVE;
1913 AdtKind::Enum => flags = flags | AdtFlags::IS_ENUM,
1914 AdtKind::Union => flags = flags | AdtFlags::IS_UNION,
1915 AdtKind::Struct => {}
1926 pub fn is_struct(&self) -> bool {
1927 !self.is_union() && !self.is_enum()
1931 pub fn is_union(&self) -> bool {
1932 self.flags.intersects(AdtFlags::IS_UNION)
1936 pub fn is_enum(&self) -> bool {
1937 self.flags.intersects(AdtFlags::IS_ENUM)
1941 pub fn is_non_exhaustive(&self) -> bool {
1942 self.flags.intersects(AdtFlags::IS_NON_EXHAUSTIVE)
1945 /// Returns the kind of the ADT - Struct or Enum.
1947 pub fn adt_kind(&self) -> AdtKind {
1950 } else if self.is_union() {
1957 pub fn descr(&self) -> &'static str {
1958 match self.adt_kind() {
1959 AdtKind::Struct => "struct",
1960 AdtKind::Union => "union",
1961 AdtKind::Enum => "enum",
1965 pub fn variant_descr(&self) -> &'static str {
1966 match self.adt_kind() {
1967 AdtKind::Struct => "struct",
1968 AdtKind::Union => "union",
1969 AdtKind::Enum => "variant",
1973 /// Returns whether this type is #[fundamental] for the purposes
1974 /// of coherence checking.
1976 pub fn is_fundamental(&self) -> bool {
1977 self.flags.intersects(AdtFlags::IS_FUNDAMENTAL)
1980 /// Returns true if this is PhantomData<T>.
1982 pub fn is_phantom_data(&self) -> bool {
1983 self.flags.intersects(AdtFlags::IS_PHANTOM_DATA)
1986 /// Returns true if this is Box<T>.
1988 pub fn is_box(&self) -> bool {
1989 self.flags.intersects(AdtFlags::IS_BOX)
1992 /// Returns whether this type has a destructor.
1993 pub fn has_dtor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> bool {
1994 self.destructor(tcx).is_some()
1997 /// Asserts this is a struct or union and returns its unique variant.
1998 pub fn non_enum_variant(&self) -> &VariantDef {
1999 assert!(self.is_struct() || self.is_union());
2004 pub fn predicates(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> GenericPredicates<'gcx> {
2005 tcx.predicates_of(self.did)
2008 /// Returns an iterator over all fields contained
2011 pub fn all_fields<'s>(&'s self) -> impl Iterator<Item = &'s FieldDef> {
2012 self.variants.iter().flat_map(|v| v.fields.iter())
2015 pub fn is_payloadfree(&self) -> bool {
2016 !self.variants.is_empty() &&
2017 self.variants.iter().all(|v| v.fields.is_empty())
2020 pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
2023 .find(|v| v.did == vid)
2024 .expect("variant_with_id: unknown variant")
2027 pub fn variant_index_with_id(&self, vid: DefId) -> usize {
2030 .position(|v| v.did == vid)
2031 .expect("variant_index_with_id: unknown variant")
2034 pub fn variant_of_def(&self, def: Def) -> &VariantDef {
2036 Def::Variant(vid) | Def::VariantCtor(vid, ..) => self.variant_with_id(vid),
2037 Def::Struct(..) | Def::StructCtor(..) | Def::Union(..) |
2038 Def::TyAlias(..) | Def::AssociatedTy(..) | Def::SelfTy(..) => self.non_enum_variant(),
2039 _ => bug!("unexpected def {:?} in variant_of_def", def)
2044 pub fn eval_explicit_discr(
2046 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2048 ) -> Option<Discr<'tcx>> {
2049 let param_env = ParamEnv::empty();
2050 let repr_type = self.repr.discr_type();
2051 let substs = Substs::identity_for_item(tcx.global_tcx(), expr_did);
2052 let instance = ty::Instance::new(expr_did, substs);
2053 let cid = GlobalId {
2057 match tcx.const_eval(param_env.and(cid)) {
2059 // FIXME: Find the right type and use it instead of `val.ty` here
2060 if let Some(b) = val.assert_bits(tcx.global_tcx(), param_env.and(val.ty)) {
2061 trace!("discriminants: {} ({:?})", b, repr_type);
2067 info!("invalid enum discriminant: {:#?}", val);
2068 ::mir::interpret::struct_error(
2069 tcx.at(tcx.def_span(expr_did)),
2070 "constant evaluation of enum discriminant resulted in non-integer",
2076 err.report_as_error(
2077 tcx.at(tcx.def_span(expr_did)),
2078 "could not evaluate enum discriminant",
2080 if !expr_did.is_local() {
2081 span_bug!(tcx.def_span(expr_did),
2082 "variant discriminant evaluation succeeded \
2083 in its crate but failed locally");
2091 pub fn discriminants(
2093 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2094 ) -> impl Iterator<Item=Discr<'tcx>> + Captures<'gcx> + 'a {
2095 let repr_type = self.repr.discr_type();
2096 let initial = repr_type.initial_discriminant(tcx.global_tcx());
2097 let mut prev_discr = None::<Discr<'tcx>>;
2098 self.variants.iter().map(move |v| {
2099 let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
2100 if let VariantDiscr::Explicit(expr_did) = v.discr {
2101 if let Some(new_discr) = self.eval_explicit_discr(tcx, expr_did) {
2105 prev_discr = Some(discr);
2111 /// Compute the discriminant value used by a specific variant.
2112 /// Unlike `discriminants`, this is (amortized) constant-time,
2113 /// only doing at most one query for evaluating an explicit
2114 /// discriminant (the last one before the requested variant),
2115 /// assuming there are no constant-evaluation errors there.
2116 pub fn discriminant_for_variant(&self,
2117 tcx: TyCtxt<'a, 'gcx, 'tcx>,
2118 variant_index: usize)
2120 let (val, offset) = self.discriminant_def_for_variant(variant_index);
2121 let explicit_value = val
2122 .and_then(|expr_did| self.eval_explicit_discr(tcx, expr_did))
2123 .unwrap_or_else(|| self.repr.discr_type().initial_discriminant(tcx.global_tcx()));
2124 explicit_value.checked_add(tcx, offset as u128).0
2127 /// Yields a DefId for the discriminant and an offset to add to it
2128 /// Alternatively, if there is no explicit discriminant, returns the
2129 /// inferred discriminant directly
2130 pub fn discriminant_def_for_variant(
2132 variant_index: usize,
2133 ) -> (Option<DefId>, usize) {
2134 let mut explicit_index = variant_index;
2137 match self.variants[explicit_index].discr {
2138 ty::VariantDiscr::Relative(0) => {
2142 ty::VariantDiscr::Relative(distance) => {
2143 explicit_index -= distance;
2145 ty::VariantDiscr::Explicit(did) => {
2146 expr_did = Some(did);
2151 (expr_did, variant_index - explicit_index)
2154 pub fn destructor(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> Option<Destructor> {
2155 tcx.adt_destructor(self.did)
2158 /// Returns a list of types such that `Self: Sized` if and only
2159 /// if that type is Sized, or `TyErr` if this type is recursive.
2161 /// Oddly enough, checking that the sized-constraint is Sized is
2162 /// actually more expressive than checking all members:
2163 /// the Sized trait is inductive, so an associated type that references
2164 /// Self would prevent its containing ADT from being Sized.
2166 /// Due to normalization being eager, this applies even if
2167 /// the associated type is behind a pointer, e.g. issue #31299.
2168 pub fn sized_constraint(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>) -> &'tcx [Ty<'tcx>] {
2169 match tcx.try_adt_sized_constraint(DUMMY_SP, self.did) {
2172 debug!("adt_sized_constraint: {:?} is recursive", self);
2173 // This should be reported as an error by `check_representable`.
2175 // Consider the type as Sized in the meanwhile to avoid
2176 // further errors. Delay our `bug` diagnostic here to get
2177 // emitted later as well in case we accidentally otherwise don't
2180 tcx.intern_type_list(&[tcx.types.err])
2185 fn sized_constraint_for_ty(&self,
2186 tcx: TyCtxt<'a, 'tcx, 'tcx>,
2189 let result = match ty.sty {
2190 TyBool | TyChar | TyInt(..) | TyUint(..) | TyFloat(..) |
2191 TyRawPtr(..) | TyRef(..) | TyFnDef(..) | TyFnPtr(_) |
2192 TyArray(..) | TyClosure(..) | TyGenerator(..) | TyNever => {
2201 TyGeneratorWitness(..) => {
2202 // these are never sized - return the target type
2206 TyTuple(ref tys) => {
2209 Some(ty) => self.sized_constraint_for_ty(tcx, ty)
2213 TyAdt(adt, substs) => {
2215 let adt_tys = adt.sized_constraint(tcx);
2216 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}",
2219 .map(|ty| ty.subst(tcx, substs))
2220 .flat_map(|ty| self.sized_constraint_for_ty(tcx, ty))
2224 TyProjection(..) | TyAnon(..) => {
2225 // must calculate explicitly.
2226 // FIXME: consider special-casing always-Sized projections
2231 // perf hack: if there is a `T: Sized` bound, then
2232 // we know that `T` is Sized and do not need to check
2235 let sized_trait = match tcx.lang_items().sized_trait() {
2237 _ => return vec![ty]
2239 let sized_predicate = Binder::dummy(TraitRef {
2240 def_id: sized_trait,
2241 substs: tcx.mk_substs_trait(ty, &[])
2243 let predicates = tcx.predicates_of(self.did).predicates;
2244 if predicates.into_iter().any(|p| p == sized_predicate) {
2252 bug!("unexpected type `{:?}` in sized_constraint_for_ty",
2256 debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
2261 impl<'a, 'gcx, 'tcx> FieldDef {
2262 pub fn ty(&self, tcx: TyCtxt<'a, 'gcx, 'tcx>, subst: &Substs<'tcx>) -> Ty<'tcx> {
2263 tcx.type_of(self.did).subst(tcx, subst)
2267 /// Represents the various closure traits in the Rust language. This
2268 /// will determine the type of the environment (`self`, in the
2269 /// desuaring) argument that the closure expects.
2271 /// You can get the environment type of a closure using
2272 /// `tcx.closure_env_ty()`.
2273 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
2274 pub enum ClosureKind {
2275 // Warning: Ordering is significant here! The ordering is chosen
2276 // because the trait Fn is a subtrait of FnMut and so in turn, and
2277 // hence we order it so that Fn < FnMut < FnOnce.
2283 impl<'a, 'tcx> ClosureKind {
2284 // This is the initial value used when doing upvar inference.
2285 pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn;
2287 pub fn trait_did(&self, tcx: TyCtxt<'a, 'tcx, 'tcx>) -> DefId {
2289 ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem),
2290 ClosureKind::FnMut => {
2291 tcx.require_lang_item(FnMutTraitLangItem)
2293 ClosureKind::FnOnce => {
2294 tcx.require_lang_item(FnOnceTraitLangItem)
2299 /// True if this a type that impls this closure kind
2300 /// must also implement `other`.
2301 pub fn extends(self, other: ty::ClosureKind) -> bool {
2302 match (self, other) {
2303 (ClosureKind::Fn, ClosureKind::Fn) => true,
2304 (ClosureKind::Fn, ClosureKind::FnMut) => true,
2305 (ClosureKind::Fn, ClosureKind::FnOnce) => true,
2306 (ClosureKind::FnMut, ClosureKind::FnMut) => true,
2307 (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
2308 (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
2313 /// Returns the representative scalar type for this closure kind.
2314 /// See `TyS::to_opt_closure_kind` for more details.
2315 pub fn to_ty(self, tcx: TyCtxt<'_, '_, 'tcx>) -> Ty<'tcx> {
2317 ty::ClosureKind::Fn => tcx.types.i8,
2318 ty::ClosureKind::FnMut => tcx.types.i16,
2319 ty::ClosureKind::FnOnce => tcx.types.i32,
2324 impl<'tcx> TyS<'tcx> {
2325 /// Iterator that walks `self` and any types reachable from
2326 /// `self`, in depth-first order. Note that just walks the types
2327 /// that appear in `self`, it does not descend into the fields of
2328 /// structs or variants. For example:
2331 /// isize => { isize }
2332 /// Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
2333 /// [isize] => { [isize], isize }
2335 pub fn walk(&'tcx self) -> TypeWalker<'tcx> {
2336 TypeWalker::new(self)
2339 /// Iterator that walks the immediate children of `self`. Hence
2340 /// `Foo<Bar<i32>, u32>` yields the sequence `[Bar<i32>, u32]`
2341 /// (but not `i32`, like `walk`).
2342 pub fn walk_shallow(&'tcx self) -> AccIntoIter<walk::TypeWalkerArray<'tcx>> {
2343 walk::walk_shallow(self)
2346 /// Walks `ty` and any types appearing within `ty`, invoking the
2347 /// callback `f` on each type. If the callback returns false, then the
2348 /// children of the current type are ignored.
2350 /// Note: prefer `ty.walk()` where possible.
2351 pub fn maybe_walk<F>(&'tcx self, mut f: F)
2352 where F : FnMut(Ty<'tcx>) -> bool
2354 let mut walker = self.walk();
2355 while let Some(ty) = walker.next() {
2357 walker.skip_current_subtree();
2364 pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
2366 hir::MutMutable => MutBorrow,
2367 hir::MutImmutable => ImmBorrow,
2371 /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
2372 /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
2373 /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
2375 pub fn to_mutbl_lossy(self) -> hir::Mutability {
2377 MutBorrow => hir::MutMutable,
2378 ImmBorrow => hir::MutImmutable,
2380 // We have no type corresponding to a unique imm borrow, so
2381 // use `&mut`. It gives all the capabilities of an `&uniq`
2382 // and hence is a safe "over approximation".
2383 UniqueImmBorrow => hir::MutMutable,
2387 pub fn to_user_str(&self) -> &'static str {
2389 MutBorrow => "mutable",
2390 ImmBorrow => "immutable",
2391 UniqueImmBorrow => "uniquely immutable",
2396 #[derive(Debug, Clone)]
2397 pub enum Attributes<'gcx> {
2398 Owned(Lrc<[ast::Attribute]>),
2399 Borrowed(&'gcx [ast::Attribute])
2402 impl<'gcx> ::std::ops::Deref for Attributes<'gcx> {
2403 type Target = [ast::Attribute];
2405 fn deref(&self) -> &[ast::Attribute] {
2407 &Attributes::Owned(ref data) => &data,
2408 &Attributes::Borrowed(data) => data
2413 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2414 pub fn body_tables(self, body: hir::BodyId) -> &'gcx TypeckTables<'gcx> {
2415 self.typeck_tables_of(self.hir.body_owner_def_id(body))
2418 /// Returns an iterator of the def-ids for all body-owners in this
2419 /// crate. If you would prefer to iterate over the bodies
2420 /// themselves, you can do `self.hir.krate().body_ids.iter()`.
2423 ) -> impl Iterator<Item = DefId> + Captures<'tcx> + Captures<'gcx> + 'a {
2427 .map(move |&body_id| self.hir.body_owner_def_id(body_id))
2430 pub fn par_body_owners<F: Fn(DefId) + sync::Sync + sync::Send>(self, f: F) {
2431 par_iter(&self.hir.krate().body_ids).for_each(|&body_id| {
2432 f(self.hir.body_owner_def_id(body_id))
2436 pub fn expr_span(self, id: NodeId) -> Span {
2437 match self.hir.find(id) {
2438 Some(hir_map::NodeExpr(e)) => {
2442 bug!("Node id {} is not an expr: {:?}", id, f);
2445 bug!("Node id {} is not present in the node map", id);
2450 pub fn provided_trait_methods(self, id: DefId) -> Vec<AssociatedItem> {
2451 self.associated_items(id)
2452 .filter(|item| item.kind == AssociatedKind::Method && item.defaultness.has_value())
2456 pub fn trait_relevant_for_never(self, did: DefId) -> bool {
2457 self.associated_items(did).any(|item| {
2458 item.relevant_for_never()
2462 pub fn opt_associated_item(self, def_id: DefId) -> Option<AssociatedItem> {
2463 let is_associated_item = if let Some(node_id) = self.hir.as_local_node_id(def_id) {
2464 match self.hir.get(node_id) {
2465 hir_map::NodeTraitItem(_) | hir_map::NodeImplItem(_) => true,
2469 match self.describe_def(def_id).expect("no def for def-id") {
2470 Def::AssociatedConst(_) | Def::Method(_) | Def::AssociatedTy(_) => true,
2475 if is_associated_item {
2476 Some(self.associated_item(def_id))
2482 fn associated_item_from_trait_item_ref(self,
2483 parent_def_id: DefId,
2484 parent_vis: &hir::Visibility,
2485 trait_item_ref: &hir::TraitItemRef)
2487 let def_id = self.hir.local_def_id(trait_item_ref.id.node_id);
2488 let (kind, has_self) = match trait_item_ref.kind {
2489 hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2490 hir::AssociatedItemKind::Method { has_self } => {
2491 (ty::AssociatedKind::Method, has_self)
2493 hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2497 ident: trait_item_ref.ident,
2499 // Visibility of trait items is inherited from their traits.
2500 vis: Visibility::from_hir(parent_vis, trait_item_ref.id.node_id, self),
2501 defaultness: trait_item_ref.defaultness,
2503 container: TraitContainer(parent_def_id),
2504 method_has_self_argument: has_self
2508 fn associated_item_from_impl_item_ref(self,
2509 parent_def_id: DefId,
2510 impl_item_ref: &hir::ImplItemRef)
2512 let def_id = self.hir.local_def_id(impl_item_ref.id.node_id);
2513 let (kind, has_self) = match impl_item_ref.kind {
2514 hir::AssociatedItemKind::Const => (ty::AssociatedKind::Const, false),
2515 hir::AssociatedItemKind::Method { has_self } => {
2516 (ty::AssociatedKind::Method, has_self)
2518 hir::AssociatedItemKind::Type => (ty::AssociatedKind::Type, false),
2522 ident: impl_item_ref.ident,
2524 // Visibility of trait impl items doesn't matter.
2525 vis: ty::Visibility::from_hir(&impl_item_ref.vis, impl_item_ref.id.node_id, self),
2526 defaultness: impl_item_ref.defaultness,
2528 container: ImplContainer(parent_def_id),
2529 method_has_self_argument: has_self
2533 pub fn field_index(self, node_id: NodeId, tables: &TypeckTables) -> usize {
2534 let hir_id = self.hir.node_to_hir_id(node_id);
2535 tables.field_indices().get(hir_id).cloned().expect("no index for a field")
2538 pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2539 variant.fields.iter().position(|field| {
2540 self.adjust_ident(ident, variant.did, DUMMY_NODE_ID).0 == field.ident.modern()
2544 pub fn associated_items(
2547 ) -> impl Iterator<Item = AssociatedItem> + 'a {
2548 let def_ids = self.associated_item_def_ids(def_id);
2549 Box::new((0..def_ids.len()).map(move |i| self.associated_item(def_ids[i])))
2550 as Box<dyn Iterator<Item = AssociatedItem> + 'a>
2553 /// Returns true if the impls are the same polarity and are implementing
2554 /// a trait which contains no items
2555 pub fn impls_are_allowed_to_overlap(self, def_id1: DefId, def_id2: DefId) -> bool {
2556 if !self.features().overlapping_marker_traits {
2559 let trait1_is_empty = self.impl_trait_ref(def_id1)
2560 .map_or(false, |trait_ref| {
2561 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2563 let trait2_is_empty = self.impl_trait_ref(def_id2)
2564 .map_or(false, |trait_ref| {
2565 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2567 self.impl_polarity(def_id1) == self.impl_polarity(def_id2)
2572 // Returns `ty::VariantDef` if `def` refers to a struct,
2573 // or variant or their constructors, panics otherwise.
2574 pub fn expect_variant_def(self, def: Def) -> &'tcx VariantDef {
2576 Def::Variant(did) | Def::VariantCtor(did, ..) => {
2577 let enum_did = self.parent_def_id(did).unwrap();
2578 self.adt_def(enum_did).variant_with_id(did)
2580 Def::Struct(did) | Def::Union(did) => {
2581 self.adt_def(did).non_enum_variant()
2583 Def::StructCtor(ctor_did, ..) => {
2584 let did = self.parent_def_id(ctor_did).expect("struct ctor has no parent");
2585 self.adt_def(did).non_enum_variant()
2587 _ => bug!("expect_variant_def used with unexpected def {:?}", def)
2591 /// Given a `VariantDef`, returns the def-id of the `AdtDef` of which it is a part.
2592 pub fn adt_def_id_of_variant(self, variant_def: &'tcx VariantDef) -> DefId {
2593 let def_key = self.def_key(variant_def.did);
2594 match def_key.disambiguated_data.data {
2595 // for enum variants and tuple structs, the def-id of the ADT itself
2596 // is the *parent* of the variant
2597 DefPathData::EnumVariant(..) | DefPathData::StructCtor =>
2598 DefId { krate: variant_def.did.krate, index: def_key.parent.unwrap() },
2600 // otherwise, for structs and unions, they share a def-id
2601 _ => variant_def.did,
2605 pub fn item_name(self, id: DefId) -> InternedString {
2606 if id.index == CRATE_DEF_INDEX {
2607 self.original_crate_name(id.krate).as_interned_str()
2609 let def_key = self.def_key(id);
2610 // The name of a StructCtor is that of its struct parent.
2611 if let hir_map::DefPathData::StructCtor = def_key.disambiguated_data.data {
2612 self.item_name(DefId {
2614 index: def_key.parent.unwrap()
2617 def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
2618 bug!("item_name: no name for {:?}", self.def_path(id));
2624 /// Return the possibly-auto-generated MIR of a (DefId, Subst) pair.
2625 pub fn instance_mir(self, instance: ty::InstanceDef<'gcx>)
2629 ty::InstanceDef::Item(did) => {
2630 self.optimized_mir(did)
2632 ty::InstanceDef::Intrinsic(..) |
2633 ty::InstanceDef::FnPtrShim(..) |
2634 ty::InstanceDef::Virtual(..) |
2635 ty::InstanceDef::ClosureOnceShim { .. } |
2636 ty::InstanceDef::DropGlue(..) |
2637 ty::InstanceDef::CloneShim(..) => {
2638 self.mir_shims(instance)
2643 /// Given the DefId of an item, returns its MIR, borrowed immutably.
2644 /// Returns None if there is no MIR for the DefId
2645 pub fn maybe_optimized_mir(self, did: DefId) -> Option<&'gcx Mir<'gcx>> {
2646 if self.is_mir_available(did) {
2647 Some(self.optimized_mir(did))
2653 /// Get the attributes of a definition.
2654 pub fn get_attrs(self, did: DefId) -> Attributes<'gcx> {
2655 if let Some(id) = self.hir.as_local_node_id(did) {
2656 Attributes::Borrowed(self.hir.attrs(id))
2658 Attributes::Owned(self.item_attrs(did))
2662 /// Determine whether an item is annotated with an attribute
2663 pub fn has_attr(self, did: DefId, attr: &str) -> bool {
2664 attr::contains_name(&self.get_attrs(did), attr)
2667 /// Returns true if this is an `auto trait`.
2668 pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
2669 self.trait_def(trait_def_id).has_auto_impl
2672 pub fn generator_layout(self, def_id: DefId) -> &'tcx GeneratorLayout<'tcx> {
2673 self.optimized_mir(def_id).generator_layout.as_ref().unwrap()
2676 /// Given the def_id of an impl, return the def_id of the trait it implements.
2677 /// If it implements no trait, return `None`.
2678 pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
2679 self.impl_trait_ref(def_id).map(|tr| tr.def_id)
2682 /// If the given def ID describes a method belonging to an impl, return the
2683 /// ID of the impl that the method belongs to. Otherwise, return `None`.
2684 pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
2685 let item = if def_id.krate != LOCAL_CRATE {
2686 if let Some(Def::Method(_)) = self.describe_def(def_id) {
2687 Some(self.associated_item(def_id))
2692 self.opt_associated_item(def_id)
2696 Some(trait_item) => {
2697 match trait_item.container {
2698 TraitContainer(_) => None,
2699 ImplContainer(def_id) => Some(def_id),
2706 /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
2707 /// with the name of the crate containing the impl.
2708 pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
2709 if impl_did.is_local() {
2710 let node_id = self.hir.as_local_node_id(impl_did).unwrap();
2711 Ok(self.hir.span(node_id))
2713 Err(self.crate_name(impl_did.krate))
2717 // Hygienically compare a use-site name (`use_name`) for a field or an associated item with its
2718 // supposed definition name (`def_name`). The method also needs `DefId` of the supposed
2719 // definition's parent/scope to perform comparison.
2720 pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
2721 self.adjust_ident(use_name, def_parent_def_id, DUMMY_NODE_ID).0 == def_name.modern()
2724 pub fn adjust_ident(self, mut ident: Ident, scope: DefId, block: NodeId) -> (Ident, DefId) {
2725 ident = ident.modern();
2726 let target_expansion = match scope.krate {
2727 LOCAL_CRATE => self.hir.definitions().opaque_expansion_that_defined(scope.index),
2730 let scope = match ident.span.adjust(target_expansion) {
2731 Some(actual_expansion) =>
2732 self.hir.definitions().parent_module_of_macro_def(actual_expansion),
2733 None if block == DUMMY_NODE_ID => DefId::local(CRATE_DEF_INDEX), // Dummy DefId
2734 None => self.hir.get_module_parent(block),
2740 impl<'a, 'gcx, 'tcx> TyCtxt<'a, 'gcx, 'tcx> {
2741 pub fn with_freevars<T, F>(self, fid: NodeId, f: F) -> T where
2742 F: FnOnce(&[hir::Freevar]) -> T,
2744 let def_id = self.hir.local_def_id(fid);
2745 match self.freevars(def_id) {
2752 fn associated_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId)
2755 let id = tcx.hir.as_local_node_id(def_id).unwrap();
2756 let parent_id = tcx.hir.get_parent(id);
2757 let parent_def_id = tcx.hir.local_def_id(parent_id);
2758 let parent_item = tcx.hir.expect_item(parent_id);
2759 match parent_item.node {
2760 hir::ItemImpl(.., ref impl_item_refs) => {
2761 if let Some(impl_item_ref) = impl_item_refs.iter().find(|i| i.id.node_id == id) {
2762 let assoc_item = tcx.associated_item_from_impl_item_ref(parent_def_id,
2764 debug_assert_eq!(assoc_item.def_id, def_id);
2769 hir::ItemTrait(.., ref trait_item_refs) => {
2770 if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.node_id == id) {
2771 let assoc_item = tcx.associated_item_from_trait_item_ref(parent_def_id,
2774 debug_assert_eq!(assoc_item.def_id, def_id);
2782 span_bug!(parent_item.span,
2783 "unexpected parent of trait or impl item or item not found: {:?}",
2787 /// Calculates the Sized-constraint.
2789 /// In fact, there are only a few options for the types in the constraint:
2790 /// - an obviously-unsized type
2791 /// - a type parameter or projection whose Sizedness can't be known
2792 /// - a tuple of type parameters or projections, if there are multiple
2794 /// - a TyError, if a type contained itself. The representability
2795 /// check should catch this case.
2796 fn adt_sized_constraint<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2798 -> &'tcx [Ty<'tcx>] {
2799 let def = tcx.adt_def(def_id);
2801 let result = tcx.mk_type_list(def.variants.iter().flat_map(|v| {
2804 def.sized_constraint_for_ty(tcx, tcx.type_of(f.did))
2807 debug!("adt_sized_constraint: {:?} => {:?}", def, result);
2812 fn associated_item_def_ids<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2814 -> Lrc<Vec<DefId>> {
2815 let id = tcx.hir.as_local_node_id(def_id).unwrap();
2816 let item = tcx.hir.expect_item(id);
2817 let vec: Vec<_> = match item.node {
2818 hir::ItemTrait(.., ref trait_item_refs) => {
2819 trait_item_refs.iter()
2820 .map(|trait_item_ref| trait_item_ref.id)
2821 .map(|id| tcx.hir.local_def_id(id.node_id))
2824 hir::ItemImpl(.., ref impl_item_refs) => {
2825 impl_item_refs.iter()
2826 .map(|impl_item_ref| impl_item_ref.id)
2827 .map(|id| tcx.hir.local_def_id(id.node_id))
2830 hir::ItemTraitAlias(..) => vec![],
2831 _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait")
2836 fn def_span<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Span {
2837 tcx.hir.span_if_local(def_id).unwrap()
2840 /// If the given def ID describes an item belonging to a trait,
2841 /// return the ID of the trait that the trait item belongs to.
2842 /// Otherwise, return `None`.
2843 fn trait_of_item<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>, def_id: DefId) -> Option<DefId> {
2844 tcx.opt_associated_item(def_id)
2845 .and_then(|associated_item| {
2846 match associated_item.container {
2847 TraitContainer(def_id) => Some(def_id),
2848 ImplContainer(_) => None
2853 /// See `ParamEnv` struct def'n for details.
2854 fn param_env<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2858 // The param_env of an existential type is its parent's param_env
2859 if let Some(Def::Existential(_)) = tcx.describe_def(def_id) {
2860 let parent = tcx.parent_def_id(def_id).expect("impl trait item w/o a parent");
2861 return param_env(tcx, parent);
2863 // Compute the bounds on Self and the type parameters.
2865 let bounds = tcx.predicates_of(def_id).instantiate_identity(tcx);
2866 let predicates = bounds.predicates;
2868 // Finally, we have to normalize the bounds in the environment, in
2869 // case they contain any associated type projections. This process
2870 // can yield errors if the put in illegal associated types, like
2871 // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
2872 // report these errors right here; this doesn't actually feel
2873 // right to me, because constructing the environment feels like a
2874 // kind of a "idempotent" action, but I'm not sure where would be
2875 // a better place. In practice, we construct environments for
2876 // every fn once during type checking, and we'll abort if there
2877 // are any errors at that point, so after type checking you can be
2878 // sure that this will succeed without errors anyway.
2880 let unnormalized_env = ty::ParamEnv::new(tcx.intern_predicates(&predicates),
2881 traits::Reveal::UserFacing);
2883 let body_id = tcx.hir.as_local_node_id(def_id).map_or(DUMMY_NODE_ID, |id| {
2884 tcx.hir.maybe_body_owned_by(id).map_or(id, |body| body.node_id)
2886 let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
2887 traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
2890 fn crate_disambiguator<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2891 crate_num: CrateNum) -> CrateDisambiguator {
2892 assert_eq!(crate_num, LOCAL_CRATE);
2893 tcx.sess.local_crate_disambiguator()
2896 fn original_crate_name<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2897 crate_num: CrateNum) -> Symbol {
2898 assert_eq!(crate_num, LOCAL_CRATE);
2899 tcx.crate_name.clone()
2902 fn crate_hash<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2903 crate_num: CrateNum)
2905 assert_eq!(crate_num, LOCAL_CRATE);
2909 fn instance_def_size_estimate<'a, 'tcx>(tcx: TyCtxt<'a, 'tcx, 'tcx>,
2910 instance_def: InstanceDef<'tcx>)
2912 match instance_def {
2913 InstanceDef::Item(..) |
2914 InstanceDef::DropGlue(..) => {
2915 let mir = tcx.instance_mir(instance_def);
2916 mir.basic_blocks().iter().map(|bb| bb.statements.len()).sum()
2918 // Estimate the size of other compiler-generated shims to be 1.
2923 pub fn provide(providers: &mut ty::query::Providers) {
2924 context::provide(providers);
2925 erase_regions::provide(providers);
2926 layout::provide(providers);
2927 util::provide(providers);
2928 *providers = ty::query::Providers {
2930 associated_item_def_ids,
2931 adt_sized_constraint,
2935 crate_disambiguator,
2936 original_crate_name,
2938 trait_impls_of: trait_def::trait_impls_of_provider,
2939 instance_def_size_estimate,
2944 /// A map for the local crate mapping each type to a vector of its
2945 /// inherent impls. This is not meant to be used outside of coherence;
2946 /// rather, you should request the vector for a specific type via
2947 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
2948 /// (constructing this map requires touching the entire crate).
2949 #[derive(Clone, Debug)]
2950 pub struct CrateInherentImpls {
2951 pub inherent_impls: DefIdMap<Lrc<Vec<DefId>>>,
2954 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, RustcEncodable, RustcDecodable)]
2955 pub struct SymbolName {
2956 // FIXME: we don't rely on interning or equality here - better have
2957 // this be a `&'tcx str`.
2958 pub name: InternedString
2961 impl_stable_hash_for!(struct self::SymbolName {
2966 pub fn new(name: &str) -> SymbolName {
2968 name: Symbol::intern(name).as_interned_str()
2972 pub fn as_str(&self) -> LocalInternedString {
2977 impl fmt::Display for SymbolName {
2978 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
2979 fmt::Display::fmt(&self.name, fmt)
2983 impl fmt::Debug for SymbolName {
2984 fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
2985 fmt::Display::fmt(&self.name, fmt)