1 // ignore-tidy-filelength
3 pub use self::Variance::*;
4 pub use self::AssocItemContainer::*;
5 pub use self::BorrowKind::*;
6 pub use self::IntVarValue::*;
7 pub use self::fold::{TypeFoldable, TypeVisitor};
9 use crate::hir::{map as hir_map, GlobMap, TraitMap};
11 use crate::hir::def::{Res, DefKind, CtorOf, CtorKind, ExportMap};
12 use crate::hir::def_id::{CrateNum, DefId, LocalDefId, CRATE_DEF_INDEX, LOCAL_CRATE};
13 use rustc_data_structures::svh::Svh;
14 use rustc_macros::HashStable;
15 use crate::ich::Fingerprint;
16 use crate::ich::StableHashingContext;
17 use crate::infer::canonical::Canonical;
18 use crate::middle::cstore::CrateStoreDyn;
19 use crate::middle::lang_items::{FnTraitLangItem, FnMutTraitLangItem, FnOnceTraitLangItem};
20 use crate::middle::resolve_lifetime::ObjectLifetimeDefault;
22 use crate::mir::interpret::{GlobalId, ErrorHandled};
23 use crate::mir::GeneratorLayout;
24 use crate::session::CrateDisambiguator;
25 use crate::traits::{self, Reveal};
27 use crate::ty::layout::VariantIdx;
28 use crate::ty::subst::{Subst, InternalSubsts, SubstsRef};
29 use crate::ty::util::{IntTypeExt, Discr};
30 use crate::ty::walk::TypeWalker;
31 use crate::util::captures::Captures;
32 use crate::util::nodemap::{NodeMap, NodeSet, DefIdMap, FxHashMap};
33 use arena::SyncDroplessArena;
34 use crate::session::DataTypeKind;
36 use rustc_serialize::{self, Encodable, Encoder};
37 use rustc_target::abi::Align;
38 use std::cell::RefCell;
39 use std::cmp::{self, Ordering};
41 use std::hash::{Hash, Hasher};
43 use rustc_data_structures::sync::{self, Lrc, ParallelIterator, par_iter};
47 use syntax::ast::{self, Name, Ident, NodeId};
49 use syntax_pos::symbol::{kw, sym, Symbol};
50 use syntax_pos::hygiene::ExpnId;
54 use rustc_data_structures::fx::{FxIndexMap};
55 use rustc_data_structures::stable_hasher::{StableHasher, HashStable};
56 use rustc_index::vec::{Idx, IndexVec};
60 pub use self::sty::{Binder, BoundTy, BoundTyKind, BoundVar, DebruijnIndex, INNERMOST};
61 pub use self::sty::{FnSig, GenSig, CanonicalPolyFnSig, PolyFnSig, PolyGenSig};
62 pub use self::sty::{InferTy, ParamTy, ParamConst, InferConst, ProjectionTy, ExistentialPredicate};
63 pub use self::sty::{ClosureSubsts, GeneratorSubsts, UpvarSubsts, TypeAndMut};
64 pub use self::sty::{TraitRef, TyKind, PolyTraitRef};
65 pub use self::sty::{ExistentialTraitRef, PolyExistentialTraitRef};
66 pub use self::sty::{ExistentialProjection, PolyExistentialProjection, Const, ConstKind};
67 pub use self::sty::{BoundRegion, EarlyBoundRegion, FreeRegion, Region};
68 pub use self::sty::RegionKind;
69 pub use self::sty::{TyVid, IntVid, FloatVid, ConstVid, RegionVid};
70 pub use self::sty::BoundRegion::*;
71 pub use self::sty::InferTy::*;
72 pub use self::sty::RegionKind::*;
73 pub use self::sty::TyKind::*;
75 pub use self::binding::BindingMode;
76 pub use self::binding::BindingMode::*;
78 pub use self::context::{TyCtxt, FreeRegionInfo, AllArenas, tls, keep_local};
79 pub use self::context::{Lift, GeneratorInteriorTypeCause, TypeckTables, CtxtInterners, GlobalCtxt};
80 pub use self::context::{
81 UserTypeAnnotationIndex, UserType, CanonicalUserType,
82 CanonicalUserTypeAnnotation, CanonicalUserTypeAnnotations, ResolvedOpaqueTy,
85 pub use self::instance::{Instance, InstanceDef};
87 pub use self::structural_match::search_for_structural_match_violation;
88 pub use self::structural_match::type_marked_structural;
89 pub use self::structural_match::NonStructuralMatchTy;
91 pub use self::trait_def::TraitDef;
93 pub use self::query::queries;
106 pub mod inhabitedness;
122 mod structural_impls;
123 mod structural_match;
128 pub struct ResolverOutputs {
129 pub definitions: hir_map::Definitions,
130 pub cstore: Box<CrateStoreDyn>,
131 pub extern_crate_map: NodeMap<CrateNum>,
132 pub trait_map: TraitMap,
133 pub maybe_unused_trait_imports: NodeSet,
134 pub maybe_unused_extern_crates: Vec<(NodeId, Span)>,
135 pub export_map: ExportMap<NodeId>,
136 pub glob_map: GlobMap,
137 /// Extern prelude entries. The value is `true` if the entry was introduced
138 /// via `extern crate` item and not `--extern` option or compiler built-in.
139 pub extern_prelude: FxHashMap<Name, bool>,
142 #[derive(Clone, Copy, PartialEq, Eq, Debug, HashStable)]
143 pub enum AssocItemContainer {
144 TraitContainer(DefId),
145 ImplContainer(DefId),
148 impl AssocItemContainer {
149 /// Asserts that this is the `DefId` of an associated item declared
150 /// in a trait, and returns the trait `DefId`.
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, Debug, TypeFoldable)]
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, PartialEq, RustcEncodable, RustcDecodable, HashStable)]
178 pub enum ImplPolarity {
179 /// `impl Trait for Type`
181 /// `impl !Trait for Type`
183 /// `#[rustc_reservation_impl] impl Trait for Type`
185 /// This is a "stability hack", not a real Rust feature.
186 /// See #64631 for details.
190 #[derive(Copy, Clone, Debug, PartialEq, HashStable)]
191 pub struct AssocItem {
193 #[stable_hasher(project(name))]
197 pub defaultness: hir::Defaultness,
198 pub container: AssocItemContainer,
200 /// Whether this is a method with an explicit self
201 /// as its first argument, allowing method calls.
202 pub method_has_self_argument: bool,
205 #[derive(Copy, Clone, PartialEq, Debug, HashStable)]
214 pub fn def_kind(&self) -> DefKind {
216 AssocKind::Const => DefKind::AssocConst,
217 AssocKind::Method => DefKind::Method,
218 AssocKind::Type => DefKind::AssocTy,
219 AssocKind::OpaqueTy => DefKind::AssocOpaqueTy,
223 /// Tests whether the associated item admits a non-trivial implementation
225 pub fn relevant_for_never(&self) -> bool {
227 AssocKind::OpaqueTy |
229 AssocKind::Type => true,
230 // FIXME(canndrew): Be more thorough here, check if any argument is uninhabited.
231 AssocKind::Method => !self.method_has_self_argument,
235 pub fn signature(&self, tcx: TyCtxt<'_>) -> String {
237 ty::AssocKind::Method => {
238 // We skip the binder here because the binder would deanonymize all
239 // late-bound regions, and we don't want method signatures to show up
240 // `as for<'r> fn(&'r MyType)`. Pretty-printing handles late-bound
241 // regions just fine, showing `fn(&MyType)`.
242 tcx.fn_sig(self.def_id).skip_binder().to_string()
244 ty::AssocKind::Type => format!("type {};", self.ident),
245 // FIXME(type_alias_impl_trait): we should print bounds here too.
246 ty::AssocKind::OpaqueTy => format!("type {};", self.ident),
247 ty::AssocKind::Const => {
248 format!("const {}: {:?};", self.ident, tcx.type_of(self.def_id))
254 #[derive(Clone, Debug, PartialEq, Eq, Copy, RustcEncodable, RustcDecodable, HashStable)]
255 pub enum Visibility {
256 /// Visible everywhere (including in other crates).
258 /// Visible only in the given crate-local module.
260 /// Not visible anywhere in the local crate. This is the visibility of private external items.
264 pub trait DefIdTree: Copy {
265 fn parent(self, id: DefId) -> Option<DefId>;
267 fn is_descendant_of(self, mut descendant: DefId, ancestor: DefId) -> bool {
268 if descendant.krate != ancestor.krate {
272 while descendant != ancestor {
273 match self.parent(descendant) {
274 Some(parent) => descendant = parent,
275 None => return false,
282 impl<'tcx> DefIdTree for TyCtxt<'tcx> {
283 fn parent(self, id: DefId) -> Option<DefId> {
284 self.def_key(id).parent.map(|index| DefId { index: index, ..id })
289 pub fn from_hir(visibility: &hir::Visibility, id: hir::HirId, tcx: TyCtxt<'_>) -> Self {
290 match visibility.node {
291 hir::VisibilityKind::Public => Visibility::Public,
292 hir::VisibilityKind::Crate(_) => Visibility::Restricted(DefId::local(CRATE_DEF_INDEX)),
293 hir::VisibilityKind::Restricted { ref path, .. } => match path.res {
294 // If there is no resolution, `resolve` will have already reported an error, so
295 // assume that the visibility is public to avoid reporting more privacy errors.
296 Res::Err => Visibility::Public,
297 def => Visibility::Restricted(def.def_id()),
299 hir::VisibilityKind::Inherited => {
300 Visibility::Restricted(tcx.hir().get_module_parent(id))
305 /// Returns `true` if an item with this visibility is accessible from the given block.
306 pub fn is_accessible_from<T: DefIdTree>(self, module: DefId, tree: T) -> bool {
307 let restriction = match self {
308 // Public items are visible everywhere.
309 Visibility::Public => return true,
310 // Private items from other crates are visible nowhere.
311 Visibility::Invisible => return false,
312 // Restricted items are visible in an arbitrary local module.
313 Visibility::Restricted(other) if other.krate != module.krate => return false,
314 Visibility::Restricted(module) => module,
317 tree.is_descendant_of(module, restriction)
320 /// Returns `true` if this visibility is at least as accessible as the given visibility
321 pub fn is_at_least<T: DefIdTree>(self, vis: Visibility, tree: T) -> bool {
322 let vis_restriction = match vis {
323 Visibility::Public => return self == Visibility::Public,
324 Visibility::Invisible => return true,
325 Visibility::Restricted(module) => module,
328 self.is_accessible_from(vis_restriction, tree)
331 // Returns `true` if this item is visible anywhere in the local crate.
332 pub fn is_visible_locally(self) -> bool {
334 Visibility::Public => true,
335 Visibility::Restricted(def_id) => def_id.is_local(),
336 Visibility::Invisible => false,
341 #[derive(Copy, Clone, PartialEq, RustcDecodable, RustcEncodable, HashStable)]
343 Covariant, // T<A> <: T<B> iff A <: B -- e.g., function return type
344 Invariant, // T<A> <: T<B> iff B == A -- e.g., type of mutable cell
345 Contravariant, // T<A> <: T<B> iff B <: A -- e.g., function param type
346 Bivariant, // T<A> <: T<B> -- e.g., unused type parameter
349 /// The crate variances map is computed during typeck and contains the
350 /// variance of every item in the local crate. You should not use it
351 /// directly, because to do so will make your pass dependent on the
352 /// HIR of every item in the local crate. Instead, use
353 /// `tcx.variances_of()` to get the variance for a *particular*
355 #[derive(HashStable)]
356 pub struct CrateVariancesMap<'tcx> {
357 /// For each item with generics, maps to a vector of the variance
358 /// of its generics. If an item has no generics, it will have no
360 pub variances: FxHashMap<DefId, &'tcx [ty::Variance]>,
364 /// `a.xform(b)` combines the variance of a context with the
365 /// variance of a type with the following meaning. If we are in a
366 /// context with variance `a`, and we encounter a type argument in
367 /// a position with variance `b`, then `a.xform(b)` is the new
368 /// variance with which the argument appears.
374 /// Here, the "ambient" variance starts as covariant. `*mut T` is
375 /// invariant with respect to `T`, so the variance in which the
376 /// `Vec<i32>` appears is `Covariant.xform(Invariant)`, which
377 /// yields `Invariant`. Now, the type `Vec<T>` is covariant with
378 /// respect to its type argument `T`, and hence the variance of
379 /// the `i32` here is `Invariant.xform(Covariant)`, which results
380 /// (again) in `Invariant`.
384 /// fn(*const Vec<i32>, *mut Vec<i32)
386 /// The ambient variance is covariant. A `fn` type is
387 /// contravariant with respect to its parameters, so the variance
388 /// within which both pointer types appear is
389 /// `Covariant.xform(Contravariant)`, or `Contravariant`. `*const
390 /// T` is covariant with respect to `T`, so the variance within
391 /// which the first `Vec<i32>` appears is
392 /// `Contravariant.xform(Covariant)` or `Contravariant`. The same
393 /// is true for its `i32` argument. In the `*mut T` case, the
394 /// variance of `Vec<i32>` is `Contravariant.xform(Invariant)`,
395 /// and hence the outermost type is `Invariant` with respect to
396 /// `Vec<i32>` (and its `i32` argument).
398 /// Source: Figure 1 of "Taming the Wildcards:
399 /// Combining Definition- and Use-Site Variance" published in PLDI'11.
400 pub fn xform(self, v: ty::Variance) -> ty::Variance {
402 // Figure 1, column 1.
403 (ty::Covariant, ty::Covariant) => ty::Covariant,
404 (ty::Covariant, ty::Contravariant) => ty::Contravariant,
405 (ty::Covariant, ty::Invariant) => ty::Invariant,
406 (ty::Covariant, ty::Bivariant) => ty::Bivariant,
408 // Figure 1, column 2.
409 (ty::Contravariant, ty::Covariant) => ty::Contravariant,
410 (ty::Contravariant, ty::Contravariant) => ty::Covariant,
411 (ty::Contravariant, ty::Invariant) => ty::Invariant,
412 (ty::Contravariant, ty::Bivariant) => ty::Bivariant,
414 // Figure 1, column 3.
415 (ty::Invariant, _) => ty::Invariant,
417 // Figure 1, column 4.
418 (ty::Bivariant, _) => ty::Bivariant,
423 // Contains information needed to resolve types and (in the future) look up
424 // the types of AST nodes.
425 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
426 pub struct CReaderCacheKey {
431 // Flags that we track on types. These flags are propagated upwards
432 // through the type during type construction, so that we can quickly
433 // check whether the type has various kinds of types in it without
434 // recursing over the type itself.
436 pub struct TypeFlags: u32 {
437 const HAS_PARAMS = 1 << 0;
438 const HAS_TY_INFER = 1 << 1;
439 const HAS_RE_INFER = 1 << 2;
440 const HAS_RE_PLACEHOLDER = 1 << 3;
442 /// Does this have any `ReEarlyBound` regions? Used to
443 /// determine whether substitition is required, since those
444 /// represent regions that are bound in a `ty::Generics` and
445 /// hence may be substituted.
446 const HAS_RE_EARLY_BOUND = 1 << 4;
448 /// Does this have any region that "appears free" in the type?
449 /// Basically anything but `ReLateBound` and `ReErased`.
450 const HAS_FREE_REGIONS = 1 << 5;
452 /// Is an error type reachable?
453 const HAS_TY_ERR = 1 << 6;
454 const HAS_PROJECTION = 1 << 7;
456 // FIXME: Rename this to the actual property since it's used for generators too
457 const HAS_TY_CLOSURE = 1 << 8;
459 /// `true` if there are "names" of types and regions and so forth
460 /// that are local to a particular fn
461 const HAS_FREE_LOCAL_NAMES = 1 << 9;
463 /// Present if the type belongs in a local type context.
464 /// Only set for Infer other than Fresh.
465 const KEEP_IN_LOCAL_TCX = 1 << 10;
467 /// Does this have any `ReLateBound` regions? Used to check
468 /// if a global bound is safe to evaluate.
469 const HAS_RE_LATE_BOUND = 1 << 11;
471 const HAS_TY_PLACEHOLDER = 1 << 12;
473 const HAS_CT_INFER = 1 << 13;
474 const HAS_CT_PLACEHOLDER = 1 << 14;
476 const NEEDS_SUBST = TypeFlags::HAS_PARAMS.bits |
477 TypeFlags::HAS_RE_EARLY_BOUND.bits;
479 /// Flags representing the nominal content of a type,
480 /// computed by FlagsComputation. If you add a new nominal
481 /// flag, it should be added here too.
482 const NOMINAL_FLAGS = TypeFlags::HAS_PARAMS.bits |
483 TypeFlags::HAS_TY_INFER.bits |
484 TypeFlags::HAS_RE_INFER.bits |
485 TypeFlags::HAS_RE_PLACEHOLDER.bits |
486 TypeFlags::HAS_RE_EARLY_BOUND.bits |
487 TypeFlags::HAS_FREE_REGIONS.bits |
488 TypeFlags::HAS_TY_ERR.bits |
489 TypeFlags::HAS_PROJECTION.bits |
490 TypeFlags::HAS_TY_CLOSURE.bits |
491 TypeFlags::HAS_FREE_LOCAL_NAMES.bits |
492 TypeFlags::KEEP_IN_LOCAL_TCX.bits |
493 TypeFlags::HAS_RE_LATE_BOUND.bits |
494 TypeFlags::HAS_TY_PLACEHOLDER.bits |
495 TypeFlags::HAS_CT_INFER.bits |
496 TypeFlags::HAS_CT_PLACEHOLDER.bits;
500 #[allow(rustc::usage_of_ty_tykind)]
501 pub struct TyS<'tcx> {
502 pub kind: TyKind<'tcx>,
503 pub flags: TypeFlags,
505 /// This is a kind of confusing thing: it stores the smallest
508 /// (a) the binder itself captures nothing but
509 /// (b) all the late-bound things within the type are captured
510 /// by some sub-binder.
512 /// So, for a type without any late-bound things, like `u32`, this
513 /// will be *innermost*, because that is the innermost binder that
514 /// captures nothing. But for a type `&'D u32`, where `'D` is a
515 /// late-bound region with De Bruijn index `D`, this would be `D + 1`
516 /// -- the binder itself does not capture `D`, but `D` is captured
517 /// by an inner binder.
519 /// We call this concept an "exclusive" binder `D` because all
520 /// De Bruijn indices within the type are contained within `0..D`
522 outer_exclusive_binder: ty::DebruijnIndex,
525 // `TyS` is used a lot. Make sure it doesn't unintentionally get bigger.
526 #[cfg(target_arch = "x86_64")]
527 static_assert_size!(TyS<'_>, 32);
529 impl<'tcx> Ord for TyS<'tcx> {
530 fn cmp(&self, other: &TyS<'tcx>) -> Ordering {
531 self.kind.cmp(&other.kind)
535 impl<'tcx> PartialOrd for TyS<'tcx> {
536 fn partial_cmp(&self, other: &TyS<'tcx>) -> Option<Ordering> {
537 Some(self.kind.cmp(&other.kind))
541 impl<'tcx> PartialEq for TyS<'tcx> {
543 fn eq(&self, other: &TyS<'tcx>) -> bool {
547 impl<'tcx> Eq for TyS<'tcx> {}
549 impl<'tcx> Hash for TyS<'tcx> {
550 fn hash<H: Hasher>(&self, s: &mut H) {
551 (self as *const TyS<'_>).hash(s)
555 impl<'tcx> TyS<'tcx> {
556 pub fn is_primitive_ty(&self) -> bool {
558 Bool | Char | Str | Int(_) | Uint(_) | Float(_) |
559 Infer(InferTy::IntVar(_)) | Infer(InferTy::FloatVar(_)) |
560 Infer(InferTy::FreshIntTy(_)) | Infer(InferTy::FreshFloatTy(_)) => true,
565 pub fn is_simple_ty(&self) -> bool {
567 Bool | Char | Str | Int(_) | Uint(_) | Float(_) |
568 Infer(InferTy::IntVar(_)) | Infer(InferTy::FloatVar(_)) |
569 Infer(InferTy::FreshIntTy(_)) | Infer(InferTy::FreshFloatTy(_)) => true,
570 Ref(_, x, _) | Array(x, _) | Slice(x) => x.peel_refs().is_simple_ty(),
571 Tuple(tys) if tys.is_empty() => true,
576 pub fn is_simple_text(&self) -> bool {
578 Adt(_, substs) => substs.types().next().is_none(),
579 Ref(_, ty, _) => ty.is_simple_text(),
580 _ if self.is_simple_ty() => true,
585 pub fn is_suggestable(&self) -> bool {
593 Projection(..) => false,
599 impl<'a, 'tcx> HashStable<StableHashingContext<'a>> for ty::TyS<'tcx> {
600 fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
604 // The other fields just provide fast access to information that is
605 // also contained in `kind`, so no need to hash them.
608 outer_exclusive_binder: _,
611 kind.hash_stable(hcx, hasher);
615 #[rustc_diagnostic_item = "Ty"]
616 pub type Ty<'tcx> = &'tcx TyS<'tcx>;
618 impl<'tcx> rustc_serialize::UseSpecializedEncodable for Ty<'tcx> {}
619 impl<'tcx> rustc_serialize::UseSpecializedDecodable for Ty<'tcx> {}
621 pub type CanonicalTy<'tcx> = Canonical<'tcx, Ty<'tcx>>;
624 /// A dummy type used to force `List` to be unsized while not requiring references to it be wide
626 type OpaqueListContents;
629 /// A wrapper for slices with the additional invariant
630 /// that the slice is interned and no other slice with
631 /// the same contents can exist in the same context.
632 /// This means we can use pointer for both
633 /// equality comparisons and hashing.
634 /// Note: `Slice` was already taken by the `Ty`.
639 opaque: OpaqueListContents,
642 unsafe impl<T: Sync> Sync for List<T> {}
644 impl<T: Copy> List<T> {
646 fn from_arena<'tcx>(arena: &'tcx SyncDroplessArena, slice: &[T]) -> &'tcx List<T> {
647 assert!(!mem::needs_drop::<T>());
648 assert!(mem::size_of::<T>() != 0);
649 assert!(slice.len() != 0);
651 // Align up the size of the len (usize) field
652 let align = mem::align_of::<T>();
653 let align_mask = align - 1;
654 let offset = mem::size_of::<usize>();
655 let offset = (offset + align_mask) & !align_mask;
657 let size = offset + slice.len() * mem::size_of::<T>();
659 let mem = arena.alloc_raw(
661 cmp::max(mem::align_of::<T>(), mem::align_of::<usize>()));
663 let result = &mut *(mem.as_mut_ptr() as *mut List<T>);
665 result.len = slice.len();
667 // Write the elements
668 let arena_slice = slice::from_raw_parts_mut(result.data.as_mut_ptr(), result.len);
669 arena_slice.copy_from_slice(slice);
676 impl<T: fmt::Debug> fmt::Debug for List<T> {
677 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
682 impl<T: Encodable> Encodable for List<T> {
684 fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
689 impl<T> Ord for List<T> where T: Ord {
690 fn cmp(&self, other: &List<T>) -> Ordering {
691 if self == other { Ordering::Equal } else {
692 <[T] as Ord>::cmp(&**self, &**other)
697 impl<T> PartialOrd for List<T> where T: PartialOrd {
698 fn partial_cmp(&self, other: &List<T>) -> Option<Ordering> {
699 if self == other { Some(Ordering::Equal) } else {
700 <[T] as PartialOrd>::partial_cmp(&**self, &**other)
705 impl<T: PartialEq> PartialEq for List<T> {
707 fn eq(&self, other: &List<T>) -> bool {
711 impl<T: Eq> Eq for List<T> {}
713 impl<T> Hash for List<T> {
715 fn hash<H: Hasher>(&self, s: &mut H) {
716 (self as *const List<T>).hash(s)
720 impl<T> Deref for List<T> {
723 fn deref(&self) -> &[T] {
728 impl<T> AsRef<[T]> for List<T> {
730 fn as_ref(&self) -> &[T] {
732 slice::from_raw_parts(self.data.as_ptr(), self.len)
737 impl<'a, T> IntoIterator for &'a List<T> {
739 type IntoIter = <&'a [T] as IntoIterator>::IntoIter;
741 fn into_iter(self) -> Self::IntoIter {
746 impl<'tcx> rustc_serialize::UseSpecializedDecodable for &'tcx List<Ty<'tcx>> {}
750 pub fn empty<'a>() -> &'a List<T> {
751 #[repr(align(64), C)]
752 struct EmptySlice([u8; 64]);
753 static EMPTY_SLICE: EmptySlice = EmptySlice([0; 64]);
754 assert!(mem::align_of::<T>() <= 64);
756 &*(&EMPTY_SLICE as *const _ as *const List<T>)
761 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
762 pub struct UpvarPath {
763 pub hir_id: hir::HirId,
766 /// Upvars do not get their own `NodeId`. Instead, we use the pair of
767 /// the original var ID (that is, the root variable that is referenced
768 /// by the upvar) and the ID of the closure expression.
769 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, HashStable)]
771 pub var_path: UpvarPath,
772 pub closure_expr_id: LocalDefId,
775 #[derive(Clone, PartialEq, Debug, RustcEncodable, RustcDecodable, Copy, HashStable)]
776 pub enum BorrowKind {
777 /// Data must be immutable and is aliasable.
780 /// Data must be immutable but not aliasable. This kind of borrow
781 /// cannot currently be expressed by the user and is used only in
782 /// implicit closure bindings. It is needed when the closure
783 /// is borrowing or mutating a mutable referent, e.g.:
785 /// let x: &mut isize = ...;
786 /// let y = || *x += 5;
788 /// If we were to try to translate this closure into a more explicit
789 /// form, we'd encounter an error with the code as written:
791 /// struct Env { x: & &mut isize }
792 /// let x: &mut isize = ...;
793 /// let y = (&mut Env { &x }, fn_ptr); // Closure is pair of env and fn
794 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
796 /// This is then illegal because you cannot mutate a `&mut` found
797 /// in an aliasable location. To solve, you'd have to translate with
798 /// an `&mut` borrow:
800 /// struct Env { x: & &mut isize }
801 /// let x: &mut isize = ...;
802 /// let y = (&mut Env { &mut x }, fn_ptr); // changed from &x to &mut x
803 /// fn fn_ptr(env: &mut Env) { **env.x += 5; }
805 /// Now the assignment to `**env.x` is legal, but creating a
806 /// mutable pointer to `x` is not because `x` is not mutable. We
807 /// could fix this by declaring `x` as `let mut x`. This is ok in
808 /// user code, if awkward, but extra weird for closures, since the
809 /// borrow is hidden.
811 /// So we introduce a "unique imm" borrow -- the referent is
812 /// immutable, but not aliasable. This solves the problem. For
813 /// simplicity, we don't give users the way to express this
814 /// borrow, it's just used when translating closures.
817 /// Data is mutable and not aliasable.
821 /// Information describing the capture of an upvar. This is computed
822 /// during `typeck`, specifically by `regionck`.
823 #[derive(PartialEq, Clone, Debug, Copy, RustcEncodable, RustcDecodable, HashStable)]
824 pub enum UpvarCapture<'tcx> {
825 /// Upvar is captured by value. This is always true when the
826 /// closure is labeled `move`, but can also be true in other cases
827 /// depending on inference.
830 /// Upvar is captured by reference.
831 ByRef(UpvarBorrow<'tcx>),
834 #[derive(PartialEq, Clone, Copy, RustcEncodable, RustcDecodable, HashStable)]
835 pub struct UpvarBorrow<'tcx> {
836 /// The kind of borrow: by-ref upvars have access to shared
837 /// immutable borrows, which are not part of the normal language
839 pub kind: BorrowKind,
841 /// Region of the resulting reference.
842 pub region: ty::Region<'tcx>,
845 pub type UpvarListMap = FxHashMap<DefId, FxIndexMap<hir::HirId, UpvarId>>;
846 pub type UpvarCaptureMap<'tcx> = FxHashMap<UpvarId, UpvarCapture<'tcx>>;
848 #[derive(Copy, Clone, TypeFoldable)]
849 pub struct ClosureUpvar<'tcx> {
855 #[derive(Clone, Copy, PartialEq, Eq)]
856 pub enum IntVarValue {
858 UintType(ast::UintTy),
861 #[derive(Clone, Copy, PartialEq, Eq)]
862 pub struct FloatVarValue(pub ast::FloatTy);
864 impl ty::EarlyBoundRegion {
865 pub fn to_bound_region(&self) -> ty::BoundRegion {
866 ty::BoundRegion::BrNamed(self.def_id, self.name)
869 /// Does this early bound region have a name? Early bound regions normally
870 /// always have names except when using anonymous lifetimes (`'_`).
871 pub fn has_name(&self) -> bool {
872 self.name != kw::UnderscoreLifetime
876 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
877 pub enum GenericParamDefKind {
881 object_lifetime_default: ObjectLifetimeDefault,
882 synthetic: Option<hir::SyntheticTyParamKind>,
887 #[derive(Clone, RustcEncodable, RustcDecodable, HashStable)]
888 pub struct GenericParamDef {
893 /// `pure_wrt_drop`, set by the (unsafe) `#[may_dangle]` attribute
894 /// on generic parameter `'a`/`T`, asserts data behind the parameter
895 /// `'a`/`T` won't be accessed during the parent type's `Drop` impl.
896 pub pure_wrt_drop: bool,
898 pub kind: GenericParamDefKind,
901 impl GenericParamDef {
902 pub fn to_early_bound_region_data(&self) -> ty::EarlyBoundRegion {
903 if let GenericParamDefKind::Lifetime = self.kind {
904 ty::EarlyBoundRegion {
910 bug!("cannot convert a non-lifetime parameter def to an early bound region")
914 pub fn to_bound_region(&self) -> ty::BoundRegion {
915 if let GenericParamDefKind::Lifetime = self.kind {
916 self.to_early_bound_region_data().to_bound_region()
918 bug!("cannot convert a non-lifetime parameter def to an early bound region")
924 pub struct GenericParamCount {
925 pub lifetimes: usize,
930 /// Information about the formal type/lifetime parameters associated
931 /// with an item or method. Analogous to `hir::Generics`.
933 /// The ordering of parameters is the same as in `Subst` (excluding child generics):
934 /// `Self` (optionally), `Lifetime` params..., `Type` params...
935 #[derive(Clone, Debug, RustcEncodable, RustcDecodable, HashStable)]
936 pub struct Generics {
937 pub parent: Option<DefId>,
938 pub parent_count: usize,
939 pub params: Vec<GenericParamDef>,
941 /// Reverse map to the `index` field of each `GenericParamDef`.
942 #[stable_hasher(ignore)]
943 pub param_def_id_to_index: FxHashMap<DefId, u32>,
946 pub has_late_bound_regions: Option<Span>,
949 impl<'tcx> Generics {
950 pub fn count(&self) -> usize {
951 self.parent_count + self.params.len()
954 pub fn own_counts(&self) -> GenericParamCount {
955 // We could cache this as a property of `GenericParamCount`, but
956 // the aim is to refactor this away entirely eventually and the
957 // presence of this method will be a constant reminder.
958 let mut own_counts: GenericParamCount = Default::default();
960 for param in &self.params {
962 GenericParamDefKind::Lifetime => own_counts.lifetimes += 1,
963 GenericParamDefKind::Type { .. } => own_counts.types += 1,
964 GenericParamDefKind::Const => own_counts.consts += 1,
971 pub fn requires_monomorphization(&self, tcx: TyCtxt<'tcx>) -> bool {
972 if self.own_requires_monomorphization() {
976 if let Some(parent_def_id) = self.parent {
977 let parent = tcx.generics_of(parent_def_id);
978 parent.requires_monomorphization(tcx)
984 pub fn own_requires_monomorphization(&self) -> bool {
985 for param in &self.params {
987 GenericParamDefKind::Type { .. } | GenericParamDefKind::Const => return true,
988 GenericParamDefKind::Lifetime => {}
996 param: &EarlyBoundRegion,
998 ) -> &'tcx GenericParamDef {
999 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
1000 let param = &self.params[index as usize];
1002 GenericParamDefKind::Lifetime => param,
1003 _ => bug!("expected lifetime parameter, but found another generic parameter")
1006 tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
1007 .region_param(param, tcx)
1011 /// Returns the `GenericParamDef` associated with this `ParamTy`.
1012 pub fn type_param(&'tcx self, param: &ParamTy, tcx: TyCtxt<'tcx>) -> &'tcx GenericParamDef {
1013 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
1014 let param = &self.params[index as usize];
1016 GenericParamDefKind::Type { .. } => param,
1017 _ => bug!("expected type parameter, but found another generic parameter")
1020 tcx.generics_of(self.parent.expect("parent_count > 0 but no parent?"))
1021 .type_param(param, tcx)
1025 /// Returns the `ConstParameterDef` associated with this `ParamConst`.
1026 pub fn const_param(&'tcx self, param: &ParamConst, tcx: TyCtxt<'tcx>) -> &GenericParamDef {
1027 if let Some(index) = param.index.checked_sub(self.parent_count as u32) {
1028 let param = &self.params[index as usize];
1030 GenericParamDefKind::Const => param,
1031 _ => bug!("expected const parameter, but found another generic parameter")
1034 tcx.generics_of(self.parent.expect("parent_count>0 but no parent?"))
1035 .const_param(param, tcx)
1040 /// Bounds on generics.
1041 #[derive(Copy, Clone, Default, Debug, RustcEncodable, RustcDecodable, HashStable)]
1042 pub struct GenericPredicates<'tcx> {
1043 pub parent: Option<DefId>,
1044 pub predicates: &'tcx [(Predicate<'tcx>, Span)],
1047 impl<'tcx> GenericPredicates<'tcx> {
1051 substs: SubstsRef<'tcx>,
1052 ) -> InstantiatedPredicates<'tcx> {
1053 let mut instantiated = InstantiatedPredicates::empty();
1054 self.instantiate_into(tcx, &mut instantiated, substs);
1058 pub fn instantiate_own(
1061 substs: SubstsRef<'tcx>,
1062 ) -> InstantiatedPredicates<'tcx> {
1063 InstantiatedPredicates {
1064 predicates: self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)).collect(),
1068 fn instantiate_into(
1071 instantiated: &mut InstantiatedPredicates<'tcx>,
1072 substs: SubstsRef<'tcx>,
1074 if let Some(def_id) = self.parent {
1075 tcx.predicates_of(def_id).instantiate_into(tcx, instantiated, substs);
1077 instantiated.predicates.extend(
1078 self.predicates.iter().map(|(p, _)| p.subst(tcx, substs)),
1082 pub fn instantiate_identity(&self, tcx: TyCtxt<'tcx>) -> InstantiatedPredicates<'tcx> {
1083 let mut instantiated = InstantiatedPredicates::empty();
1084 self.instantiate_identity_into(tcx, &mut instantiated);
1088 fn instantiate_identity_into(
1091 instantiated: &mut InstantiatedPredicates<'tcx>,
1093 if let Some(def_id) = self.parent {
1094 tcx.predicates_of(def_id).instantiate_identity_into(tcx, instantiated);
1096 instantiated.predicates.extend(self.predicates.iter().map(|&(p, _)| p))
1099 pub fn instantiate_supertrait(
1102 poly_trait_ref: &ty::PolyTraitRef<'tcx>,
1103 ) -> InstantiatedPredicates<'tcx> {
1104 assert_eq!(self.parent, None);
1105 InstantiatedPredicates {
1106 predicates: self.predicates.iter().map(|(pred, _)| {
1107 pred.subst_supertrait(tcx, poly_trait_ref)
1113 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1114 #[derive(HashStable, TypeFoldable)]
1115 pub enum Predicate<'tcx> {
1116 /// Corresponds to `where Foo: Bar<A, B, C>`. `Foo` here would be
1117 /// the `Self` type of the trait reference and `A`, `B`, and `C`
1118 /// would be the type parameters.
1119 Trait(PolyTraitPredicate<'tcx>),
1122 RegionOutlives(PolyRegionOutlivesPredicate<'tcx>),
1125 TypeOutlives(PolyTypeOutlivesPredicate<'tcx>),
1127 /// `where <T as TraitRef>::Name == X`, approximately.
1128 /// See the `ProjectionPredicate` struct for details.
1129 Projection(PolyProjectionPredicate<'tcx>),
1131 /// No syntax: `T` well-formed.
1132 WellFormed(Ty<'tcx>),
1134 /// Trait must be object-safe.
1137 /// No direct syntax. May be thought of as `where T: FnFoo<...>`
1138 /// for some substitutions `...` and `T` being a closure type.
1139 /// Satisfied (or refuted) once we know the closure's kind.
1140 ClosureKind(DefId, SubstsRef<'tcx>, ClosureKind),
1143 Subtype(PolySubtypePredicate<'tcx>),
1145 /// Constant initializer must evaluate successfully.
1146 ConstEvaluatable(DefId, SubstsRef<'tcx>),
1149 /// The crate outlives map is computed during typeck and contains the
1150 /// outlives of every item in the local crate. You should not use it
1151 /// directly, because to do so will make your pass dependent on the
1152 /// HIR of every item in the local crate. Instead, use
1153 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
1155 #[derive(HashStable)]
1156 pub struct CratePredicatesMap<'tcx> {
1157 /// For each struct with outlive bounds, maps to a vector of the
1158 /// predicate of its outlive bounds. If an item has no outlives
1159 /// bounds, it will have no entry.
1160 pub predicates: FxHashMap<DefId, &'tcx [(ty::Predicate<'tcx>, Span)]>,
1163 impl<'tcx> AsRef<Predicate<'tcx>> for Predicate<'tcx> {
1164 fn as_ref(&self) -> &Predicate<'tcx> {
1169 impl<'tcx> Predicate<'tcx> {
1170 /// Performs a substitution suitable for going from a
1171 /// poly-trait-ref to supertraits that must hold if that
1172 /// poly-trait-ref holds. This is slightly different from a normal
1173 /// substitution in terms of what happens with bound regions. See
1174 /// lengthy comment below for details.
1175 pub fn subst_supertrait(
1178 trait_ref: &ty::PolyTraitRef<'tcx>,
1179 ) -> ty::Predicate<'tcx> {
1180 // The interaction between HRTB and supertraits is not entirely
1181 // obvious. Let me walk you (and myself) through an example.
1183 // Let's start with an easy case. Consider two traits:
1185 // trait Foo<'a>: Bar<'a,'a> { }
1186 // trait Bar<'b,'c> { }
1188 // Now, if we have a trait reference `for<'x> T: Foo<'x>`, then
1189 // we can deduce that `for<'x> T: Bar<'x,'x>`. Basically, if we
1190 // knew that `Foo<'x>` (for any 'x) then we also know that
1191 // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
1192 // normal substitution.
1194 // In terms of why this is sound, the idea is that whenever there
1195 // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
1196 // holds. So if there is an impl of `T:Foo<'a>` that applies to
1197 // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
1200 // Another example to be careful of is this:
1202 // trait Foo1<'a>: for<'b> Bar1<'a,'b> { }
1203 // trait Bar1<'b,'c> { }
1205 // Here, if we have `for<'x> T: Foo1<'x>`, then what do we know?
1206 // The answer is that we know `for<'x,'b> T: Bar1<'x,'b>`. The
1207 // reason is similar to the previous example: any impl of
1208 // `T:Foo1<'x>` must show that `for<'b> T: Bar1<'x, 'b>`. So
1209 // basically we would want to collapse the bound lifetimes from
1210 // the input (`trait_ref`) and the supertraits.
1212 // To achieve this in practice is fairly straightforward. Let's
1213 // consider the more complicated scenario:
1215 // - We start out with `for<'x> T: Foo1<'x>`. In this case, `'x`
1216 // has a De Bruijn index of 1. We want to produce `for<'x,'b> T: Bar1<'x,'b>`,
1217 // where both `'x` and `'b` would have a DB index of 1.
1218 // The substitution from the input trait-ref is therefore going to be
1219 // `'a => 'x` (where `'x` has a DB index of 1).
1220 // - The super-trait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
1221 // early-bound parameter and `'b' is a late-bound parameter with a
1223 // - If we replace `'a` with `'x` from the input, it too will have
1224 // a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
1225 // just as we wanted.
1227 // There is only one catch. If we just apply the substitution `'a
1228 // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
1229 // adjust the DB index because we substituting into a binder (it
1230 // tries to be so smart...) resulting in `for<'x> for<'b>
1231 // Bar1<'x,'b>` (we have no syntax for this, so use your
1232 // imagination). Basically the 'x will have DB index of 2 and 'b
1233 // will have DB index of 1. Not quite what we want. So we apply
1234 // the substitution to the *contents* of the trait reference,
1235 // rather than the trait reference itself (put another way, the
1236 // substitution code expects equal binding levels in the values
1237 // from the substitution and the value being substituted into, and
1238 // this trick achieves that).
1240 let substs = &trait_ref.skip_binder().substs;
1242 Predicate::Trait(ref binder) =>
1243 Predicate::Trait(binder.map_bound(|data| data.subst(tcx, substs))),
1244 Predicate::Subtype(ref binder) =>
1245 Predicate::Subtype(binder.map_bound(|data| data.subst(tcx, substs))),
1246 Predicate::RegionOutlives(ref binder) =>
1247 Predicate::RegionOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1248 Predicate::TypeOutlives(ref binder) =>
1249 Predicate::TypeOutlives(binder.map_bound(|data| data.subst(tcx, substs))),
1250 Predicate::Projection(ref binder) =>
1251 Predicate::Projection(binder.map_bound(|data| data.subst(tcx, substs))),
1252 Predicate::WellFormed(data) =>
1253 Predicate::WellFormed(data.subst(tcx, substs)),
1254 Predicate::ObjectSafe(trait_def_id) =>
1255 Predicate::ObjectSafe(trait_def_id),
1256 Predicate::ClosureKind(closure_def_id, closure_substs, kind) =>
1257 Predicate::ClosureKind(closure_def_id, closure_substs.subst(tcx, substs), kind),
1258 Predicate::ConstEvaluatable(def_id, const_substs) =>
1259 Predicate::ConstEvaluatable(def_id, const_substs.subst(tcx, substs)),
1264 #[derive(Clone, Copy, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1265 #[derive(HashStable, TypeFoldable)]
1266 pub struct TraitPredicate<'tcx> {
1267 pub trait_ref: TraitRef<'tcx>
1270 pub type PolyTraitPredicate<'tcx> = ty::Binder<TraitPredicate<'tcx>>;
1272 impl<'tcx> TraitPredicate<'tcx> {
1273 pub fn def_id(&self) -> DefId {
1274 self.trait_ref.def_id
1277 pub fn input_types<'a>(&'a self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> + 'a {
1278 self.trait_ref.input_types()
1281 pub fn self_ty(&self) -> Ty<'tcx> {
1282 self.trait_ref.self_ty()
1286 impl<'tcx> PolyTraitPredicate<'tcx> {
1287 pub fn def_id(&self) -> DefId {
1288 // Ok to skip binder since trait `DefId` does not care about regions.
1289 self.skip_binder().def_id()
1293 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, RustcEncodable, RustcDecodable)]
1294 #[derive(HashStable, TypeFoldable)]
1295 pub struct OutlivesPredicate<A, B>(pub A, pub B); // `A: B`
1296 pub type PolyOutlivesPredicate<A, B> = ty::Binder<OutlivesPredicate<A, B>>;
1297 pub type RegionOutlivesPredicate<'tcx> = OutlivesPredicate<ty::Region<'tcx>, ty::Region<'tcx>>;
1298 pub type TypeOutlivesPredicate<'tcx> = OutlivesPredicate<Ty<'tcx>, ty::Region<'tcx>>;
1299 pub type PolyRegionOutlivesPredicate<'tcx> = ty::Binder<RegionOutlivesPredicate<'tcx>>;
1300 pub type PolyTypeOutlivesPredicate<'tcx> = ty::Binder<TypeOutlivesPredicate<'tcx>>;
1302 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, RustcEncodable, RustcDecodable)]
1303 #[derive(HashStable, TypeFoldable)]
1304 pub struct SubtypePredicate<'tcx> {
1305 pub a_is_expected: bool,
1309 pub type PolySubtypePredicate<'tcx> = ty::Binder<SubtypePredicate<'tcx>>;
1311 /// This kind of predicate has no *direct* correspondent in the
1312 /// syntax, but it roughly corresponds to the syntactic forms:
1314 /// 1. `T: TraitRef<..., Item = Type>`
1315 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
1317 /// In particular, form #1 is "desugared" to the combination of a
1318 /// normal trait predicate (`T: TraitRef<...>`) and one of these
1319 /// predicates. Form #2 is a broader form in that it also permits
1320 /// equality between arbitrary types. Processing an instance of
1321 /// Form #2 eventually yields one of these `ProjectionPredicate`
1322 /// instances to normalize the LHS.
1323 #[derive(Copy, Clone, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable)]
1324 #[derive(HashStable, TypeFoldable)]
1325 pub struct ProjectionPredicate<'tcx> {
1326 pub projection_ty: ProjectionTy<'tcx>,
1330 pub type PolyProjectionPredicate<'tcx> = Binder<ProjectionPredicate<'tcx>>;
1332 impl<'tcx> PolyProjectionPredicate<'tcx> {
1333 /// Returns the `DefId` of the associated item being projected.
1334 pub fn item_def_id(&self) -> DefId {
1335 self.skip_binder().projection_ty.item_def_id
1339 pub fn to_poly_trait_ref(&self, tcx: TyCtxt<'_>) -> PolyTraitRef<'tcx> {
1340 // Note: unlike with `TraitRef::to_poly_trait_ref()`,
1341 // `self.0.trait_ref` is permitted to have escaping regions.
1342 // This is because here `self` has a `Binder` and so does our
1343 // return value, so we are preserving the number of binding
1345 self.map_bound(|predicate| predicate.projection_ty.trait_ref(tcx))
1348 pub fn ty(&self) -> Binder<Ty<'tcx>> {
1349 self.map_bound(|predicate| predicate.ty)
1352 /// The `DefId` of the `TraitItem` for the associated type.
1354 /// Note that this is not the `DefId` of the `TraitRef` containing this
1355 /// associated type, which is in `tcx.associated_item(projection_def_id()).container`.
1356 pub fn projection_def_id(&self) -> DefId {
1357 // Ok to skip binder since trait `DefId` does not care about regions.
1358 self.skip_binder().projection_ty.item_def_id
1362 pub trait ToPolyTraitRef<'tcx> {
1363 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx>;
1366 impl<'tcx> ToPolyTraitRef<'tcx> for TraitRef<'tcx> {
1367 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1368 ty::Binder::dummy(self.clone())
1372 impl<'tcx> ToPolyTraitRef<'tcx> for PolyTraitPredicate<'tcx> {
1373 fn to_poly_trait_ref(&self) -> PolyTraitRef<'tcx> {
1374 self.map_bound_ref(|trait_pred| trait_pred.trait_ref)
1378 pub trait ToPredicate<'tcx> {
1379 fn to_predicate(&self) -> Predicate<'tcx>;
1382 impl<'tcx> ToPredicate<'tcx> for TraitRef<'tcx> {
1383 fn to_predicate(&self) -> Predicate<'tcx> {
1384 ty::Predicate::Trait(ty::Binder::dummy(ty::TraitPredicate {
1385 trait_ref: self.clone()
1390 impl<'tcx> ToPredicate<'tcx> for PolyTraitRef<'tcx> {
1391 fn to_predicate(&self) -> Predicate<'tcx> {
1392 ty::Predicate::Trait(self.to_poly_trait_predicate())
1396 impl<'tcx> ToPredicate<'tcx> for PolyRegionOutlivesPredicate<'tcx> {
1397 fn to_predicate(&self) -> Predicate<'tcx> {
1398 Predicate::RegionOutlives(self.clone())
1402 impl<'tcx> ToPredicate<'tcx> for PolyTypeOutlivesPredicate<'tcx> {
1403 fn to_predicate(&self) -> Predicate<'tcx> {
1404 Predicate::TypeOutlives(self.clone())
1408 impl<'tcx> ToPredicate<'tcx> for PolyProjectionPredicate<'tcx> {
1409 fn to_predicate(&self) -> Predicate<'tcx> {
1410 Predicate::Projection(self.clone())
1414 // A custom iterator used by `Predicate::walk_tys`.
1415 enum WalkTysIter<'tcx, I, J, K>
1416 where I: Iterator<Item = Ty<'tcx>>,
1417 J: Iterator<Item = Ty<'tcx>>,
1418 K: Iterator<Item = Ty<'tcx>>
1422 Two(Ty<'tcx>, Ty<'tcx>),
1428 impl<'tcx, I, J, K> Iterator for WalkTysIter<'tcx, I, J, K>
1429 where I: Iterator<Item = Ty<'tcx>>,
1430 J: Iterator<Item = Ty<'tcx>>,
1431 K: Iterator<Item = Ty<'tcx>>
1433 type Item = Ty<'tcx>;
1435 fn next(&mut self) -> Option<Ty<'tcx>> {
1437 WalkTysIter::None => None,
1438 WalkTysIter::One(item) => {
1439 *self = WalkTysIter::None;
1442 WalkTysIter::Two(item1, item2) => {
1443 *self = WalkTysIter::One(item2);
1446 WalkTysIter::Types(ref mut iter) => {
1449 WalkTysIter::InputTypes(ref mut iter) => {
1452 WalkTysIter::ProjectionTypes(ref mut iter) => {
1459 impl<'tcx> Predicate<'tcx> {
1460 /// Iterates over the types in this predicate. Note that in all
1461 /// cases this is skipping over a binder, so late-bound regions
1462 /// with depth 0 are bound by the predicate.
1463 pub fn walk_tys(&'a self) -> impl Iterator<Item = Ty<'tcx>> + 'a {
1465 ty::Predicate::Trait(ref data) => {
1466 WalkTysIter::InputTypes(data.skip_binder().input_types())
1468 ty::Predicate::Subtype(binder) => {
1469 let SubtypePredicate { a, b, a_is_expected: _ } = binder.skip_binder();
1470 WalkTysIter::Two(a, b)
1472 ty::Predicate::TypeOutlives(binder) => {
1473 WalkTysIter::One(binder.skip_binder().0)
1475 ty::Predicate::RegionOutlives(..) => {
1478 ty::Predicate::Projection(ref data) => {
1479 let inner = data.skip_binder();
1480 WalkTysIter::ProjectionTypes(
1481 inner.projection_ty.substs.types().chain(Some(inner.ty)))
1483 ty::Predicate::WellFormed(data) => {
1484 WalkTysIter::One(data)
1486 ty::Predicate::ObjectSafe(_trait_def_id) => {
1489 ty::Predicate::ClosureKind(_closure_def_id, closure_substs, _kind) => {
1490 WalkTysIter::Types(closure_substs.types())
1492 ty::Predicate::ConstEvaluatable(_, substs) => {
1493 WalkTysIter::Types(substs.types())
1498 pub fn to_opt_poly_trait_ref(&self) -> Option<PolyTraitRef<'tcx>> {
1500 Predicate::Trait(ref t) => {
1501 Some(t.to_poly_trait_ref())
1503 Predicate::Projection(..) |
1504 Predicate::Subtype(..) |
1505 Predicate::RegionOutlives(..) |
1506 Predicate::WellFormed(..) |
1507 Predicate::ObjectSafe(..) |
1508 Predicate::ClosureKind(..) |
1509 Predicate::TypeOutlives(..) |
1510 Predicate::ConstEvaluatable(..) => {
1516 pub fn to_opt_type_outlives(&self) -> Option<PolyTypeOutlivesPredicate<'tcx>> {
1518 Predicate::TypeOutlives(data) => {
1521 Predicate::Trait(..) |
1522 Predicate::Projection(..) |
1523 Predicate::Subtype(..) |
1524 Predicate::RegionOutlives(..) |
1525 Predicate::WellFormed(..) |
1526 Predicate::ObjectSafe(..) |
1527 Predicate::ClosureKind(..) |
1528 Predicate::ConstEvaluatable(..) => {
1535 /// Represents the bounds declared on a particular set of type
1536 /// parameters. Should eventually be generalized into a flag list of
1537 /// where-clauses. You can obtain a `InstantiatedPredicates` list from a
1538 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1539 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1540 /// the `GenericPredicates` are expressed in terms of the bound type
1541 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1542 /// represented a set of bounds for some particular instantiation,
1543 /// meaning that the generic parameters have been substituted with
1548 /// struct Foo<T, U: Bar<T>> { ... }
1550 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1551 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1552 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1553 /// [usize:Bar<isize>]]`.
1554 #[derive(Clone, Debug, TypeFoldable)]
1555 pub struct InstantiatedPredicates<'tcx> {
1556 pub predicates: Vec<Predicate<'tcx>>,
1559 impl<'tcx> InstantiatedPredicates<'tcx> {
1560 pub fn empty() -> InstantiatedPredicates<'tcx> {
1561 InstantiatedPredicates { predicates: vec![] }
1564 pub fn is_empty(&self) -> bool {
1565 self.predicates.is_empty()
1569 rustc_index::newtype_index! {
1570 /// "Universes" are used during type- and trait-checking in the
1571 /// presence of `for<..>` binders to control what sets of names are
1572 /// visible. Universes are arranged into a tree: the root universe
1573 /// contains names that are always visible. Each child then adds a new
1574 /// set of names that are visible, in addition to those of its parent.
1575 /// We say that the child universe "extends" the parent universe with
1578 /// To make this more concrete, consider this program:
1582 /// fn bar<T>(x: T) {
1583 /// let y: for<'a> fn(&'a u8, Foo) = ...;
1587 /// The struct name `Foo` is in the root universe U0. But the type
1588 /// parameter `T`, introduced on `bar`, is in an extended universe U1
1589 /// -- i.e., within `bar`, we can name both `T` and `Foo`, but outside
1590 /// of `bar`, we cannot name `T`. Then, within the type of `y`, the
1591 /// region `'a` is in a universe U2 that extends U1, because we can
1592 /// name it inside the fn type but not outside.
1594 /// Universes are used to do type- and trait-checking around these
1595 /// "forall" binders (also called **universal quantification**). The
1596 /// idea is that when, in the body of `bar`, we refer to `T` as a
1597 /// type, we aren't referring to any type in particular, but rather a
1598 /// kind of "fresh" type that is distinct from all other types we have
1599 /// actually declared. This is called a **placeholder** type, and we
1600 /// use universes to talk about this. In other words, a type name in
1601 /// universe 0 always corresponds to some "ground" type that the user
1602 /// declared, but a type name in a non-zero universe is a placeholder
1603 /// type -- an idealized representative of "types in general" that we
1604 /// use for checking generic functions.
1605 pub struct UniverseIndex {
1606 DEBUG_FORMAT = "U{}",
1610 impl_stable_hash_for!(struct UniverseIndex { private });
1612 impl UniverseIndex {
1613 pub const ROOT: UniverseIndex = UniverseIndex::from_u32_const(0);
1615 /// Returns the "next" universe index in order -- this new index
1616 /// is considered to extend all previous universes. This
1617 /// corresponds to entering a `forall` quantifier. So, for
1618 /// example, suppose we have this type in universe `U`:
1621 /// for<'a> fn(&'a u32)
1624 /// Once we "enter" into this `for<'a>` quantifier, we are in a
1625 /// new universe that extends `U` -- in this new universe, we can
1626 /// name the region `'a`, but that region was not nameable from
1627 /// `U` because it was not in scope there.
1628 pub fn next_universe(self) -> UniverseIndex {
1629 UniverseIndex::from_u32(self.private.checked_add(1).unwrap())
1632 /// Returns `true` if `self` can name a name from `other` -- in other words,
1633 /// if the set of names in `self` is a superset of those in
1634 /// `other` (`self >= other`).
1635 pub fn can_name(self, other: UniverseIndex) -> bool {
1636 self.private >= other.private
1639 /// Returns `true` if `self` cannot name some names from `other` -- in other
1640 /// words, if the set of names in `self` is a strict subset of
1641 /// those in `other` (`self < other`).
1642 pub fn cannot_name(self, other: UniverseIndex) -> bool {
1643 self.private < other.private
1647 /// The "placeholder index" fully defines a placeholder region.
1648 /// Placeholder regions are identified by both a **universe** as well
1649 /// as a "bound-region" within that universe. The `bound_region` is
1650 /// basically a name -- distinct bound regions within the same
1651 /// universe are just two regions with an unknown relationship to one
1653 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, RustcEncodable, RustcDecodable, PartialOrd, Ord)]
1654 pub struct Placeholder<T> {
1655 pub universe: UniverseIndex,
1659 impl<'a, T> HashStable<StableHashingContext<'a>> for Placeholder<T>
1661 T: HashStable<StableHashingContext<'a>>,
1663 fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1664 self.universe.hash_stable(hcx, hasher);
1665 self.name.hash_stable(hcx, hasher);
1669 pub type PlaceholderRegion = Placeholder<BoundRegion>;
1671 pub type PlaceholderType = Placeholder<BoundVar>;
1673 pub type PlaceholderConst = Placeholder<BoundVar>;
1675 /// When type checking, we use the `ParamEnv` to track
1676 /// details about the set of where-clauses that are in scope at this
1677 /// particular point.
1678 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable, TypeFoldable)]
1679 pub struct ParamEnv<'tcx> {
1680 /// `Obligation`s that the caller must satisfy. This is basically
1681 /// the set of bounds on the in-scope type parameters, translated
1682 /// into `Obligation`s, and elaborated and normalized.
1683 pub caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1685 /// Typically, this is `Reveal::UserFacing`, but during codegen we
1686 /// want `Reveal::All` -- note that this is always paired with an
1687 /// empty environment. To get that, use `ParamEnv::reveal()`.
1688 pub reveal: traits::Reveal,
1690 /// If this `ParamEnv` comes from a call to `tcx.param_env(def_id)`,
1691 /// register that `def_id` (useful for transitioning to the chalk trait
1693 pub def_id: Option<DefId>,
1696 impl<'tcx> ParamEnv<'tcx> {
1697 /// Construct a trait environment suitable for contexts where
1698 /// there are no where-clauses in scope. Hidden types (like `impl
1699 /// Trait`) are left hidden, so this is suitable for ordinary
1702 pub fn empty() -> Self {
1703 Self::new(List::empty(), Reveal::UserFacing, None)
1706 /// Construct a trait environment with no where-clauses in scope
1707 /// where the values of all `impl Trait` and other hidden types
1708 /// are revealed. This is suitable for monomorphized, post-typeck
1709 /// environments like codegen or doing optimizations.
1711 /// N.B., if you want to have predicates in scope, use `ParamEnv::new`,
1712 /// or invoke `param_env.with_reveal_all()`.
1714 pub fn reveal_all() -> Self {
1715 Self::new(List::empty(), Reveal::All, None)
1718 /// Construct a trait environment with the given set of predicates.
1721 caller_bounds: &'tcx List<ty::Predicate<'tcx>>,
1723 def_id: Option<DefId>
1725 ty::ParamEnv { caller_bounds, reveal, def_id }
1728 /// Returns a new parameter environment with the same clauses, but
1729 /// which "reveals" the true results of projections in all cases
1730 /// (even for associated types that are specializable). This is
1731 /// the desired behavior during codegen and certain other special
1732 /// contexts; normally though we want to use `Reveal::UserFacing`,
1733 /// which is the default.
1734 pub fn with_reveal_all(self) -> Self {
1735 ty::ParamEnv { reveal: Reveal::All, ..self }
1738 /// Returns this same environment but with no caller bounds.
1739 pub fn without_caller_bounds(self) -> Self {
1740 ty::ParamEnv { caller_bounds: List::empty(), ..self }
1743 /// Creates a suitable environment in which to perform trait
1744 /// queries on the given value. When type-checking, this is simply
1745 /// the pair of the environment plus value. But when reveal is set to
1746 /// All, then if `value` does not reference any type parameters, we will
1747 /// pair it with the empty environment. This improves caching and is generally
1750 /// N.B., we preserve the environment when type-checking because it
1751 /// is possible for the user to have wacky where-clauses like
1752 /// `where Box<u32>: Copy`, which are clearly never
1753 /// satisfiable. We generally want to behave as if they were true,
1754 /// although the surrounding function is never reachable.
1755 pub fn and<T: TypeFoldable<'tcx>>(self, value: T) -> ParamEnvAnd<'tcx, T> {
1757 Reveal::UserFacing => {
1765 if value.has_placeholders()
1766 || value.needs_infer()
1767 || value.has_param_types()
1775 param_env: self.without_caller_bounds(),
1784 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TypeFoldable)]
1785 pub struct ParamEnvAnd<'tcx, T> {
1786 pub param_env: ParamEnv<'tcx>,
1790 impl<'tcx, T> ParamEnvAnd<'tcx, T> {
1791 pub fn into_parts(self) -> (ParamEnv<'tcx>, T) {
1792 (self.param_env, self.value)
1796 impl<'a, 'tcx, T> HashStable<StableHashingContext<'a>> for ParamEnvAnd<'tcx, T>
1798 T: HashStable<StableHashingContext<'a>>,
1800 fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
1806 param_env.hash_stable(hcx, hasher);
1807 value.hash_stable(hcx, hasher);
1811 #[derive(Copy, Clone, Debug, HashStable)]
1812 pub struct Destructor {
1813 /// The `DefId` of the destructor method
1818 #[derive(HashStable)]
1819 pub struct AdtFlags: u32 {
1820 const NO_ADT_FLAGS = 0;
1821 /// Indicates whether the ADT is an enum.
1822 const IS_ENUM = 1 << 0;
1823 /// Indicates whether the ADT is a union.
1824 const IS_UNION = 1 << 1;
1825 /// Indicates whether the ADT is a struct.
1826 const IS_STRUCT = 1 << 2;
1827 /// Indicates whether the ADT is a struct and has a constructor.
1828 const HAS_CTOR = 1 << 3;
1829 /// Indicates whether the type is a `PhantomData`.
1830 const IS_PHANTOM_DATA = 1 << 4;
1831 /// Indicates whether the type has a `#[fundamental]` attribute.
1832 const IS_FUNDAMENTAL = 1 << 5;
1833 /// Indicates whether the type is a `Box`.
1834 const IS_BOX = 1 << 6;
1835 /// Indicates whether the type is an `Arc`.
1836 const IS_ARC = 1 << 7;
1837 /// Indicates whether the type is an `Rc`.
1838 const IS_RC = 1 << 8;
1839 /// Indicates whether the variant list of this ADT is `#[non_exhaustive]`.
1840 /// (i.e., this flag is never set unless this ADT is an enum).
1841 const IS_VARIANT_LIST_NON_EXHAUSTIVE = 1 << 9;
1846 #[derive(HashStable)]
1847 pub struct VariantFlags: u32 {
1848 const NO_VARIANT_FLAGS = 0;
1849 /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
1850 const IS_FIELD_LIST_NON_EXHAUSTIVE = 1 << 0;
1854 /// Definition of a variant -- a struct's fields or a enum variant.
1856 pub struct VariantDef {
1857 /// `DefId` that identifies the variant itself.
1858 /// If this variant belongs to a struct or union, then this is a copy of its `DefId`.
1860 /// `DefId` that identifies the variant's constructor.
1861 /// If this variant is a struct variant, then this is `None`.
1862 pub ctor_def_id: Option<DefId>,
1863 /// Variant or struct name.
1865 /// Discriminant of this variant.
1866 pub discr: VariantDiscr,
1867 /// Fields of this variant.
1868 pub fields: Vec<FieldDef>,
1869 /// Type of constructor of variant.
1870 pub ctor_kind: CtorKind,
1871 /// Flags of the variant (e.g. is field list non-exhaustive)?
1872 flags: VariantFlags,
1873 /// Variant is obtained as part of recovering from a syntactic error.
1874 /// May be incomplete or bogus.
1875 pub recovered: bool,
1878 impl<'tcx> VariantDef {
1879 /// Creates a new `VariantDef`.
1881 /// `variant_did` is the `DefId` that identifies the enum variant (if this `VariantDef`
1882 /// represents an enum variant).
1884 /// `ctor_did` is the `DefId` that identifies the constructor of unit or
1885 /// tuple-variants/structs. If this is a `struct`-variant then this should be `None`.
1887 /// `parent_did` is the `DefId` of the `AdtDef` representing the enum or struct that
1888 /// owns this variant. It is used for checking if a struct has `#[non_exhaustive]` w/out having
1889 /// to go through the redirect of checking the ctor's attributes - but compiling a small crate
1890 /// requires loading the `AdtDef`s for all the structs in the universe (e.g., coherence for any
1891 /// built-in trait), and we do not want to load attributes twice.
1893 /// If someone speeds up attribute loading to not be a performance concern, they can
1894 /// remove this hack and use the constructor `DefId` everywhere.
1898 variant_did: Option<DefId>,
1899 ctor_def_id: Option<DefId>,
1900 discr: VariantDiscr,
1901 fields: Vec<FieldDef>,
1902 ctor_kind: CtorKind,
1908 "VariantDef::new(ident = {:?}, variant_did = {:?}, ctor_def_id = {:?}, discr = {:?},
1909 fields = {:?}, ctor_kind = {:?}, adt_kind = {:?}, parent_did = {:?})",
1910 ident, variant_did, ctor_def_id, discr, fields, ctor_kind, adt_kind, parent_did,
1913 let mut flags = VariantFlags::NO_VARIANT_FLAGS;
1914 if adt_kind == AdtKind::Struct && tcx.has_attr(parent_did, sym::non_exhaustive) {
1915 debug!("found non-exhaustive field list for {:?}", parent_did);
1916 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1917 } else if let Some(variant_did) = variant_did {
1918 if tcx.has_attr(variant_did, sym::non_exhaustive) {
1919 debug!("found non-exhaustive field list for {:?}", variant_did);
1920 flags = flags | VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE;
1925 def_id: variant_did.unwrap_or(parent_did),
1936 /// Is this field list non-exhaustive?
1938 pub fn is_field_list_non_exhaustive(&self) -> bool {
1939 self.flags.intersects(VariantFlags::IS_FIELD_LIST_NON_EXHAUSTIVE)
1943 impl_stable_hash_for!(struct VariantDef {
1946 ident -> (ident.name),
1954 #[derive(Copy, Clone, Debug, PartialEq, Eq, RustcEncodable, RustcDecodable, HashStable)]
1955 pub enum VariantDiscr {
1956 /// Explicit value for this variant, i.e., `X = 123`.
1957 /// The `DefId` corresponds to the embedded constant.
1960 /// The previous variant's discriminant plus one.
1961 /// For efficiency reasons, the distance from the
1962 /// last `Explicit` discriminant is being stored,
1963 /// or `0` for the first variant, if it has none.
1967 #[derive(Debug, HashStable)]
1968 pub struct FieldDef {
1970 #[stable_hasher(project(name))]
1972 pub vis: Visibility,
1975 /// The definition of a user-defined type, e.g., a `struct`, `enum`, or `union`.
1977 /// These are all interned (by `intern_adt_def`) into the `adt_defs` table.
1979 /// The initialism *"Adt"* stands for an [*algebraic data type (ADT)*][adt].
1980 /// This is slightly wrong because `union`s are not ADTs.
1981 /// Moreover, Rust only allows recursive data types through indirection.
1983 /// [adt]: https://en.wikipedia.org/wiki/Algebraic_data_type
1985 /// `DefId` of the struct, enum or union item.
1987 /// Variants of the ADT. If this is a struct or union, then there will be a single variant.
1988 pub variants: IndexVec<self::layout::VariantIdx, VariantDef>,
1989 /// Flags of the ADT (e.g. is this a struct? is this non-exhaustive?)
1991 /// Repr options provided by the user.
1992 pub repr: ReprOptions,
1995 impl PartialOrd for AdtDef {
1996 fn partial_cmp(&self, other: &AdtDef) -> Option<Ordering> {
1997 Some(self.cmp(&other))
2001 /// There should be only one AdtDef for each `did`, therefore
2002 /// it is fine to implement `Ord` only based on `did`.
2003 impl Ord for AdtDef {
2004 fn cmp(&self, other: &AdtDef) -> Ordering {
2005 self.did.cmp(&other.did)
2009 impl PartialEq for AdtDef {
2010 // AdtDef are always interned and this is part of TyS equality
2012 fn eq(&self, other: &Self) -> bool { ptr::eq(self, other) }
2015 impl Eq for AdtDef {}
2017 impl Hash for AdtDef {
2019 fn hash<H: Hasher>(&self, s: &mut H) {
2020 (self as *const AdtDef).hash(s)
2024 impl<'tcx> rustc_serialize::UseSpecializedEncodable for &'tcx AdtDef {
2025 fn default_encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error> {
2030 impl<'tcx> rustc_serialize::UseSpecializedDecodable for &'tcx AdtDef {}
2033 impl<'a> HashStable<StableHashingContext<'a>> for AdtDef {
2034 fn hash_stable(&self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher) {
2036 static CACHE: RefCell<FxHashMap<usize, Fingerprint>> = Default::default();
2039 let hash: Fingerprint = CACHE.with(|cache| {
2040 let addr = self as *const AdtDef as usize;
2041 *cache.borrow_mut().entry(addr).or_insert_with(|| {
2049 let mut hasher = StableHasher::new();
2050 did.hash_stable(hcx, &mut hasher);
2051 variants.hash_stable(hcx, &mut hasher);
2052 flags.hash_stable(hcx, &mut hasher);
2053 repr.hash_stable(hcx, &mut hasher);
2059 hash.hash_stable(hcx, hasher);
2063 #[derive(Copy, Clone, Debug, Eq, PartialEq, Hash)]
2064 pub enum AdtKind { Struct, Union, Enum }
2066 impl Into<DataTypeKind> for AdtKind {
2067 fn into(self) -> DataTypeKind {
2069 AdtKind::Struct => DataTypeKind::Struct,
2070 AdtKind::Union => DataTypeKind::Union,
2071 AdtKind::Enum => DataTypeKind::Enum,
2077 #[derive(RustcEncodable, RustcDecodable, Default)]
2078 pub struct ReprFlags: u8 {
2079 const IS_C = 1 << 0;
2080 const IS_SIMD = 1 << 1;
2081 const IS_TRANSPARENT = 1 << 2;
2082 // Internal only for now. If true, don't reorder fields.
2083 const IS_LINEAR = 1 << 3;
2085 // Any of these flags being set prevent field reordering optimisation.
2086 const IS_UNOPTIMISABLE = ReprFlags::IS_C.bits |
2087 ReprFlags::IS_SIMD.bits |
2088 ReprFlags::IS_LINEAR.bits;
2092 impl_stable_hash_for!(struct ReprFlags {
2096 /// Represents the repr options provided by the user,
2097 #[derive(Copy, Clone, Debug, Eq, PartialEq, RustcEncodable, RustcDecodable, Default)]
2098 pub struct ReprOptions {
2099 pub int: Option<attr::IntType>,
2100 pub align: Option<Align>,
2101 pub pack: Option<Align>,
2102 pub flags: ReprFlags,
2105 impl_stable_hash_for!(struct ReprOptions {
2113 pub fn new(tcx: TyCtxt<'_>, did: DefId) -> ReprOptions {
2114 let mut flags = ReprFlags::empty();
2115 let mut size = None;
2116 let mut max_align: Option<Align> = None;
2117 let mut min_pack: Option<Align> = None;
2118 for attr in tcx.get_attrs(did).iter() {
2119 for r in attr::find_repr_attrs(&tcx.sess.parse_sess, attr) {
2120 flags.insert(match r {
2121 attr::ReprC => ReprFlags::IS_C,
2122 attr::ReprPacked(pack) => {
2123 let pack = Align::from_bytes(pack as u64).unwrap();
2124 min_pack = Some(if let Some(min_pack) = min_pack {
2131 attr::ReprTransparent => ReprFlags::IS_TRANSPARENT,
2132 attr::ReprSimd => ReprFlags::IS_SIMD,
2133 attr::ReprInt(i) => {
2137 attr::ReprAlign(align) => {
2138 max_align = max_align.max(Some(Align::from_bytes(align as u64).unwrap()));
2145 // This is here instead of layout because the choice must make it into metadata.
2146 if !tcx.consider_optimizing(|| format!("Reorder fields of {:?}", tcx.def_path_str(did))) {
2147 flags.insert(ReprFlags::IS_LINEAR);
2149 ReprOptions { int: size, align: max_align, pack: min_pack, flags: flags }
2153 pub fn simd(&self) -> bool { self.flags.contains(ReprFlags::IS_SIMD) }
2155 pub fn c(&self) -> bool { self.flags.contains(ReprFlags::IS_C) }
2157 pub fn packed(&self) -> bool { self.pack.is_some() }
2159 pub fn transparent(&self) -> bool { self.flags.contains(ReprFlags::IS_TRANSPARENT) }
2161 pub fn linear(&self) -> bool { self.flags.contains(ReprFlags::IS_LINEAR) }
2163 pub fn discr_type(&self) -> attr::IntType {
2164 self.int.unwrap_or(attr::SignedInt(ast::IntTy::Isize))
2167 /// Returns `true` if this `#[repr()]` should inhabit "smart enum
2168 /// layout" optimizations, such as representing `Foo<&T>` as a
2170 pub fn inhibit_enum_layout_opt(&self) -> bool {
2171 self.c() || self.int.is_some()
2174 /// Returns `true` if this `#[repr()]` should inhibit struct field reordering
2175 /// optimizations, such as with `repr(C)`, `repr(packed(1))`, or `repr(<int>)`.
2176 pub fn inhibit_struct_field_reordering_opt(&self) -> bool {
2177 if let Some(pack) = self.pack {
2178 if pack.bytes() == 1 {
2182 self.flags.intersects(ReprFlags::IS_UNOPTIMISABLE) || self.int.is_some()
2185 /// Returns `true` if this `#[repr()]` should inhibit union ABI optimisations.
2186 pub fn inhibit_union_abi_opt(&self) -> bool {
2192 /// Creates a new `AdtDef`.
2197 variants: IndexVec<VariantIdx, VariantDef>,
2200 debug!("AdtDef::new({:?}, {:?}, {:?}, {:?})", did, kind, variants, repr);
2201 let mut flags = AdtFlags::NO_ADT_FLAGS;
2203 if kind == AdtKind::Enum && tcx.has_attr(did, sym::non_exhaustive) {
2204 debug!("found non-exhaustive variant list for {:?}", did);
2205 flags = flags | AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE;
2208 flags |= match kind {
2209 AdtKind::Enum => AdtFlags::IS_ENUM,
2210 AdtKind::Union => AdtFlags::IS_UNION,
2211 AdtKind::Struct => AdtFlags::IS_STRUCT,
2214 if kind == AdtKind::Struct && variants[VariantIdx::new(0)].ctor_def_id.is_some() {
2215 flags |= AdtFlags::HAS_CTOR;
2218 let attrs = tcx.get_attrs(did);
2219 if attr::contains_name(&attrs, sym::fundamental) {
2220 flags |= AdtFlags::IS_FUNDAMENTAL;
2222 if Some(did) == tcx.lang_items().phantom_data() {
2223 flags |= AdtFlags::IS_PHANTOM_DATA;
2225 if Some(did) == tcx.lang_items().owned_box() {
2226 flags |= AdtFlags::IS_BOX;
2228 if Some(did) == tcx.lang_items().arc() {
2229 flags |= AdtFlags::IS_ARC;
2231 if Some(did) == tcx.lang_items().rc() {
2232 flags |= AdtFlags::IS_RC;
2243 /// Returns `true` if this is a struct.
2245 pub fn is_struct(&self) -> bool {
2246 self.flags.contains(AdtFlags::IS_STRUCT)
2249 /// Returns `true` if this is a union.
2251 pub fn is_union(&self) -> bool {
2252 self.flags.contains(AdtFlags::IS_UNION)
2255 /// Returns `true` if this is a enum.
2257 pub fn is_enum(&self) -> bool {
2258 self.flags.contains(AdtFlags::IS_ENUM)
2261 /// Returns `true` if the variant list of this ADT is `#[non_exhaustive]`.
2263 pub fn is_variant_list_non_exhaustive(&self) -> bool {
2264 self.flags.contains(AdtFlags::IS_VARIANT_LIST_NON_EXHAUSTIVE)
2267 /// Returns the kind of the ADT.
2269 pub fn adt_kind(&self) -> AdtKind {
2272 } else if self.is_union() {
2279 /// Returns a description of this abstract data type.
2280 pub fn descr(&self) -> &'static str {
2281 match self.adt_kind() {
2282 AdtKind::Struct => "struct",
2283 AdtKind::Union => "union",
2284 AdtKind::Enum => "enum",
2288 /// Returns a description of a variant of this abstract data type.
2290 pub fn variant_descr(&self) -> &'static str {
2291 match self.adt_kind() {
2292 AdtKind::Struct => "struct",
2293 AdtKind::Union => "union",
2294 AdtKind::Enum => "variant",
2298 /// If this function returns `true`, it implies that `is_struct` must return `true`.
2300 pub fn has_ctor(&self) -> bool {
2301 self.flags.contains(AdtFlags::HAS_CTOR)
2304 /// Returns `true` if this type is `#[fundamental]` for the purposes
2305 /// of coherence checking.
2307 pub fn is_fundamental(&self) -> bool {
2308 self.flags.contains(AdtFlags::IS_FUNDAMENTAL)
2311 /// Returns `true` if this is `PhantomData<T>`.
2313 pub fn is_phantom_data(&self) -> bool {
2314 self.flags.contains(AdtFlags::IS_PHANTOM_DATA)
2317 /// Returns `true` if this is `Arc<T>`.
2318 pub fn is_arc(&self) -> bool {
2319 self.flags.contains(AdtFlags::IS_ARC)
2322 /// Returns `true` if this is `Rc<T>`.
2323 pub fn is_rc(&self) -> bool {
2324 self.flags.contains(AdtFlags::IS_RC)
2327 /// Returns `true` if this is Box<T>.
2329 pub fn is_box(&self) -> bool {
2330 self.flags.contains(AdtFlags::IS_BOX)
2333 /// Returns `true` if this type has a destructor.
2334 pub fn has_dtor(&self, tcx: TyCtxt<'tcx>) -> bool {
2335 self.destructor(tcx).is_some()
2338 /// Asserts this is a struct or union and returns its unique variant.
2339 pub fn non_enum_variant(&self) -> &VariantDef {
2340 assert!(self.is_struct() || self.is_union());
2341 &self.variants[VariantIdx::new(0)]
2345 pub fn predicates(&self, tcx: TyCtxt<'tcx>) -> GenericPredicates<'tcx> {
2346 tcx.predicates_of(self.did)
2349 /// Returns an iterator over all fields contained
2352 pub fn all_fields(&self) -> impl Iterator<Item=&FieldDef> + Clone {
2353 self.variants.iter().flat_map(|v| v.fields.iter())
2356 pub fn is_payloadfree(&self) -> bool {
2357 !self.variants.is_empty() &&
2358 self.variants.iter().all(|v| v.fields.is_empty())
2361 /// Return a `VariantDef` given a variant id.
2362 pub fn variant_with_id(&self, vid: DefId) -> &VariantDef {
2363 self.variants.iter().find(|v| v.def_id == vid)
2364 .expect("variant_with_id: unknown variant")
2367 /// Return a `VariantDef` given a constructor id.
2368 pub fn variant_with_ctor_id(&self, cid: DefId) -> &VariantDef {
2369 self.variants.iter().find(|v| v.ctor_def_id == Some(cid))
2370 .expect("variant_with_ctor_id: unknown variant")
2373 /// Return the index of `VariantDef` given a variant id.
2374 pub fn variant_index_with_id(&self, vid: DefId) -> VariantIdx {
2375 self.variants.iter_enumerated().find(|(_, v)| v.def_id == vid)
2376 .expect("variant_index_with_id: unknown variant").0
2379 /// Return the index of `VariantDef` given a constructor id.
2380 pub fn variant_index_with_ctor_id(&self, cid: DefId) -> VariantIdx {
2381 self.variants.iter_enumerated().find(|(_, v)| v.ctor_def_id == Some(cid))
2382 .expect("variant_index_with_ctor_id: unknown variant").0
2385 pub fn variant_of_res(&self, res: Res) -> &VariantDef {
2387 Res::Def(DefKind::Variant, vid) => self.variant_with_id(vid),
2388 Res::Def(DefKind::Ctor(..), cid) => self.variant_with_ctor_id(cid),
2389 Res::Def(DefKind::Struct, _) | Res::Def(DefKind::Union, _) |
2390 Res::Def(DefKind::TyAlias, _) | Res::Def(DefKind::AssocTy, _) | Res::SelfTy(..) |
2391 Res::SelfCtor(..) => self.non_enum_variant(),
2392 _ => bug!("unexpected res {:?} in variant_of_res", res)
2397 pub fn eval_explicit_discr(&self, tcx: TyCtxt<'tcx>, expr_did: DefId) -> Option<Discr<'tcx>> {
2398 let param_env = tcx.param_env(expr_did);
2399 let repr_type = self.repr.discr_type();
2400 let substs = InternalSubsts::identity_for_item(tcx, expr_did);
2401 let instance = ty::Instance::new(expr_did, substs);
2402 let cid = GlobalId {
2406 match tcx.const_eval(param_env.and(cid)) {
2408 // FIXME: Find the right type and use it instead of `val.ty` here
2409 if let Some(b) = val.try_eval_bits(tcx, param_env, val.ty) {
2410 trace!("discriminants: {} ({:?})", b, repr_type);
2416 info!("invalid enum discriminant: {:#?}", val);
2417 crate::mir::interpret::struct_error(
2418 tcx.at(tcx.def_span(expr_did)),
2419 "constant evaluation of enum discriminant resulted in non-integer",
2424 Err(ErrorHandled::Reported) => {
2425 if !expr_did.is_local() {
2426 span_bug!(tcx.def_span(expr_did),
2427 "variant discriminant evaluation succeeded \
2428 in its crate but failed locally");
2432 Err(ErrorHandled::TooGeneric) => span_bug!(
2433 tcx.def_span(expr_did),
2434 "enum discriminant depends on generic arguments",
2440 pub fn discriminants(
2443 ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx> {
2444 let repr_type = self.repr.discr_type();
2445 let initial = repr_type.initial_discriminant(tcx);
2446 let mut prev_discr = None::<Discr<'tcx>>;
2447 self.variants.iter_enumerated().map(move |(i, v)| {
2448 let mut discr = prev_discr.map_or(initial, |d| d.wrap_incr(tcx));
2449 if let VariantDiscr::Explicit(expr_did) = v.discr {
2450 if let Some(new_discr) = self.eval_explicit_discr(tcx, expr_did) {
2454 prev_discr = Some(discr);
2461 pub fn variant_range(&self) -> Range<VariantIdx> {
2462 (VariantIdx::new(0)..VariantIdx::new(self.variants.len()))
2465 /// Computes the discriminant value used by a specific variant.
2466 /// Unlike `discriminants`, this is (amortized) constant-time,
2467 /// only doing at most one query for evaluating an explicit
2468 /// discriminant (the last one before the requested variant),
2469 /// assuming there are no constant-evaluation errors there.
2471 pub fn discriminant_for_variant(
2474 variant_index: VariantIdx,
2476 let (val, offset) = self.discriminant_def_for_variant(variant_index);
2477 let explicit_value = val
2478 .and_then(|expr_did| self.eval_explicit_discr(tcx, expr_did))
2479 .unwrap_or_else(|| self.repr.discr_type().initial_discriminant(tcx));
2480 explicit_value.checked_add(tcx, offset as u128).0
2483 /// Yields a `DefId` for the discriminant and an offset to add to it
2484 /// Alternatively, if there is no explicit discriminant, returns the
2485 /// inferred discriminant directly.
2486 pub fn discriminant_def_for_variant(
2488 variant_index: VariantIdx,
2489 ) -> (Option<DefId>, u32) {
2490 let mut explicit_index = variant_index.as_u32();
2493 match self.variants[VariantIdx::from_u32(explicit_index)].discr {
2494 ty::VariantDiscr::Relative(0) => {
2498 ty::VariantDiscr::Relative(distance) => {
2499 explicit_index -= distance;
2501 ty::VariantDiscr::Explicit(did) => {
2502 expr_did = Some(did);
2507 (expr_did, variant_index.as_u32() - explicit_index)
2510 pub fn destructor(&self, tcx: TyCtxt<'tcx>) -> Option<Destructor> {
2511 tcx.adt_destructor(self.did)
2514 /// Returns a list of types such that `Self: Sized` if and only
2515 /// if that type is `Sized`, or `TyErr` if this type is recursive.
2517 /// Oddly enough, checking that the sized-constraint is `Sized` is
2518 /// actually more expressive than checking all members:
2519 /// the `Sized` trait is inductive, so an associated type that references
2520 /// `Self` would prevent its containing ADT from being `Sized`.
2522 /// Due to normalization being eager, this applies even if
2523 /// the associated type is behind a pointer (e.g., issue #31299).
2524 pub fn sized_constraint(&self, tcx: TyCtxt<'tcx>) -> &'tcx [Ty<'tcx>] {
2525 tcx.adt_sized_constraint(self.did).0
2528 fn sized_constraint_for_ty(&self, tcx: TyCtxt<'tcx>, ty: Ty<'tcx>) -> Vec<Ty<'tcx>> {
2529 let result = match ty.kind {
2530 Bool | Char | Int(..) | Uint(..) | Float(..) |
2531 RawPtr(..) | Ref(..) | FnDef(..) | FnPtr(_) |
2532 Array(..) | Closure(..) | Generator(..) | Never => {
2541 GeneratorWitness(..) => {
2542 // these are never sized - return the target type
2549 Some(ty) => self.sized_constraint_for_ty(tcx, ty.expect_ty()),
2553 Adt(adt, substs) => {
2555 let adt_tys = adt.sized_constraint(tcx);
2556 debug!("sized_constraint_for_ty({:?}) intermediate = {:?}",
2559 .map(|ty| ty.subst(tcx, substs))
2560 .flat_map(|ty| self.sized_constraint_for_ty(tcx, ty))
2564 Projection(..) | Opaque(..) => {
2565 // must calculate explicitly.
2566 // FIXME: consider special-casing always-Sized projections
2570 UnnormalizedProjection(..) => bug!("only used with chalk-engine"),
2573 // perf hack: if there is a `T: Sized` bound, then
2574 // we know that `T` is Sized and do not need to check
2577 let sized_trait = match tcx.lang_items().sized_trait() {
2579 _ => return vec![ty]
2581 let sized_predicate = Binder::dummy(TraitRef {
2582 def_id: sized_trait,
2583 substs: tcx.mk_substs_trait(ty, &[])
2585 let predicates = tcx.predicates_of(self.did).predicates;
2586 if predicates.iter().any(|(p, _)| *p == sized_predicate) {
2596 bug!("unexpected type `{:?}` in sized_constraint_for_ty",
2600 debug!("sized_constraint_for_ty({:?}) = {:?}", ty, result);
2605 impl<'tcx> FieldDef {
2606 /// Returns the type of this field. The `subst` is typically obtained
2607 /// via the second field of `TyKind::AdtDef`.
2608 pub fn ty(&self, tcx: TyCtxt<'tcx>, subst: SubstsRef<'tcx>) -> Ty<'tcx> {
2609 tcx.type_of(self.did).subst(tcx, subst)
2613 /// Represents the various closure traits in the language. This
2614 /// will determine the type of the environment (`self`, in the
2615 /// desugaring) argument that the closure expects.
2617 /// You can get the environment type of a closure using
2618 /// `tcx.closure_env_ty()`.
2619 #[derive(Clone, Copy, PartialOrd, Ord, PartialEq, Eq, Hash, Debug,
2620 RustcEncodable, RustcDecodable, HashStable)]
2621 pub enum ClosureKind {
2622 // Warning: Ordering is significant here! The ordering is chosen
2623 // because the trait Fn is a subtrait of FnMut and so in turn, and
2624 // hence we order it so that Fn < FnMut < FnOnce.
2630 impl<'tcx> ClosureKind {
2631 // This is the initial value used when doing upvar inference.
2632 pub const LATTICE_BOTTOM: ClosureKind = ClosureKind::Fn;
2634 pub fn trait_did(&self, tcx: TyCtxt<'tcx>) -> DefId {
2636 ClosureKind::Fn => tcx.require_lang_item(FnTraitLangItem, None),
2637 ClosureKind::FnMut => {
2638 tcx.require_lang_item(FnMutTraitLangItem, None)
2640 ClosureKind::FnOnce => {
2641 tcx.require_lang_item(FnOnceTraitLangItem, None)
2646 /// Returns `true` if this a type that impls this closure kind
2647 /// must also implement `other`.
2648 pub fn extends(self, other: ty::ClosureKind) -> bool {
2649 match (self, other) {
2650 (ClosureKind::Fn, ClosureKind::Fn) => true,
2651 (ClosureKind::Fn, ClosureKind::FnMut) => true,
2652 (ClosureKind::Fn, ClosureKind::FnOnce) => true,
2653 (ClosureKind::FnMut, ClosureKind::FnMut) => true,
2654 (ClosureKind::FnMut, ClosureKind::FnOnce) => true,
2655 (ClosureKind::FnOnce, ClosureKind::FnOnce) => true,
2660 /// Returns the representative scalar type for this closure kind.
2661 /// See `TyS::to_opt_closure_kind` for more details.
2662 pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2664 ty::ClosureKind::Fn => tcx.types.i8,
2665 ty::ClosureKind::FnMut => tcx.types.i16,
2666 ty::ClosureKind::FnOnce => tcx.types.i32,
2671 impl<'tcx> TyS<'tcx> {
2672 /// Iterator that walks `self` and any types reachable from
2673 /// `self`, in depth-first order. Note that just walks the types
2674 /// that appear in `self`, it does not descend into the fields of
2675 /// structs or variants. For example:
2678 /// isize => { isize }
2679 /// Foo<Bar<isize>> => { Foo<Bar<isize>>, Bar<isize>, isize }
2680 /// [isize] => { [isize], isize }
2682 pub fn walk(&'tcx self) -> TypeWalker<'tcx> {
2683 TypeWalker::new(self)
2686 /// Iterator that walks the immediate children of `self`. Hence
2687 /// `Foo<Bar<i32>, u32>` yields the sequence `[Bar<i32>, u32]`
2688 /// (but not `i32`, like `walk`).
2689 pub fn walk_shallow(&'tcx self) -> smallvec::IntoIter<walk::TypeWalkerArray<'tcx>> {
2690 walk::walk_shallow(self)
2693 /// Walks `ty` and any types appearing within `ty`, invoking the
2694 /// callback `f` on each type. If the callback returns `false`, then the
2695 /// children of the current type are ignored.
2697 /// Note: prefer `ty.walk()` where possible.
2698 pub fn maybe_walk<F>(&'tcx self, mut f: F)
2699 where F: FnMut(Ty<'tcx>) -> bool
2701 let mut walker = self.walk();
2702 while let Some(ty) = walker.next() {
2704 walker.skip_current_subtree();
2711 pub fn from_mutbl(m: hir::Mutability) -> BorrowKind {
2713 hir::Mutability::Mutable => MutBorrow,
2714 hir::Mutability::Immutable => ImmBorrow,
2718 /// Returns a mutability `m` such that an `&m T` pointer could be used to obtain this borrow
2719 /// kind. Because borrow kinds are richer than mutabilities, we sometimes have to pick a
2720 /// mutability that is stronger than necessary so that it at least *would permit* the borrow in
2722 pub fn to_mutbl_lossy(self) -> hir::Mutability {
2724 MutBorrow => hir::Mutability::Mutable,
2725 ImmBorrow => hir::Mutability::Immutable,
2727 // We have no type corresponding to a unique imm borrow, so
2728 // use `&mut`. It gives all the capabilities of an `&uniq`
2729 // and hence is a safe "over approximation".
2730 UniqueImmBorrow => hir::Mutability::Mutable,
2734 pub fn to_user_str(&self) -> &'static str {
2736 MutBorrow => "mutable",
2737 ImmBorrow => "immutable",
2738 UniqueImmBorrow => "uniquely immutable",
2743 #[derive(Debug, Clone)]
2744 pub enum Attributes<'tcx> {
2745 Owned(Lrc<[ast::Attribute]>),
2746 Borrowed(&'tcx [ast::Attribute]),
2749 impl<'tcx> ::std::ops::Deref for Attributes<'tcx> {
2750 type Target = [ast::Attribute];
2752 fn deref(&self) -> &[ast::Attribute] {
2754 &Attributes::Owned(ref data) => &data,
2755 &Attributes::Borrowed(data) => data
2760 #[derive(Debug, PartialEq, Eq)]
2761 pub enum ImplOverlapKind {
2762 /// These impls are always allowed to overlap.
2764 /// These impls are allowed to overlap, but that raises
2765 /// an issue #33140 future-compatibility warning.
2767 /// Some background: in Rust 1.0, the trait-object types `Send + Sync` (today's
2768 /// `dyn Send + Sync`) and `Sync + Send` (now `dyn Sync + Send`) were different.
2770 /// The widely-used version 0.1.0 of the crate `traitobject` had accidentally relied
2771 /// that difference, making what reduces to the following set of impls:
2775 /// impl Trait for dyn Send + Sync {}
2776 /// impl Trait for dyn Sync + Send {}
2779 /// Obviously, once we made these types be identical, that code causes a coherence
2780 /// error and a fairly big headache for us. However, luckily for us, the trait
2781 /// `Trait` used in this case is basically a marker trait, and therefore having
2782 /// overlapping impls for it is sound.
2784 /// To handle this, we basically regard the trait as a marker trait, with an additional
2785 /// future-compatibility warning. To avoid accidentally "stabilizing" this feature,
2786 /// it has the following restrictions:
2788 /// 1. The trait must indeed be a marker-like trait (i.e., no items), and must be
2790 /// 2. The trait-ref of both impls must be equal.
2791 /// 3. The trait-ref of both impls must be a trait object type consisting only of
2793 /// 4. Neither of the impls can have any where-clauses.
2795 /// Once `traitobject` 0.1.0 is no longer an active concern, this hack can be removed.
2799 impl<'tcx> TyCtxt<'tcx> {
2800 pub fn body_tables(self, body: hir::BodyId) -> &'tcx TypeckTables<'tcx> {
2801 self.typeck_tables_of(self.hir().body_owner_def_id(body))
2804 /// Returns an iterator of the `DefId`s for all body-owners in this
2805 /// crate. If you would prefer to iterate over the bodies
2806 /// themselves, you can do `self.hir().krate().body_ids.iter()`.
2807 pub fn body_owners(self) -> impl Iterator<Item = DefId> + Captures<'tcx> + 'tcx {
2811 .map(move |&body_id| self.hir().body_owner_def_id(body_id))
2814 pub fn par_body_owners<F: Fn(DefId) + sync::Sync + sync::Send>(self, f: F) {
2815 par_iter(&self.hir().krate().body_ids).for_each(|&body_id| {
2816 f(self.hir().body_owner_def_id(body_id))
2820 pub fn provided_trait_methods(self, id: DefId) -> Vec<AssocItem> {
2821 self.associated_items(id)
2822 .filter(|item| item.kind == AssocKind::Method && item.defaultness.has_value())
2826 pub fn trait_relevant_for_never(self, did: DefId) -> bool {
2827 self.associated_items(did).any(|item| {
2828 item.relevant_for_never()
2832 pub fn opt_item_name(self, def_id: DefId) -> Option<Ident> {
2833 self.hir().as_local_hir_id(def_id).and_then(|hir_id| self.hir().get(hir_id).ident())
2836 pub fn opt_associated_item(self, def_id: DefId) -> Option<AssocItem> {
2837 let is_associated_item = if let Some(hir_id) = self.hir().as_local_hir_id(def_id) {
2838 match self.hir().get(hir_id) {
2839 Node::TraitItem(_) | Node::ImplItem(_) => true,
2843 match self.def_kind(def_id).expect("no def for `DefId`") {
2846 | DefKind::AssocTy => true,
2851 if is_associated_item {
2852 Some(self.associated_item(def_id))
2858 fn associated_item_from_trait_item_ref(self,
2859 parent_def_id: DefId,
2860 parent_vis: &hir::Visibility,
2861 trait_item_ref: &hir::TraitItemRef)
2863 let def_id = self.hir().local_def_id(trait_item_ref.id.hir_id);
2864 let (kind, has_self) = match trait_item_ref.kind {
2865 hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
2866 hir::AssocItemKind::Method { has_self } => {
2867 (ty::AssocKind::Method, has_self)
2869 hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
2870 hir::AssocItemKind::OpaqueTy => bug!("only impls can have opaque types"),
2874 ident: trait_item_ref.ident,
2876 // Visibility of trait items is inherited from their traits.
2877 vis: Visibility::from_hir(parent_vis, trait_item_ref.id.hir_id, self),
2878 defaultness: trait_item_ref.defaultness,
2880 container: TraitContainer(parent_def_id),
2881 method_has_self_argument: has_self
2885 fn associated_item_from_impl_item_ref(self,
2886 parent_def_id: DefId,
2887 impl_item_ref: &hir::ImplItemRef)
2889 let def_id = self.hir().local_def_id(impl_item_ref.id.hir_id);
2890 let (kind, has_self) = match impl_item_ref.kind {
2891 hir::AssocItemKind::Const => (ty::AssocKind::Const, false),
2892 hir::AssocItemKind::Method { has_self } => {
2893 (ty::AssocKind::Method, has_self)
2895 hir::AssocItemKind::Type => (ty::AssocKind::Type, false),
2896 hir::AssocItemKind::OpaqueTy => (ty::AssocKind::OpaqueTy, false),
2900 ident: impl_item_ref.ident,
2902 // Visibility of trait impl items doesn't matter.
2903 vis: ty::Visibility::from_hir(&impl_item_ref.vis, impl_item_ref.id.hir_id, self),
2904 defaultness: impl_item_ref.defaultness,
2906 container: ImplContainer(parent_def_id),
2907 method_has_self_argument: has_self
2911 pub fn field_index(self, hir_id: hir::HirId, tables: &TypeckTables<'_>) -> usize {
2912 tables.field_indices().get(hir_id).cloned().expect("no index for a field")
2915 pub fn find_field_index(self, ident: Ident, variant: &VariantDef) -> Option<usize> {
2916 variant.fields.iter().position(|field| {
2917 self.hygienic_eq(ident, field.ident, variant.def_id)
2921 pub fn associated_items(self, def_id: DefId) -> AssocItemsIterator<'tcx> {
2922 // Ideally, we would use `-> impl Iterator` here, but it falls
2923 // afoul of the conservative "capture [restrictions]" we put
2924 // in place, so we use a hand-written iterator.
2926 // [restrictions]: https://github.com/rust-lang/rust/issues/34511#issuecomment-373423999
2927 AssocItemsIterator {
2929 def_ids: self.associated_item_def_ids(def_id),
2934 /// Returns `true` if the impls are the same polarity and the trait either
2935 /// has no items or is annotated #[marker] and prevents item overrides.
2936 pub fn impls_are_allowed_to_overlap(self, def_id1: DefId, def_id2: DefId)
2937 -> Option<ImplOverlapKind>
2939 // If either trait impl references an error, they're allowed to overlap,
2940 // as one of them essentially doesn't exist.
2941 if self.impl_trait_ref(def_id1).map_or(false, |tr| tr.references_error()) ||
2942 self.impl_trait_ref(def_id2).map_or(false, |tr| tr.references_error()) {
2943 return Some(ImplOverlapKind::Permitted);
2946 match (self.impl_polarity(def_id1), self.impl_polarity(def_id2)) {
2947 (ImplPolarity::Reservation, _) |
2948 (_, ImplPolarity::Reservation) => {
2949 // `#[rustc_reservation_impl]` impls don't overlap with anything
2950 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (reservations)",
2952 return Some(ImplOverlapKind::Permitted);
2954 (ImplPolarity::Positive, ImplPolarity::Negative) |
2955 (ImplPolarity::Negative, ImplPolarity::Positive) => {
2956 // `impl AutoTrait for Type` + `impl !AutoTrait for Type`
2957 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - None (differing polarities)",
2961 (ImplPolarity::Positive, ImplPolarity::Positive) |
2962 (ImplPolarity::Negative, ImplPolarity::Negative) => {}
2965 let is_marker_overlap = if self.features().overlapping_marker_traits {
2966 let trait1_is_empty = self.impl_trait_ref(def_id1)
2967 .map_or(false, |trait_ref| {
2968 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2970 let trait2_is_empty = self.impl_trait_ref(def_id2)
2971 .map_or(false, |trait_ref| {
2972 self.associated_item_def_ids(trait_ref.def_id).is_empty()
2974 trait1_is_empty && trait2_is_empty
2976 let is_marker_impl = |def_id: DefId| -> bool {
2977 let trait_ref = self.impl_trait_ref(def_id);
2978 trait_ref.map_or(false, |tr| self.trait_def(tr.def_id).is_marker)
2980 is_marker_impl(def_id1) && is_marker_impl(def_id2)
2984 if is_marker_overlap {
2985 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (marker overlap)",
2987 Some(ImplOverlapKind::Permitted)
2989 if let Some(self_ty1) = self.issue33140_self_ty(def_id1) {
2990 if let Some(self_ty2) = self.issue33140_self_ty(def_id2) {
2991 if self_ty1 == self_ty2 {
2992 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - issue #33140 HACK",
2994 return Some(ImplOverlapKind::Issue33140);
2996 debug!("impls_are_allowed_to_overlap({:?}, {:?}) - found {:?} != {:?}",
2997 def_id1, def_id2, self_ty1, self_ty2);
3002 debug!("impls_are_allowed_to_overlap({:?}, {:?}) = None",
3008 /// Returns `ty::VariantDef` if `res` refers to a struct,
3009 /// or variant or their constructors, panics otherwise.
3010 pub fn expect_variant_res(self, res: Res) -> &'tcx VariantDef {
3012 Res::Def(DefKind::Variant, did) => {
3013 let enum_did = self.parent(did).unwrap();
3014 self.adt_def(enum_did).variant_with_id(did)
3016 Res::Def(DefKind::Struct, did) | Res::Def(DefKind::Union, did) => {
3017 self.adt_def(did).non_enum_variant()
3019 Res::Def(DefKind::Ctor(CtorOf::Variant, ..), variant_ctor_did) => {
3020 let variant_did = self.parent(variant_ctor_did).unwrap();
3021 let enum_did = self.parent(variant_did).unwrap();
3022 self.adt_def(enum_did).variant_with_ctor_id(variant_ctor_did)
3024 Res::Def(DefKind::Ctor(CtorOf::Struct, ..), ctor_did) => {
3025 let struct_did = self.parent(ctor_did).expect("struct ctor has no parent");
3026 self.adt_def(struct_did).non_enum_variant()
3028 _ => bug!("expect_variant_res used with unexpected res {:?}", res)
3032 pub fn item_name(self, id: DefId) -> Symbol {
3033 if id.index == CRATE_DEF_INDEX {
3034 self.original_crate_name(id.krate)
3036 let def_key = self.def_key(id);
3037 match def_key.disambiguated_data.data {
3038 // The name of a constructor is that of its parent.
3039 hir_map::DefPathData::Ctor =>
3040 self.item_name(DefId {
3042 index: def_key.parent.unwrap()
3044 _ => def_key.disambiguated_data.data.get_opt_name().unwrap_or_else(|| {
3045 bug!("item_name: no name for {:?}", self.def_path(id));
3051 /// Returns the possibly-auto-generated MIR of a `(DefId, Subst)` pair.
3052 pub fn instance_mir(self, instance: ty::InstanceDef<'tcx>) -> &'tcx Body<'tcx> {
3054 ty::InstanceDef::Item(did) => {
3055 self.optimized_mir(did)
3057 ty::InstanceDef::VtableShim(..) |
3058 ty::InstanceDef::ReifyShim(..) |
3059 ty::InstanceDef::Intrinsic(..) |
3060 ty::InstanceDef::FnPtrShim(..) |
3061 ty::InstanceDef::Virtual(..) |
3062 ty::InstanceDef::ClosureOnceShim { .. } |
3063 ty::InstanceDef::DropGlue(..) |
3064 ty::InstanceDef::CloneShim(..) => {
3065 self.mir_shims(instance)
3070 /// Gets the attributes of a definition.
3071 pub fn get_attrs(self, did: DefId) -> Attributes<'tcx> {
3072 if let Some(id) = self.hir().as_local_hir_id(did) {
3073 Attributes::Borrowed(self.hir().attrs(id))
3075 Attributes::Owned(self.item_attrs(did))
3079 /// Determines whether an item is annotated with an attribute.
3080 pub fn has_attr(self, did: DefId, attr: Symbol) -> bool {
3081 attr::contains_name(&self.get_attrs(did), attr)
3084 /// Returns `true` if this is an `auto trait`.
3085 pub fn trait_is_auto(self, trait_def_id: DefId) -> bool {
3086 self.trait_def(trait_def_id).has_auto_impl
3089 pub fn generator_layout(self, def_id: DefId) -> &'tcx GeneratorLayout<'tcx> {
3090 self.optimized_mir(def_id).generator_layout.as_ref().unwrap()
3093 /// Given the `DefId` of an impl, returns the `DefId` of the trait it implements.
3094 /// If it implements no trait, returns `None`.
3095 pub fn trait_id_of_impl(self, def_id: DefId) -> Option<DefId> {
3096 self.impl_trait_ref(def_id).map(|tr| tr.def_id)
3099 /// If the given defid describes a method belonging to an impl, returns the
3100 /// `DefId` of the impl that the method belongs to; otherwise, returns `None`.
3101 pub fn impl_of_method(self, def_id: DefId) -> Option<DefId> {
3102 let item = if def_id.krate != LOCAL_CRATE {
3103 if let Some(DefKind::Method) = self.def_kind(def_id) {
3104 Some(self.associated_item(def_id))
3109 self.opt_associated_item(def_id)
3112 item.and_then(|trait_item|
3113 match trait_item.container {
3114 TraitContainer(_) => None,
3115 ImplContainer(def_id) => Some(def_id),
3120 /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
3121 /// with the name of the crate containing the impl.
3122 pub fn span_of_impl(self, impl_did: DefId) -> Result<Span, Symbol> {
3123 if impl_did.is_local() {
3124 let hir_id = self.hir().as_local_hir_id(impl_did).unwrap();
3125 Ok(self.hir().span(hir_id))
3127 Err(self.crate_name(impl_did.krate))
3131 /// Hygienically compares a use-site name (`use_name`) for a field or an associated item with
3132 /// its supposed definition name (`def_name`). The method also needs `DefId` of the supposed
3133 /// definition's parent/scope to perform comparison.
3134 pub fn hygienic_eq(self, use_name: Ident, def_name: Ident, def_parent_def_id: DefId) -> bool {
3135 // We could use `Ident::eq` here, but we deliberately don't. The name
3136 // comparison fails frequently, and we want to avoid the expensive
3137 // `modern()` calls required for the span comparison whenever possible.
3138 use_name.name == def_name.name &&
3139 use_name.span.ctxt().hygienic_eq(def_name.span.ctxt(),
3140 self.expansion_that_defined(def_parent_def_id))
3143 fn expansion_that_defined(self, scope: DefId) -> ExpnId {
3145 LOCAL_CRATE => self.hir().definitions().expansion_that_defined(scope.index),
3146 _ => ExpnId::root(),
3150 pub fn adjust_ident(self, mut ident: Ident, scope: DefId) -> Ident {
3151 ident.span.modernize_and_adjust(self.expansion_that_defined(scope));
3155 pub fn adjust_ident_and_get_scope(self, mut ident: Ident, scope: DefId, block: hir::HirId)
3157 let scope = match ident.span.modernize_and_adjust(self.expansion_that_defined(scope)) {
3158 Some(actual_expansion) =>
3159 self.hir().definitions().parent_module_of_macro_def(actual_expansion),
3160 None => self.hir().get_module_parent(block),
3167 pub struct AssocItemsIterator<'tcx> {
3169 def_ids: &'tcx [DefId],
3173 impl Iterator for AssocItemsIterator<'_> {
3174 type Item = AssocItem;
3176 fn next(&mut self) -> Option<AssocItem> {
3177 let def_id = self.def_ids.get(self.next_index)?;
3178 self.next_index += 1;
3179 Some(self.tcx.associated_item(*def_id))
3183 fn associated_item(tcx: TyCtxt<'_>, def_id: DefId) -> AssocItem {
3184 let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3185 let parent_id = tcx.hir().get_parent_item(id);
3186 let parent_def_id = tcx.hir().local_def_id(parent_id);
3187 let parent_item = tcx.hir().expect_item(parent_id);
3188 match parent_item.kind {
3189 hir::ItemKind::Impl(.., ref impl_item_refs) => {
3190 if let Some(impl_item_ref) = impl_item_refs.iter().find(|i| i.id.hir_id == id) {
3191 let assoc_item = tcx.associated_item_from_impl_item_ref(parent_def_id,
3193 debug_assert_eq!(assoc_item.def_id, def_id);
3198 hir::ItemKind::Trait(.., ref trait_item_refs) => {
3199 if let Some(trait_item_ref) = trait_item_refs.iter().find(|i| i.id.hir_id == id) {
3200 let assoc_item = tcx.associated_item_from_trait_item_ref(parent_def_id,
3203 debug_assert_eq!(assoc_item.def_id, def_id);
3211 span_bug!(parent_item.span,
3212 "unexpected parent of trait or impl item or item not found: {:?}",
3216 #[derive(Clone, HashStable)]
3217 pub struct AdtSizedConstraint<'tcx>(pub &'tcx [Ty<'tcx>]);
3219 /// Calculates the `Sized` constraint.
3221 /// In fact, there are only a few options for the types in the constraint:
3222 /// - an obviously-unsized type
3223 /// - a type parameter or projection whose Sizedness can't be known
3224 /// - a tuple of type parameters or projections, if there are multiple
3226 /// - a Error, if a type contained itself. The representability
3227 /// check should catch this case.
3228 fn adt_sized_constraint(tcx: TyCtxt<'_>, def_id: DefId) -> AdtSizedConstraint<'_> {
3229 let def = tcx.adt_def(def_id);
3231 let result = tcx.mk_type_list(def.variants.iter().flat_map(|v| {
3234 def.sized_constraint_for_ty(tcx, tcx.type_of(f.did))
3237 debug!("adt_sized_constraint: {:?} => {:?}", def, result);
3239 AdtSizedConstraint(result)
3242 fn associated_item_def_ids(tcx: TyCtxt<'_>, def_id: DefId) -> &[DefId] {
3243 let id = tcx.hir().as_local_hir_id(def_id).unwrap();
3244 let item = tcx.hir().expect_item(id);
3246 hir::ItemKind::Trait(.., ref trait_item_refs) => {
3247 tcx.arena.alloc_from_iter(
3248 trait_item_refs.iter()
3249 .map(|trait_item_ref| trait_item_ref.id)
3250 .map(|id| tcx.hir().local_def_id(id.hir_id))
3253 hir::ItemKind::Impl(.., ref impl_item_refs) => {
3254 tcx.arena.alloc_from_iter(
3255 impl_item_refs.iter()
3256 .map(|impl_item_ref| impl_item_ref.id)
3257 .map(|id| tcx.hir().local_def_id(id.hir_id))
3260 hir::ItemKind::TraitAlias(..) => &[],
3261 _ => span_bug!(item.span, "associated_item_def_ids: not impl or trait")
3265 fn def_span(tcx: TyCtxt<'_>, def_id: DefId) -> Span {
3266 tcx.hir().span_if_local(def_id).unwrap()
3269 /// If the given `DefId` describes an item belonging to a trait,
3270 /// returns the `DefId` of the trait that the trait item belongs to;
3271 /// otherwise, returns `None`.
3272 fn trait_of_item(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
3273 tcx.opt_associated_item(def_id)
3274 .and_then(|associated_item| {
3275 match associated_item.container {
3276 TraitContainer(def_id) => Some(def_id),
3277 ImplContainer(_) => None
3282 /// Yields the parent function's `DefId` if `def_id` is an `impl Trait` definition.
3283 pub fn is_impl_trait_defn(tcx: TyCtxt<'_>, def_id: DefId) -> Option<DefId> {
3284 if let Some(hir_id) = tcx.hir().as_local_hir_id(def_id) {
3285 if let Node::Item(item) = tcx.hir().get(hir_id) {
3286 if let hir::ItemKind::OpaqueTy(ref opaque_ty) = item.kind {
3287 return opaque_ty.impl_trait_fn;
3294 /// See `ParamEnv` struct definition for details.
3295 fn param_env(tcx: TyCtxt<'_>, def_id: DefId) -> ParamEnv<'_> {
3296 // The param_env of an impl Trait type is its defining function's param_env
3297 if let Some(parent) = is_impl_trait_defn(tcx, def_id) {
3298 return param_env(tcx, parent);
3300 // Compute the bounds on Self and the type parameters.
3302 let InstantiatedPredicates { predicates } =
3303 tcx.predicates_of(def_id).instantiate_identity(tcx);
3305 // Finally, we have to normalize the bounds in the environment, in
3306 // case they contain any associated type projections. This process
3307 // can yield errors if the put in illegal associated types, like
3308 // `<i32 as Foo>::Bar` where `i32` does not implement `Foo`. We
3309 // report these errors right here; this doesn't actually feel
3310 // right to me, because constructing the environment feels like a
3311 // kind of a "idempotent" action, but I'm not sure where would be
3312 // a better place. In practice, we construct environments for
3313 // every fn once during type checking, and we'll abort if there
3314 // are any errors at that point, so after type checking you can be
3315 // sure that this will succeed without errors anyway.
3317 let unnormalized_env = ty::ParamEnv::new(
3318 tcx.intern_predicates(&predicates),
3319 traits::Reveal::UserFacing,
3320 if tcx.sess.opts.debugging_opts.chalk { Some(def_id) } else { None }
3323 let body_id = tcx.hir().as_local_hir_id(def_id).map_or(hir::DUMMY_HIR_ID, |id| {
3324 tcx.hir().maybe_body_owned_by(id).map_or(id, |body| body.hir_id)
3326 let cause = traits::ObligationCause::misc(tcx.def_span(def_id), body_id);
3327 traits::normalize_param_env_or_error(tcx, def_id, unnormalized_env, cause)
3330 fn crate_disambiguator(tcx: TyCtxt<'_>, crate_num: CrateNum) -> CrateDisambiguator {
3331 assert_eq!(crate_num, LOCAL_CRATE);
3332 tcx.sess.local_crate_disambiguator()
3335 fn original_crate_name(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Symbol {
3336 assert_eq!(crate_num, LOCAL_CRATE);
3337 tcx.crate_name.clone()
3340 fn crate_hash(tcx: TyCtxt<'_>, crate_num: CrateNum) -> Svh {
3341 assert_eq!(crate_num, LOCAL_CRATE);
3342 tcx.hir().crate_hash
3345 fn instance_def_size_estimate<'tcx>(tcx: TyCtxt<'tcx>, instance_def: InstanceDef<'tcx>) -> usize {
3346 match instance_def {
3347 InstanceDef::Item(..) |
3348 InstanceDef::DropGlue(..) => {
3349 let mir = tcx.instance_mir(instance_def);
3350 mir.basic_blocks().iter().map(|bb| bb.statements.len()).sum()
3352 // Estimate the size of other compiler-generated shims to be 1.
3357 /// If `def_id` is an issue 33140 hack impl, returns its self type; otherwise, returns `None`.
3359 /// See [`ImplOverlapKind::Issue33140`] for more details.
3360 fn issue33140_self_ty(tcx: TyCtxt<'_>, def_id: DefId) -> Option<Ty<'_>> {
3361 debug!("issue33140_self_ty({:?})", def_id);
3363 let trait_ref = tcx.impl_trait_ref(def_id).unwrap_or_else(|| {
3364 bug!("issue33140_self_ty called on inherent impl {:?}", def_id)
3367 debug!("issue33140_self_ty({:?}), trait-ref={:?}", def_id, trait_ref);
3369 let is_marker_like =
3370 tcx.impl_polarity(def_id) == ty::ImplPolarity::Positive &&
3371 tcx.associated_item_def_ids(trait_ref.def_id).is_empty();
3373 // Check whether these impls would be ok for a marker trait.
3374 if !is_marker_like {
3375 debug!("issue33140_self_ty - not marker-like!");
3379 // impl must be `impl Trait for dyn Marker1 + Marker2 + ...`
3380 if trait_ref.substs.len() != 1 {
3381 debug!("issue33140_self_ty - impl has substs!");
3385 let predicates = tcx.predicates_of(def_id);
3386 if predicates.parent.is_some() || !predicates.predicates.is_empty() {
3387 debug!("issue33140_self_ty - impl has predicates {:?}!", predicates);
3391 let self_ty = trait_ref.self_ty();
3392 let self_ty_matches = match self_ty.kind {
3393 ty::Dynamic(ref data, ty::ReStatic) => data.principal().is_none(),
3397 if self_ty_matches {
3398 debug!("issue33140_self_ty - MATCHES!");
3401 debug!("issue33140_self_ty - non-matching self type");
3406 /// Check if a function is async.
3407 fn asyncness(tcx: TyCtxt<'_>, def_id: DefId) -> hir::IsAsync {
3408 let hir_id = tcx.hir().as_local_hir_id(def_id).unwrap_or_else(|| {
3409 bug!("asyncness: expected local `DefId`, got `{:?}`", def_id)
3412 let node = tcx.hir().get(hir_id);
3414 let fn_like = hir::map::blocks::FnLikeNode::from_node(node).unwrap_or_else(|| {
3415 bug!("asyncness: expected fn-like node but got `{:?}`", def_id);
3421 pub fn provide(providers: &mut ty::query::Providers<'_>) {
3422 context::provide(providers);
3423 erase_regions::provide(providers);
3424 layout::provide(providers);
3425 util::provide(providers);
3426 constness::provide(providers);
3427 *providers = ty::query::Providers {
3430 associated_item_def_ids,
3431 adt_sized_constraint,
3435 crate_disambiguator,
3436 original_crate_name,
3438 trait_impls_of: trait_def::trait_impls_of_provider,
3439 instance_def_size_estimate,
3445 /// A map for the local crate mapping each type to a vector of its
3446 /// inherent impls. This is not meant to be used outside of coherence;
3447 /// rather, you should request the vector for a specific type via
3448 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
3449 /// (constructing this map requires touching the entire crate).
3450 #[derive(Clone, Debug, Default, HashStable)]
3451 pub struct CrateInherentImpls {
3452 pub inherent_impls: DefIdMap<Vec<DefId>>,
3455 #[derive(Clone, Copy, PartialEq, Eq, RustcEncodable, RustcDecodable)]
3456 pub struct SymbolName {
3457 // FIXME: we don't rely on interning or equality here - better have
3458 // this be a `&'tcx str`.
3462 impl_stable_hash_for!(struct self::SymbolName {
3467 pub fn new(name: &str) -> SymbolName {
3469 name: Symbol::intern(name)
3474 impl PartialOrd for SymbolName {
3475 fn partial_cmp(&self, other: &SymbolName) -> Option<Ordering> {
3476 self.name.as_str().partial_cmp(&other.name.as_str())
3480 /// Ordering must use the chars to ensure reproducible builds.
3481 impl Ord for SymbolName {
3482 fn cmp(&self, other: &SymbolName) -> Ordering {
3483 self.name.as_str().cmp(&other.name.as_str())
3487 impl fmt::Display for SymbolName {
3488 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3489 fmt::Display::fmt(&self.name, fmt)
3493 impl fmt::Debug for SymbolName {
3494 fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
3495 fmt::Display::fmt(&self.name, fmt)