1 //! Defines how the compiler represents types internally.
3 //! Two important entities in this module are:
5 //! - [`rustc_middle::ty::Ty`], used to represent the semantics of a type.
6 //! - [`rustc_middle::ty::TyCtxt`], the central data structure in the compiler.
8 //! For more information, see ["The `ty` module: representing types"] in the rustc-dev-guide.
10 //! ["The `ty` module: representing types"]: https://rustc-dev-guide.rust-lang.org/ty.html
12 pub use self::fold
::{FallibleTypeFolder, TypeFoldable, TypeFolder, TypeVisitor}
;
13 pub use self::AssocItemContainer
::*;
14 pub use self::BorrowKind
::*;
15 pub use self::IntVarValue
::*;
16 pub use self::Variance
::*;
20 use rustc_data_structures
::fingerprint
::Fingerprint
;
23 use crate::metadata
::ModChild
;
24 use crate::middle
::privacy
::AccessLevels
;
25 use crate::mir
::{Body, GeneratorLayout}
;
26 use crate::traits
::{self, Reveal}
;
28 use crate::ty
::fast_reject
::SimplifiedType
;
29 use crate::ty
::subst
::{GenericArg, InternalSubsts, Subst, SubstsRef}
;
30 use crate::ty
::util
::Discr
;
32 use rustc_attr
as attr
;
33 use rustc_data_structures
::fx
::{FxHashMap, FxHashSet, FxIndexMap}
;
34 use rustc_data_structures
::intern
::Interned
;
35 use rustc_data_structures
::stable_hasher
::{HashStable, StableHasher}
;
36 use rustc_data_structures
::tagged_ptr
::CopyTaggedPtr
;
38 use rustc_hir
::def
::{CtorKind, CtorOf, DefKind, Res}
;
39 use rustc_hir
::def_id
::{CrateNum, DefId, LocalDefId, LocalDefIdMap, CRATE_DEF_INDEX}
;
41 use rustc_macros
::HashStable
;
42 use rustc_query_system
::ich
::StableHashingContext
;
43 use rustc_session
::cstore
::CrateStoreDyn
;
44 use rustc_span
::symbol
::{kw, Ident, Symbol}
;
46 use rustc_target
::abi
::Align
;
50 use std
::ops
::ControlFlow
;
53 pub use crate::ty
::diagnostics
::*;
54 pub use rustc_type_ir
::InferTy
::*;
55 pub use rustc_type_ir
::*;
57 pub use self::binding
::BindingMode
;
58 pub use self::binding
::BindingMode
::*;
59 pub use self::closure
::{
60 is_ancestor_or_same_capture
, place_to_string_for_capture
, BorrowKind
, CaptureInfo
,
61 CapturedPlace
, ClosureKind
, MinCaptureInformationMap
, MinCaptureList
,
62 RootVariableMinCaptureList
, UpvarCapture
, UpvarCaptureMap
, UpvarId
, UpvarListMap
, UpvarPath
,
65 pub use self::consts
::{
66 Const
, ConstInt
, ConstKind
, ConstS
, InferConst
, ScalarInt
, Unevaluated
, ValTree
,
68 pub use self::context
::{
69 tls
, CanonicalUserType
, CanonicalUserTypeAnnotation
, CanonicalUserTypeAnnotations
,
70 CtxtInterners
, DelaySpanBugEmitted
, FreeRegionInfo
, GeneratorInteriorTypeCause
, GlobalCtxt
,
71 Lift
, OnDiskCache
, TyCtxt
, TypeckResults
, UserType
, UserTypeAnnotationIndex
,
73 pub use self::instance
::{Instance, InstanceDef}
;
74 pub use self::list
::List
;
75 pub use self::sty
::BoundRegionKind
::*;
76 pub use self::sty
::RegionKind
::*;
77 pub use self::sty
::TyKind
::*;
79 Binder
, BoundRegion
, BoundRegionKind
, BoundTy
, BoundTyKind
, BoundVar
, BoundVariableKind
,
80 CanonicalPolyFnSig
, ClosureSubsts
, ClosureSubstsParts
, ConstVid
, EarlyBoundRegion
,
81 ExistentialPredicate
, ExistentialProjection
, ExistentialTraitRef
, FnSig
, FreeRegion
, GenSig
,
82 GeneratorSubsts
, GeneratorSubstsParts
, InlineConstSubsts
, InlineConstSubstsParts
, ParamConst
,
83 ParamTy
, PolyExistentialProjection
, PolyExistentialTraitRef
, PolyFnSig
, PolyGenSig
,
84 PolyTraitRef
, ProjectionTy
, Region
, RegionKind
, RegionVid
, TraitRef
, TyKind
, TypeAndMut
,
85 UpvarSubsts
, VarianceDiagInfo
,
87 pub use self::trait_def
::TraitDef
;
98 pub mod inhabitedness
;
100 pub mod normalize_erasing_regions
;
121 mod structural_impls
;
126 pub type RegisteredTools
= FxHashSet
<Ident
>;
129 pub struct ResolverOutputs
{
130 pub definitions
: rustc_hir
::definitions
::Definitions
,
131 pub cstore
: Box
<CrateStoreDyn
>,
132 pub visibilities
: FxHashMap
<LocalDefId
, Visibility
>,
133 pub access_levels
: AccessLevels
,
134 pub extern_crate_map
: FxHashMap
<LocalDefId
, CrateNum
>,
135 pub maybe_unused_trait_imports
: FxHashSet
<LocalDefId
>,
136 pub maybe_unused_extern_crates
: Vec
<(LocalDefId
, Span
)>,
137 pub reexport_map
: FxHashMap
<LocalDefId
, Vec
<ModChild
>>,
138 pub glob_map
: FxHashMap
<LocalDefId
, FxHashSet
<Symbol
>>,
139 /// Extern prelude entries. The value is `true` if the entry was introduced
140 /// via `extern crate` item and not `--extern` option or compiler built-in.
141 pub extern_prelude
: FxHashMap
<Symbol
, bool
>,
142 pub main_def
: Option
<MainDefinition
>,
143 pub trait_impls
: FxIndexMap
<DefId
, Vec
<LocalDefId
>>,
144 /// A list of proc macro LocalDefIds, written out in the order in which
145 /// they are declared in the static array generated by proc_macro_harness.
146 pub proc_macros
: Vec
<LocalDefId
>,
147 /// Mapping from ident span to path span for paths that don't exist as written, but that
148 /// exist under `std`. For example, wrote `str::from_utf8` instead of `std::str::from_utf8`.
149 pub confused_type_with_std_module
: FxHashMap
<Span
, Span
>,
150 pub registered_tools
: RegisteredTools
,
153 #[derive(Clone, Copy, Debug)]
154 pub struct MainDefinition
{
155 pub res
: Res
<ast
::NodeId
>,
160 impl MainDefinition
{
161 pub fn opt_fn_def_id(self) -> Option
<DefId
> {
162 if let Res
::Def(DefKind
::Fn
, def_id
) = self.res { Some(def_id) }
else { None }
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, Debug, TypeFoldable)]
178 pub enum ImplSubject
<'tcx
> {
179 Trait(TraitRef
<'tcx
>),
195 pub enum ImplPolarity
{
196 /// `impl Trait for Type`
198 /// `impl !Trait for Type`
200 /// `#[rustc_reservation_impl] impl Trait for Type`
202 /// This is a "stability hack", not a real Rust feature.
203 /// See #64631 for details.
208 /// Flips polarity by turning `Positive` into `Negative` and `Negative` into `Positive`.
209 pub fn flip(&self) -> Option
<ImplPolarity
> {
211 ImplPolarity
::Positive
=> Some(ImplPolarity
::Negative
),
212 ImplPolarity
::Negative
=> Some(ImplPolarity
::Positive
),
213 ImplPolarity
::Reservation
=> None
,
218 impl fmt
::Display
for ImplPolarity
{
219 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
221 Self::Positive
=> f
.write_str("positive"),
222 Self::Negative
=> f
.write_str("negative"),
223 Self::Reservation
=> f
.write_str("reservation"),
228 #[derive(Clone, Debug, PartialEq, Eq, Copy, Hash, TyEncodable, TyDecodable, HashStable)]
229 pub enum Visibility
{
230 /// Visible everywhere (including in other crates).
232 /// Visible only in the given crate-local module.
234 /// Not visible anywhere in the local crate. This is the visibility of private external items.
238 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable, TyEncodable, TyDecodable)]
239 pub enum BoundConstness
{
242 /// `T: ~const Trait`
244 /// Requires resolving to const only when we are in a const context.
248 impl BoundConstness
{
249 /// Reduce `self` and `constness` to two possible combined states instead of four.
250 pub fn and(&mut self, constness
: hir
::Constness
) -> hir
::Constness
{
251 match (constness
, self) {
252 (hir
::Constness
::Const
, BoundConstness
::ConstIfConst
) => hir
::Constness
::Const
,
254 *this
= BoundConstness
::NotConst
;
255 hir
::Constness
::NotConst
261 impl fmt
::Display
for BoundConstness
{
262 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
264 Self::NotConst
=> f
.write_str("normal"),
265 Self::ConstIfConst
=> f
.write_str("`~const`"),
282 pub struct ClosureSizeProfileData
<'tcx
> {
283 /// Tuple containing the types of closure captures before the feature `capture_disjoint_fields`
284 pub before_feature_tys
: Ty
<'tcx
>,
285 /// Tuple containing the types of closure captures after the feature `capture_disjoint_fields`
286 pub after_feature_tys
: Ty
<'tcx
>,
289 pub trait DefIdTree
: Copy
{
290 fn parent(self, id
: DefId
) -> Option
<DefId
>;
293 fn local_parent(self, id
: LocalDefId
) -> Option
<LocalDefId
> {
294 Some(self.parent(id
.to_def_id())?
.expect_local())
297 fn is_descendant_of(self, mut descendant
: DefId
, ancestor
: DefId
) -> bool
{
298 if descendant
.krate
!= ancestor
.krate
{
302 while descendant
!= ancestor
{
303 match self.parent(descendant
) {
304 Some(parent
) => descendant
= parent
,
305 None
=> return false,
312 impl<'tcx
> DefIdTree
for TyCtxt
<'tcx
> {
313 fn parent(self, id
: DefId
) -> Option
<DefId
> {
314 self.def_key(id
).parent
.map(|index
| DefId { index, ..id }
)
319 pub fn from_hir(visibility
: &hir
::Visibility
<'_
>, id
: hir
::HirId
, tcx
: TyCtxt
<'_
>) -> Self {
320 match visibility
.node
{
321 hir
::VisibilityKind
::Public
=> Visibility
::Public
,
322 hir
::VisibilityKind
::Crate(_
) => Visibility
::Restricted(DefId
::local(CRATE_DEF_INDEX
)),
323 hir
::VisibilityKind
::Restricted { ref path, .. }
=> match path
.res
{
324 // If there is no resolution, `resolve` will have already reported an error, so
325 // assume that the visibility is public to avoid reporting more privacy errors.
326 Res
::Err
=> Visibility
::Public
,
327 def
=> Visibility
::Restricted(def
.def_id()),
329 hir
::VisibilityKind
::Inherited
=> {
330 Visibility
::Restricted(tcx
.parent_module(id
).to_def_id())
335 /// Returns `true` if an item with this visibility is accessible from the given block.
336 pub fn is_accessible_from
<T
: DefIdTree
>(self, module
: DefId
, tree
: T
) -> bool
{
337 let restriction
= match self {
338 // Public items are visible everywhere.
339 Visibility
::Public
=> return true,
340 // Private items from other crates are visible nowhere.
341 Visibility
::Invisible
=> return false,
342 // Restricted items are visible in an arbitrary local module.
343 Visibility
::Restricted(other
) if other
.krate
!= module
.krate
=> return false,
344 Visibility
::Restricted(module
) => module
,
347 tree
.is_descendant_of(module
, restriction
)
350 /// Returns `true` if this visibility is at least as accessible as the given visibility
351 pub fn is_at_least
<T
: DefIdTree
>(self, vis
: Visibility
, tree
: T
) -> bool
{
352 let vis_restriction
= match vis
{
353 Visibility
::Public
=> return self == Visibility
::Public
,
354 Visibility
::Invisible
=> return true,
355 Visibility
::Restricted(module
) => module
,
358 self.is_accessible_from(vis_restriction
, tree
)
361 // Returns `true` if this item is visible anywhere in the local crate.
362 pub fn is_visible_locally(self) -> bool
{
364 Visibility
::Public
=> true,
365 Visibility
::Restricted(def_id
) => def_id
.is_local(),
366 Visibility
::Invisible
=> false,
370 pub fn is_public(self) -> bool
{
371 matches
!(self, Visibility
::Public
)
375 /// The crate variances map is computed during typeck and contains the
376 /// variance of every item in the local crate. You should not use it
377 /// directly, because to do so will make your pass dependent on the
378 /// HIR of every item in the local crate. Instead, use
379 /// `tcx.variances_of()` to get the variance for a *particular*
381 #[derive(HashStable, Debug)]
382 pub struct CrateVariancesMap
<'tcx
> {
383 /// For each item with generics, maps to a vector of the variance
384 /// of its generics. If an item has no generics, it will have no
386 pub variances
: FxHashMap
<DefId
, &'tcx
[ty
::Variance
]>,
389 // Contains information needed to resolve types and (in the future) look up
390 // the types of AST nodes.
391 #[derive(Copy, Clone, PartialEq, Eq, Hash)]
392 pub struct CReaderCacheKey
{
393 pub cnum
: Option
<CrateNum
>,
397 /// Represents a type.
400 /// - This is a very "dumb" struct (with no derives and no `impls`).
401 /// - Values of this type are always interned and thus unique, and are stored
402 /// as an `Interned<TyS>`.
403 /// - `Ty` (which contains a reference to a `Interned<TyS>`) or `Interned<TyS>`
404 /// should be used everywhere instead of `TyS`. In particular, `Ty` has most
405 /// of the relevant methods.
406 #[derive(PartialEq, Eq, PartialOrd, Ord)]
407 #[allow(rustc::usage_of_ty_tykind)]
408 crate struct TyS
<'tcx
> {
409 /// This field shouldn't be used directly and may be removed in the future.
410 /// Use `Ty::kind()` instead.
413 /// This field provides fast access to information that is also contained
416 /// This field shouldn't be used directly and may be removed in the future.
417 /// Use `Ty::flags()` instead.
420 /// This field provides fast access to information that is also contained
423 /// This is a kind of confusing thing: it stores the smallest
426 /// (a) the binder itself captures nothing but
427 /// (b) all the late-bound things within the type are captured
428 /// by some sub-binder.
430 /// So, for a type without any late-bound things, like `u32`, this
431 /// will be *innermost*, because that is the innermost binder that
432 /// captures nothing. But for a type `&'D u32`, where `'D` is a
433 /// late-bound region with De Bruijn index `D`, this would be `D + 1`
434 /// -- the binder itself does not capture `D`, but `D` is captured
435 /// by an inner binder.
437 /// We call this concept an "exclusive" binder `D` because all
438 /// De Bruijn indices within the type are contained within `0..D`
440 outer_exclusive_binder
: ty
::DebruijnIndex
,
442 /// The stable hash of the type. This way hashing of types will not have to work
443 /// on the address of the type anymore, but can instead just read this field
444 stable_hash
: Fingerprint
,
447 // `TyS` is used a lot. Make sure it doesn't unintentionally get bigger.
448 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
449 static_assert_size
!(TyS
<'_
>, 56);
451 /// Use this rather than `TyS`, whenever possible.
452 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)]
453 #[rustc_diagnostic_item = "Ty"]
454 #[rustc_pass_by_value]
455 pub struct Ty
<'tcx
>(Interned
<'tcx
, TyS
<'tcx
>>);
457 // Statics only used for internal testing.
458 pub static BOOL_TY
: Ty
<'
static> = Ty(Interned
::new_unchecked(&BOOL_TYS
));
459 static BOOL_TYS
: TyS
<'
static> = TyS
{
461 flags
: TypeFlags
::empty(),
462 outer_exclusive_binder
: DebruijnIndex
::from_usize(0),
463 stable_hash
: Fingerprint
::ZERO
,
466 impl<'a
, 'tcx
> HashStable
<StableHashingContext
<'a
>> for Ty
<'tcx
> {
467 fn hash_stable(&self, hcx
: &mut StableHashingContext
<'a
>, hasher
: &mut StableHasher
) {
471 // The other fields just provide fast access to information that is
472 // also contained in `kind`, so no need to hash them.
475 outer_exclusive_binder
: _
,
480 if *stable_hash
== Fingerprint
::ZERO
{
481 // No cached hash available. This can only mean that incremental is disabled.
482 // We don't cache stable hashes in non-incremental mode, because they are used
483 // so rarely that the performance actually suffers.
485 let stable_hash
: Fingerprint
= {
486 let mut hasher
= StableHasher
::new();
487 hcx
.while_hashing_spans(false, |hcx
| kind
.hash_stable(hcx
, &mut hasher
));
490 stable_hash
.hash_stable(hcx
, hasher
);
492 stable_hash
.hash_stable(hcx
, hasher
);
497 impl ty
::EarlyBoundRegion
{
498 /// Does this early bound region have a name? Early bound regions normally
499 /// always have names except when using anonymous lifetimes (`'_`).
500 pub fn has_name(&self) -> bool
{
501 self.name
!= kw
::UnderscoreLifetime
505 /// Represents a predicate.
507 /// See comments on `TyS`, which apply here too (albeit for
508 /// `PredicateS`/`Predicate` rather than `TyS`/`Ty`).
510 crate struct PredicateS
<'tcx
> {
511 kind
: Binder
<'tcx
, PredicateKind
<'tcx
>>,
513 /// See the comment for the corresponding field of [TyS].
514 outer_exclusive_binder
: ty
::DebruijnIndex
,
517 // This type is used a lot. Make sure it doesn't unintentionally get bigger.
518 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
519 static_assert_size
!(PredicateS
<'_
>, 56);
521 /// Use this rather than `PredicateS`, whenever possible.
522 #[derive(Clone, Copy, PartialEq, Eq, Hash)]
523 #[rustc_pass_by_value]
524 pub struct Predicate
<'tcx
>(Interned
<'tcx
, PredicateS
<'tcx
>>);
526 impl<'tcx
> Predicate
<'tcx
> {
527 /// Gets the inner `Binder<'tcx, PredicateKind<'tcx>>`.
529 pub fn kind(self) -> Binder
<'tcx
, PredicateKind
<'tcx
>> {
534 pub fn flags(self) -> TypeFlags
{
539 pub fn outer_exclusive_binder(self) -> DebruijnIndex
{
540 self.0.outer_exclusive_binder
543 /// Flips the polarity of a Predicate.
545 /// Given `T: Trait` predicate it returns `T: !Trait` and given `T: !Trait` returns `T: Trait`.
546 pub fn flip_polarity(self, tcx
: TyCtxt
<'tcx
>) -> Option
<Predicate
<'tcx
>> {
549 .map_bound(|kind
| match kind
{
550 PredicateKind
::Trait(TraitPredicate { trait_ref, constness, polarity }
) => {
551 Some(PredicateKind
::Trait(TraitPredicate
{
554 polarity
: polarity
.flip()?
,
562 Some(tcx
.mk_predicate(kind
))
566 impl<'a
, 'tcx
> HashStable
<StableHashingContext
<'a
>> for Predicate
<'tcx
> {
567 fn hash_stable(&self, hcx
: &mut StableHashingContext
<'a
>, hasher
: &mut StableHasher
) {
571 // The other fields just provide fast access to information that is
572 // also contained in `kind`, so no need to hash them.
574 outer_exclusive_binder
: _
,
577 kind
.hash_stable(hcx
, hasher
);
581 #[derive(Clone, Copy, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
582 #[derive(HashStable, TypeFoldable)]
583 pub enum PredicateKind
<'tcx
> {
584 /// Corresponds to `where Foo: Bar<A, B, C>`. `Foo` here would be
585 /// the `Self` type of the trait reference and `A`, `B`, and `C`
586 /// would be the type parameters.
587 Trait(TraitPredicate
<'tcx
>),
590 RegionOutlives(RegionOutlivesPredicate
<'tcx
>),
593 TypeOutlives(TypeOutlivesPredicate
<'tcx
>),
595 /// `where <T as TraitRef>::Name == X`, approximately.
596 /// See the `ProjectionPredicate` struct for details.
597 Projection(ProjectionPredicate
<'tcx
>),
599 /// No syntax: `T` well-formed.
600 WellFormed(GenericArg
<'tcx
>),
602 /// Trait must be object-safe.
605 /// No direct syntax. May be thought of as `where T: FnFoo<...>`
606 /// for some substitutions `...` and `T` being a closure type.
607 /// Satisfied (or refuted) once we know the closure's kind.
608 ClosureKind(DefId
, SubstsRef
<'tcx
>, ClosureKind
),
612 /// This obligation is created most often when we have two
613 /// unresolved type variables and hence don't have enough
614 /// information to process the subtyping obligation yet.
615 Subtype(SubtypePredicate
<'tcx
>),
617 /// `T1` coerced to `T2`
619 /// Like a subtyping obligation, this is created most often
620 /// when we have two unresolved type variables and hence
621 /// don't have enough information to process the coercion
622 /// obligation yet. At the moment, we actually process coercions
623 /// very much like subtyping and don't handle the full coercion
625 Coerce(CoercePredicate
<'tcx
>),
627 /// Constant initializer must evaluate successfully.
628 ConstEvaluatable(ty
::Unevaluated
<'tcx
, ()>),
630 /// Constants must be equal. The first component is the const that is expected.
631 ConstEquate(Const
<'tcx
>, Const
<'tcx
>),
633 /// Represents a type found in the environment that we can use for implied bounds.
635 /// Only used for Chalk.
636 TypeWellFormedFromEnv(Ty
<'tcx
>),
639 /// The crate outlives map is computed during typeck and contains the
640 /// outlives of every item in the local crate. You should not use it
641 /// directly, because to do so will make your pass dependent on the
642 /// HIR of every item in the local crate. Instead, use
643 /// `tcx.inferred_outlives_of()` to get the outlives for a *particular*
645 #[derive(HashStable, Debug)]
646 pub struct CratePredicatesMap
<'tcx
> {
647 /// For each struct with outlive bounds, maps to a vector of the
648 /// predicate of its outlive bounds. If an item has no outlives
649 /// bounds, it will have no entry.
650 pub predicates
: FxHashMap
<DefId
, &'tcx
[(Predicate
<'tcx
>, Span
)]>,
653 impl<'tcx
> Predicate
<'tcx
> {
654 /// Performs a substitution suitable for going from a
655 /// poly-trait-ref to supertraits that must hold if that
656 /// poly-trait-ref holds. This is slightly different from a normal
657 /// substitution in terms of what happens with bound regions. See
658 /// lengthy comment below for details.
659 pub fn subst_supertrait(
662 trait_ref
: &ty
::PolyTraitRef
<'tcx
>,
663 ) -> Predicate
<'tcx
> {
664 // The interaction between HRTB and supertraits is not entirely
665 // obvious. Let me walk you (and myself) through an example.
667 // Let's start with an easy case. Consider two traits:
669 // trait Foo<'a>: Bar<'a,'a> { }
670 // trait Bar<'b,'c> { }
672 // Now, if we have a trait reference `for<'x> T: Foo<'x>`, then
673 // we can deduce that `for<'x> T: Bar<'x,'x>`. Basically, if we
674 // knew that `Foo<'x>` (for any 'x) then we also know that
675 // `Bar<'x,'x>` (for any 'x). This more-or-less falls out from
676 // normal substitution.
678 // In terms of why this is sound, the idea is that whenever there
679 // is an impl of `T:Foo<'a>`, it must show that `T:Bar<'a,'a>`
680 // holds. So if there is an impl of `T:Foo<'a>` that applies to
681 // all `'a`, then we must know that `T:Bar<'a,'a>` holds for all
684 // Another example to be careful of is this:
686 // trait Foo1<'a>: for<'b> Bar1<'a,'b> { }
687 // trait Bar1<'b,'c> { }
689 // Here, if we have `for<'x> T: Foo1<'x>`, then what do we know?
690 // The answer is that we know `for<'x,'b> T: Bar1<'x,'b>`. The
691 // reason is similar to the previous example: any impl of
692 // `T:Foo1<'x>` must show that `for<'b> T: Bar1<'x, 'b>`. So
693 // basically we would want to collapse the bound lifetimes from
694 // the input (`trait_ref`) and the supertraits.
696 // To achieve this in practice is fairly straightforward. Let's
697 // consider the more complicated scenario:
699 // - We start out with `for<'x> T: Foo1<'x>`. In this case, `'x`
700 // has a De Bruijn index of 1. We want to produce `for<'x,'b> T: Bar1<'x,'b>`,
701 // where both `'x` and `'b` would have a DB index of 1.
702 // The substitution from the input trait-ref is therefore going to be
703 // `'a => 'x` (where `'x` has a DB index of 1).
704 // - The supertrait-ref is `for<'b> Bar1<'a,'b>`, where `'a` is an
705 // early-bound parameter and `'b' is a late-bound parameter with a
707 // - If we replace `'a` with `'x` from the input, it too will have
708 // a DB index of 1, and thus we'll have `for<'x,'b> Bar1<'x,'b>`
709 // just as we wanted.
711 // There is only one catch. If we just apply the substitution `'a
712 // => 'x` to `for<'b> Bar1<'a,'b>`, the substitution code will
713 // adjust the DB index because we substituting into a binder (it
714 // tries to be so smart...) resulting in `for<'x> for<'b>
715 // Bar1<'x,'b>` (we have no syntax for this, so use your
716 // imagination). Basically the 'x will have DB index of 2 and 'b
717 // will have DB index of 1. Not quite what we want. So we apply
718 // the substitution to the *contents* of the trait reference,
719 // rather than the trait reference itself (put another way, the
720 // substitution code expects equal binding levels in the values
721 // from the substitution and the value being substituted into, and
722 // this trick achieves that).
724 // Working through the second example:
725 // trait_ref: for<'x> T: Foo1<'^0.0>; substs: [T, '^0.0]
726 // predicate: for<'b> Self: Bar1<'a, '^0.0>; substs: [Self, 'a, '^0.0]
727 // We want to end up with:
728 // for<'x, 'b> T: Bar1<'^0.0, '^0.1>
730 // 1) We must shift all bound vars in predicate by the length
731 // of trait ref's bound vars. So, we would end up with predicate like
732 // Self: Bar1<'a, '^0.1>
733 // 2) We can then apply the trait substs to this, ending up with
734 // T: Bar1<'^0.0, '^0.1>
735 // 3) Finally, to create the final bound vars, we concatenate the bound
736 // vars of the trait ref with those of the predicate:
738 let bound_pred
= self.kind();
739 let pred_bound_vars
= bound_pred
.bound_vars();
740 let trait_bound_vars
= trait_ref
.bound_vars();
741 // 1) Self: Bar1<'a, '^0.0> -> Self: Bar1<'a, '^0.1>
743 tcx
.shift_bound_var_indices(trait_bound_vars
.len(), bound_pred
.skip_binder());
744 // 2) Self: Bar1<'a, '^0.1> -> T: Bar1<'^0.0, '^0.1>
745 let new
= shifted_pred
.subst(tcx
, trait_ref
.skip_binder().substs
);
746 // 3) ['x] + ['b] -> ['x, 'b]
748 tcx
.mk_bound_variable_kinds(trait_bound_vars
.iter().chain(pred_bound_vars
));
749 tcx
.reuse_or_mk_predicate(self, ty
::Binder
::bind_with_vars(new
, bound_vars
))
753 #[derive(Clone, Copy, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
754 #[derive(HashStable, TypeFoldable)]
755 pub struct TraitPredicate
<'tcx
> {
756 pub trait_ref
: TraitRef
<'tcx
>,
758 pub constness
: BoundConstness
,
760 /// If polarity is Positive: we are proving that the trait is implemented.
762 /// If polarity is Negative: we are proving that a negative impl of this trait
763 /// exists. (Note that coherence also checks whether negative impls of supertraits
764 /// exist via a series of predicates.)
766 /// If polarity is Reserved: that's a bug.
767 pub polarity
: ImplPolarity
,
770 pub type PolyTraitPredicate
<'tcx
> = ty
::Binder
<'tcx
, TraitPredicate
<'tcx
>>;
772 impl<'tcx
> TraitPredicate
<'tcx
> {
773 pub fn remap_constness(&mut self, tcx
: TyCtxt
<'tcx
>, param_env
: &mut ParamEnv
<'tcx
>) {
774 if unlikely
!(Some(self.trait_ref
.def_id
) == tcx
.lang_items().drop_trait()) {
775 // remap without changing constness of this predicate.
776 // this is because `T: ~const Drop` has a different meaning to `T: Drop`
777 // FIXME(fee1-dead): remove this logic after beta bump
778 param_env
.remap_constness_with(self.constness
)
780 *param_env
= param_env
.with_constness(self.constness
.and(param_env
.constness()))
784 /// Remap the constness of this predicate before emitting it for diagnostics.
785 pub fn remap_constness_diag(&mut self, param_env
: ParamEnv
<'tcx
>) {
786 // this is different to `remap_constness` that callees want to print this predicate
787 // in case of selection errors. `T: ~const Drop` bounds cannot end up here when the
788 // param_env is not const because we it is always satisfied in non-const contexts.
789 if let hir
::Constness
::NotConst
= param_env
.constness() {
790 self.constness
= ty
::BoundConstness
::NotConst
;
794 pub fn def_id(self) -> DefId
{
795 self.trait_ref
.def_id
798 pub fn self_ty(self) -> Ty
<'tcx
> {
799 self.trait_ref
.self_ty()
803 pub fn is_const_if_const(self) -> bool
{
804 self.constness
== BoundConstness
::ConstIfConst
808 impl<'tcx
> PolyTraitPredicate
<'tcx
> {
809 pub fn def_id(self) -> DefId
{
810 // Ok to skip binder since trait `DefId` does not care about regions.
811 self.skip_binder().def_id()
814 pub fn self_ty(self) -> ty
::Binder
<'tcx
, Ty
<'tcx
>> {
815 self.map_bound(|trait_ref
| trait_ref
.self_ty())
818 /// Remap the constness of this predicate before emitting it for diagnostics.
819 pub fn remap_constness_diag(&mut self, param_env
: ParamEnv
<'tcx
>) {
820 *self = self.map_bound(|mut p
| {
821 p
.remap_constness_diag(param_env
);
827 pub fn is_const_if_const(self) -> bool
{
828 self.skip_binder().is_const_if_const()
832 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
833 #[derive(HashStable, TypeFoldable)]
834 pub struct OutlivesPredicate
<A
, B
>(pub A
, pub B
); // `A: B`
835 pub type RegionOutlivesPredicate
<'tcx
> = OutlivesPredicate
<ty
::Region
<'tcx
>, ty
::Region
<'tcx
>>;
836 pub type TypeOutlivesPredicate
<'tcx
> = OutlivesPredicate
<Ty
<'tcx
>, ty
::Region
<'tcx
>>;
837 pub type PolyRegionOutlivesPredicate
<'tcx
> = ty
::Binder
<'tcx
, RegionOutlivesPredicate
<'tcx
>>;
838 pub type PolyTypeOutlivesPredicate
<'tcx
> = ty
::Binder
<'tcx
, TypeOutlivesPredicate
<'tcx
>>;
840 /// Encodes that `a` must be a subtype of `b`. The `a_is_expected` flag indicates
841 /// whether the `a` type is the type that we should label as "expected" when
842 /// presenting user diagnostics.
843 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, TyEncodable, TyDecodable)]
844 #[derive(HashStable, TypeFoldable)]
845 pub struct SubtypePredicate
<'tcx
> {
846 pub a_is_expected
: bool
,
850 pub type PolySubtypePredicate
<'tcx
> = ty
::Binder
<'tcx
, SubtypePredicate
<'tcx
>>;
852 /// Encodes that we have to coerce *from* the `a` type to the `b` type.
853 #[derive(Clone, Copy, PartialEq, Eq, Hash, Debug, TyEncodable, TyDecodable)]
854 #[derive(HashStable, TypeFoldable)]
855 pub struct CoercePredicate
<'tcx
> {
859 pub type PolyCoercePredicate
<'tcx
> = ty
::Binder
<'tcx
, CoercePredicate
<'tcx
>>;
861 #[derive(Debug, Copy, Clone, PartialEq, Eq, Hash, PartialOrd, Ord, TyEncodable, TyDecodable)]
862 #[derive(HashStable, TypeFoldable)]
863 pub enum Term
<'tcx
> {
868 impl<'tcx
> From
<Ty
<'tcx
>> for Term
<'tcx
> {
869 fn from(ty
: Ty
<'tcx
>) -> Self {
874 impl<'tcx
> From
<Const
<'tcx
>> for Term
<'tcx
> {
875 fn from(c
: Const
<'tcx
>) -> Self {
880 impl<'tcx
> Term
<'tcx
> {
881 pub fn ty(&self) -> Option
<Ty
<'tcx
>> {
882 if let Term
::Ty(ty
) = self { Some(*ty) }
else { None }
884 pub fn ct(&self) -> Option
<Const
<'tcx
>> {
885 if let Term
::Const(c
) = self { Some(*c) }
else { None }
889 /// This kind of predicate has no *direct* correspondent in the
890 /// syntax, but it roughly corresponds to the syntactic forms:
892 /// 1. `T: TraitRef<..., Item = Type>`
893 /// 2. `<T as TraitRef<...>>::Item == Type` (NYI)
895 /// In particular, form #1 is "desugared" to the combination of a
896 /// normal trait predicate (`T: TraitRef<...>`) and one of these
897 /// predicates. Form #2 is a broader form in that it also permits
898 /// equality between arbitrary types. Processing an instance of
899 /// Form #2 eventually yields one of these `ProjectionPredicate`
900 /// instances to normalize the LHS.
901 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable)]
902 #[derive(HashStable, TypeFoldable)]
903 pub struct ProjectionPredicate
<'tcx
> {
904 pub projection_ty
: ProjectionTy
<'tcx
>,
905 pub term
: Term
<'tcx
>,
908 pub type PolyProjectionPredicate
<'tcx
> = Binder
<'tcx
, ProjectionPredicate
<'tcx
>>;
910 impl<'tcx
> PolyProjectionPredicate
<'tcx
> {
911 /// Returns the `DefId` of the trait of the associated item being projected.
913 pub fn trait_def_id(&self, tcx
: TyCtxt
<'tcx
>) -> DefId
{
914 self.skip_binder().projection_ty
.trait_def_id(tcx
)
917 /// Get the [PolyTraitRef] required for this projection to be well formed.
918 /// Note that for generic associated types the predicates of the associated
919 /// type also need to be checked.
921 pub fn required_poly_trait_ref(&self, tcx
: TyCtxt
<'tcx
>) -> PolyTraitRef
<'tcx
> {
922 // Note: unlike with `TraitRef::to_poly_trait_ref()`,
923 // `self.0.trait_ref` is permitted to have escaping regions.
924 // This is because here `self` has a `Binder` and so does our
925 // return value, so we are preserving the number of binding
927 self.map_bound(|predicate
| predicate
.projection_ty
.trait_ref(tcx
))
930 pub fn term(&self) -> Binder
<'tcx
, Term
<'tcx
>> {
931 self.map_bound(|predicate
| predicate
.term
)
934 /// The `DefId` of the `TraitItem` for the associated type.
936 /// Note that this is not the `DefId` of the `TraitRef` containing this
937 /// associated type, which is in `tcx.associated_item(projection_def_id()).container`.
938 pub fn projection_def_id(&self) -> DefId
{
939 // Ok to skip binder since trait `DefId` does not care about regions.
940 self.skip_binder().projection_ty
.item_def_id
944 pub trait ToPolyTraitRef
<'tcx
> {
945 fn to_poly_trait_ref(&self) -> PolyTraitRef
<'tcx
>;
948 impl<'tcx
> ToPolyTraitRef
<'tcx
> for PolyTraitPredicate
<'tcx
> {
949 fn to_poly_trait_ref(&self) -> PolyTraitRef
<'tcx
> {
950 self.map_bound_ref(|trait_pred
| trait_pred
.trait_ref
)
954 pub trait ToPredicate
<'tcx
> {
955 fn to_predicate(self, tcx
: TyCtxt
<'tcx
>) -> Predicate
<'tcx
>;
958 impl<'tcx
> ToPredicate
<'tcx
> for Binder
<'tcx
, PredicateKind
<'tcx
>> {
960 fn to_predicate(self, tcx
: TyCtxt
<'tcx
>) -> Predicate
<'tcx
> {
961 tcx
.mk_predicate(self)
965 impl<'tcx
> ToPredicate
<'tcx
> for PolyTraitPredicate
<'tcx
> {
966 fn to_predicate(self, tcx
: TyCtxt
<'tcx
>) -> Predicate
<'tcx
> {
967 self.map_bound(PredicateKind
::Trait
).to_predicate(tcx
)
971 impl<'tcx
> ToPredicate
<'tcx
> for PolyRegionOutlivesPredicate
<'tcx
> {
972 fn to_predicate(self, tcx
: TyCtxt
<'tcx
>) -> Predicate
<'tcx
> {
973 self.map_bound(PredicateKind
::RegionOutlives
).to_predicate(tcx
)
977 impl<'tcx
> ToPredicate
<'tcx
> for PolyTypeOutlivesPredicate
<'tcx
> {
978 fn to_predicate(self, tcx
: TyCtxt
<'tcx
>) -> Predicate
<'tcx
> {
979 self.map_bound(PredicateKind
::TypeOutlives
).to_predicate(tcx
)
983 impl<'tcx
> ToPredicate
<'tcx
> for PolyProjectionPredicate
<'tcx
> {
984 fn to_predicate(self, tcx
: TyCtxt
<'tcx
>) -> Predicate
<'tcx
> {
985 self.map_bound(PredicateKind
::Projection
).to_predicate(tcx
)
989 impl<'tcx
> Predicate
<'tcx
> {
990 pub fn to_opt_poly_trait_pred(self) -> Option
<PolyTraitPredicate
<'tcx
>> {
991 let predicate
= self.kind();
992 match predicate
.skip_binder() {
993 PredicateKind
::Trait(t
) => Some(predicate
.rebind(t
)),
994 PredicateKind
::Projection(..)
995 | PredicateKind
::Subtype(..)
996 | PredicateKind
::Coerce(..)
997 | PredicateKind
::RegionOutlives(..)
998 | PredicateKind
::WellFormed(..)
999 | PredicateKind
::ObjectSafe(..)
1000 | PredicateKind
::ClosureKind(..)
1001 | PredicateKind
::TypeOutlives(..)
1002 | PredicateKind
::ConstEvaluatable(..)
1003 | PredicateKind
::ConstEquate(..)
1004 | PredicateKind
::TypeWellFormedFromEnv(..) => None
,
1008 pub fn to_opt_type_outlives(self) -> Option
<PolyTypeOutlivesPredicate
<'tcx
>> {
1009 let predicate
= self.kind();
1010 match predicate
.skip_binder() {
1011 PredicateKind
::TypeOutlives(data
) => Some(predicate
.rebind(data
)),
1012 PredicateKind
::Trait(..)
1013 | PredicateKind
::Projection(..)
1014 | PredicateKind
::Subtype(..)
1015 | PredicateKind
::Coerce(..)
1016 | PredicateKind
::RegionOutlives(..)
1017 | PredicateKind
::WellFormed(..)
1018 | PredicateKind
::ObjectSafe(..)
1019 | PredicateKind
::ClosureKind(..)
1020 | PredicateKind
::ConstEvaluatable(..)
1021 | PredicateKind
::ConstEquate(..)
1022 | PredicateKind
::TypeWellFormedFromEnv(..) => None
,
1027 /// Represents the bounds declared on a particular set of type
1028 /// parameters. Should eventually be generalized into a flag list of
1029 /// where-clauses. You can obtain an `InstantiatedPredicates` list from a
1030 /// `GenericPredicates` by using the `instantiate` method. Note that this method
1031 /// reflects an important semantic invariant of `InstantiatedPredicates`: while
1032 /// the `GenericPredicates` are expressed in terms of the bound type
1033 /// parameters of the impl/trait/whatever, an `InstantiatedPredicates` instance
1034 /// represented a set of bounds for some particular instantiation,
1035 /// meaning that the generic parameters have been substituted with
1040 /// struct Foo<T, U: Bar<T>> { ... }
1042 /// Here, the `GenericPredicates` for `Foo` would contain a list of bounds like
1043 /// `[[], [U:Bar<T>]]`. Now if there were some particular reference
1044 /// like `Foo<isize,usize>`, then the `InstantiatedPredicates` would be `[[],
1045 /// [usize:Bar<isize>]]`.
1046 #[derive(Clone, Debug, TypeFoldable)]
1047 pub struct InstantiatedPredicates
<'tcx
> {
1048 pub predicates
: Vec
<Predicate
<'tcx
>>,
1049 pub spans
: Vec
<Span
>,
1052 impl<'tcx
> InstantiatedPredicates
<'tcx
> {
1053 pub fn empty() -> InstantiatedPredicates
<'tcx
> {
1054 InstantiatedPredicates { predicates: vec![], spans: vec![] }
1057 pub fn is_empty(&self) -> bool
{
1058 self.predicates
.is_empty()
1074 pub struct OpaqueTypeKey
<'tcx
> {
1076 pub substs
: SubstsRef
<'tcx
>,
1079 #[derive(Copy, Clone, Debug, TypeFoldable, HashStable, TyEncodable, TyDecodable)]
1080 pub struct OpaqueHiddenType
<'tcx
> {
1081 /// The span of this particular definition of the opaque type. So
1084 /// ```ignore (incomplete snippet)
1085 /// type Foo = impl Baz;
1086 /// fn bar() -> Foo {
1087 /// // ^^^ This is the span we are looking for!
1091 /// In cases where the fn returns `(impl Trait, impl Trait)` or
1092 /// other such combinations, the result is currently
1093 /// over-approximated, but better than nothing.
1096 /// The type variable that represents the value of the opaque type
1097 /// that we require. In other words, after we compile this function,
1098 /// we will be created a constraint like:
1102 /// where `?C` is the value of this type variable. =) It may
1103 /// naturally refer to the type and lifetime parameters in scope
1104 /// in this function, though ultimately it should only reference
1105 /// those that are arguments to `Foo` in the constraint above. (In
1106 /// other words, `?C` should not include `'b`, even though it's a
1107 /// lifetime parameter on `foo`.)
1111 rustc_index
::newtype_index
! {
1112 /// "Universes" are used during type- and trait-checking in the
1113 /// presence of `for<..>` binders to control what sets of names are
1114 /// visible. Universes are arranged into a tree: the root universe
1115 /// contains names that are always visible. Each child then adds a new
1116 /// set of names that are visible, in addition to those of its parent.
1117 /// We say that the child universe "extends" the parent universe with
1120 /// To make this more concrete, consider this program:
1124 /// fn bar<T>(x: T) {
1125 /// let y: for<'a> fn(&'a u8, Foo) = ...;
1129 /// The struct name `Foo` is in the root universe U0. But the type
1130 /// parameter `T`, introduced on `bar`, is in an extended universe U1
1131 /// -- i.e., within `bar`, we can name both `T` and `Foo`, but outside
1132 /// of `bar`, we cannot name `T`. Then, within the type of `y`, the
1133 /// region `'a` is in a universe U2 that extends U1, because we can
1134 /// name it inside the fn type but not outside.
1136 /// Universes are used to do type- and trait-checking around these
1137 /// "forall" binders (also called **universal quantification**). The
1138 /// idea is that when, in the body of `bar`, we refer to `T` as a
1139 /// type, we aren't referring to any type in particular, but rather a
1140 /// kind of "fresh" type that is distinct from all other types we have
1141 /// actually declared. This is called a **placeholder** type, and we
1142 /// use universes to talk about this. In other words, a type name in
1143 /// universe 0 always corresponds to some "ground" type that the user
1144 /// declared, but a type name in a non-zero universe is a placeholder
1145 /// type -- an idealized representative of "types in general" that we
1146 /// use for checking generic functions.
1147 pub struct UniverseIndex
{
1149 DEBUG_FORMAT
= "U{}",
1153 impl UniverseIndex
{
1154 pub const ROOT
: UniverseIndex
= UniverseIndex
::from_u32(0);
1156 /// Returns the "next" universe index in order -- this new index
1157 /// is considered to extend all previous universes. This
1158 /// corresponds to entering a `forall` quantifier. So, for
1159 /// example, suppose we have this type in universe `U`:
1162 /// for<'a> fn(&'a u32)
1165 /// Once we "enter" into this `for<'a>` quantifier, we are in a
1166 /// new universe that extends `U` -- in this new universe, we can
1167 /// name the region `'a`, but that region was not nameable from
1168 /// `U` because it was not in scope there.
1169 pub fn next_universe(self) -> UniverseIndex
{
1170 UniverseIndex
::from_u32(self.private
.checked_add(1).unwrap())
1173 /// Returns `true` if `self` can name a name from `other` -- in other words,
1174 /// if the set of names in `self` is a superset of those in
1175 /// `other` (`self >= other`).
1176 pub fn can_name(self, other
: UniverseIndex
) -> bool
{
1177 self.private
>= other
.private
1180 /// Returns `true` if `self` cannot name some names from `other` -- in other
1181 /// words, if the set of names in `self` is a strict subset of
1182 /// those in `other` (`self < other`).
1183 pub fn cannot_name(self, other
: UniverseIndex
) -> bool
{
1184 self.private
< other
.private
1188 /// The "placeholder index" fully defines a placeholder region, type, or const. Placeholders are
1189 /// identified by both a universe, as well as a name residing within that universe. Distinct bound
1190 /// regions/types/consts within the same universe simply have an unknown relationship to one
1192 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TyEncodable, TyDecodable, PartialOrd, Ord)]
1193 pub struct Placeholder
<T
> {
1194 pub universe
: UniverseIndex
,
1198 impl<'a
, T
> HashStable
<StableHashingContext
<'a
>> for Placeholder
<T
>
1200 T
: HashStable
<StableHashingContext
<'a
>>,
1202 fn hash_stable(&self, hcx
: &mut StableHashingContext
<'a
>, hasher
: &mut StableHasher
) {
1203 self.universe
.hash_stable(hcx
, hasher
);
1204 self.name
.hash_stable(hcx
, hasher
);
1208 pub type PlaceholderRegion
= Placeholder
<BoundRegionKind
>;
1210 pub type PlaceholderType
= Placeholder
<BoundVar
>;
1212 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, HashStable)]
1213 #[derive(TyEncodable, TyDecodable, PartialOrd, Ord)]
1214 pub struct BoundConst
<'tcx
> {
1219 pub type PlaceholderConst
<'tcx
> = Placeholder
<BoundConst
<'tcx
>>;
1221 /// A `DefId` which, in case it is a const argument, is potentially bundled with
1222 /// the `DefId` of the generic parameter it instantiates.
1224 /// This is used to avoid calls to `type_of` for const arguments during typeck
1225 /// which cause cycle errors.
1230 /// fn foo<const N: usize>(&self) -> [u8; N] { [0; N] }
1231 /// // ^ const parameter
1235 /// fn foo<const M: u8>(&self) -> usize { 42 }
1236 /// // ^ const parameter
1241 /// let _b = a.foo::<{ 3 + 7 }>();
1242 /// // ^^^^^^^^^ const argument
1246 /// Let's look at the call `a.foo::<{ 3 + 7 }>()` here. We do not know
1247 /// which `foo` is used until we know the type of `a`.
1249 /// We only know the type of `a` once we are inside of `typeck(main)`.
1250 /// We also end up normalizing the type of `_b` during `typeck(main)` which
1251 /// requires us to evaluate the const argument.
1253 /// To evaluate that const argument we need to know its type,
1254 /// which we would get using `type_of(const_arg)`. This requires us to
1255 /// resolve `foo` as it can be either `usize` or `u8` in this example.
1256 /// However, resolving `foo` once again requires `typeck(main)` to get the type of `a`,
1257 /// which results in a cycle.
1259 /// In short we must not call `type_of(const_arg)` during `typeck(main)`.
1261 /// When first creating the `ty::Const` of the const argument inside of `typeck` we have
1262 /// already resolved `foo` so we know which const parameter this argument instantiates.
1263 /// This means that we also know the expected result of `type_of(const_arg)` even if we
1264 /// aren't allowed to call that query: it is equal to `type_of(const_param)` which is
1265 /// trivial to compute.
1267 /// If we now want to use that constant in a place which potentially needs its type
1268 /// we also pass the type of its `const_param`. This is the point of `WithOptConstParam`,
1269 /// except that instead of a `Ty` we bundle the `DefId` of the const parameter.
1270 /// Meaning that we need to use `type_of(const_param_did)` if `const_param_did` is `Some`
1271 /// to get the type of `did`.
1272 #[derive(Copy, Clone, Debug, TypeFoldable, Lift, TyEncodable, TyDecodable)]
1273 #[derive(PartialEq, Eq, PartialOrd, Ord)]
1274 #[derive(Hash, HashStable)]
1275 pub struct WithOptConstParam
<T
> {
1277 /// The `DefId` of the corresponding generic parameter in case `did` is
1278 /// a const argument.
1280 /// Note that even if `did` is a const argument, this may still be `None`.
1281 /// All queries taking `WithOptConstParam` start by calling `tcx.opt_const_param_of(def.did)`
1282 /// to potentially update `param_did` in the case it is `None`.
1283 pub const_param_did
: Option
<DefId
>,
1286 impl<T
> WithOptConstParam
<T
> {
1287 /// Creates a new `WithOptConstParam` setting `const_param_did` to `None`.
1289 pub fn unknown(did
: T
) -> WithOptConstParam
<T
> {
1290 WithOptConstParam { did, const_param_did: None }
1294 impl WithOptConstParam
<LocalDefId
> {
1295 /// Returns `Some((did, param_did))` if `def_id` is a const argument,
1296 /// `None` otherwise.
1298 pub fn try_lookup(did
: LocalDefId
, tcx
: TyCtxt
<'_
>) -> Option
<(LocalDefId
, DefId
)> {
1299 tcx
.opt_const_param_of(did
).map(|param_did
| (did
, param_did
))
1302 /// In case `self` is unknown but `self.did` is a const argument, this returns
1303 /// a `WithOptConstParam` with the correct `const_param_did`.
1305 pub fn try_upgrade(self, tcx
: TyCtxt
<'_
>) -> Option
<WithOptConstParam
<LocalDefId
>> {
1306 if self.const_param_did
.is_none() {
1307 if let const_param_did @
Some(_
) = tcx
.opt_const_param_of(self.did
) {
1308 return Some(WithOptConstParam { did: self.did, const_param_did }
);
1315 pub fn to_global(self) -> WithOptConstParam
<DefId
> {
1316 WithOptConstParam { did: self.did.to_def_id(), const_param_did: self.const_param_did }
1319 pub fn def_id_for_type_of(self) -> DefId
{
1320 if let Some(did
) = self.const_param_did { did }
else { self.did.to_def_id() }
1324 impl WithOptConstParam
<DefId
> {
1325 pub fn as_local(self) -> Option
<WithOptConstParam
<LocalDefId
>> {
1328 .map(|did
| WithOptConstParam { did, const_param_did: self.const_param_did }
)
1331 pub fn as_const_arg(self) -> Option
<(LocalDefId
, DefId
)> {
1332 if let Some(param_did
) = self.const_param_did
{
1333 if let Some(did
) = self.did
.as_local() {
1334 return Some((did
, param_did
));
1341 pub fn is_local(self) -> bool
{
1345 pub fn def_id_for_type_of(self) -> DefId
{
1346 self.const_param_did
.unwrap_or(self.did
)
1350 /// When type checking, we use the `ParamEnv` to track
1351 /// details about the set of where-clauses that are in scope at this
1352 /// particular point.
1353 #[derive(Copy, Clone, Hash, PartialEq, Eq)]
1354 pub struct ParamEnv
<'tcx
> {
1355 /// This packs both caller bounds and the reveal enum into one pointer.
1357 /// Caller bounds are `Obligation`s that the caller must satisfy. This is
1358 /// basically the set of bounds on the in-scope type parameters, translated
1359 /// into `Obligation`s, and elaborated and normalized.
1361 /// Use the `caller_bounds()` method to access.
1363 /// Typically, this is `Reveal::UserFacing`, but during codegen we
1364 /// want `Reveal::All`.
1366 /// Note: This is packed, use the reveal() method to access it.
1367 packed
: CopyTaggedPtr
<&'tcx List
<Predicate
<'tcx
>>, ParamTag
, true>,
1370 #[derive(Copy, Clone)]
1372 reveal
: traits
::Reveal
,
1373 constness
: hir
::Constness
,
1376 unsafe impl rustc_data_structures
::tagged_ptr
::Tag
for ParamTag
{
1377 const BITS
: usize = 2;
1379 fn into_usize(self) -> usize {
1381 Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::NotConst }
=> 0,
1382 Self { reveal: traits::Reveal::All, constness: hir::Constness::NotConst }
=> 1,
1383 Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::Const }
=> 2,
1384 Self { reveal: traits::Reveal::All, constness: hir::Constness::Const }
=> 3,
1388 unsafe fn from_usize(ptr
: usize) -> Self {
1390 0 => Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::NotConst }
,
1391 1 => Self { reveal: traits::Reveal::All, constness: hir::Constness::NotConst }
,
1392 2 => Self { reveal: traits::Reveal::UserFacing, constness: hir::Constness::Const }
,
1393 3 => Self { reveal: traits::Reveal::All, constness: hir::Constness::Const }
,
1394 _
=> std
::hint
::unreachable_unchecked(),
1399 impl<'tcx
> fmt
::Debug
for ParamEnv
<'tcx
> {
1400 fn fmt(&self, f
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
1401 f
.debug_struct("ParamEnv")
1402 .field("caller_bounds", &self.caller_bounds())
1403 .field("reveal", &self.reveal())
1404 .field("constness", &self.constness())
1409 impl<'a
, 'tcx
> HashStable
<StableHashingContext
<'a
>> for ParamEnv
<'tcx
> {
1410 fn hash_stable(&self, hcx
: &mut StableHashingContext
<'a
>, hasher
: &mut StableHasher
) {
1411 self.caller_bounds().hash_stable(hcx
, hasher
);
1412 self.reveal().hash_stable(hcx
, hasher
);
1413 self.constness().hash_stable(hcx
, hasher
);
1417 impl<'tcx
> TypeFoldable
<'tcx
> for ParamEnv
<'tcx
> {
1418 fn try_super_fold_with
<F
: ty
::fold
::FallibleTypeFolder
<'tcx
>>(
1421 ) -> Result
<Self, F
::Error
> {
1423 self.caller_bounds().try_fold_with(folder
)?
,
1424 self.reveal().try_fold_with(folder
)?
,
1425 self.constness().try_fold_with(folder
)?
,
1429 fn super_visit_with
<V
: TypeVisitor
<'tcx
>>(&self, visitor
: &mut V
) -> ControlFlow
<V
::BreakTy
> {
1430 self.caller_bounds().visit_with(visitor
)?
;
1431 self.reveal().visit_with(visitor
)?
;
1432 self.constness().visit_with(visitor
)
1436 impl<'tcx
> ParamEnv
<'tcx
> {
1437 /// Construct a trait environment suitable for contexts where
1438 /// there are no where-clauses in scope. Hidden types (like `impl
1439 /// Trait`) are left hidden, so this is suitable for ordinary
1442 pub fn empty() -> Self {
1443 Self::new(List
::empty(), Reveal
::UserFacing
, hir
::Constness
::NotConst
)
1447 pub fn caller_bounds(self) -> &'tcx List
<Predicate
<'tcx
>> {
1448 self.packed
.pointer()
1452 pub fn reveal(self) -> traits
::Reveal
{
1453 self.packed
.tag().reveal
1457 pub fn constness(self) -> hir
::Constness
{
1458 self.packed
.tag().constness
1462 pub fn is_const(self) -> bool
{
1463 self.packed
.tag().constness
== hir
::Constness
::Const
1466 /// Construct a trait environment with no where-clauses in scope
1467 /// where the values of all `impl Trait` and other hidden types
1468 /// are revealed. This is suitable for monomorphized, post-typeck
1469 /// environments like codegen or doing optimizations.
1471 /// N.B., if you want to have predicates in scope, use `ParamEnv::new`,
1472 /// or invoke `param_env.with_reveal_all()`.
1474 pub fn reveal_all() -> Self {
1475 Self::new(List
::empty(), Reveal
::All
, hir
::Constness
::NotConst
)
1478 /// Construct a trait environment with the given set of predicates.
1481 caller_bounds
: &'tcx List
<Predicate
<'tcx
>>,
1483 constness
: hir
::Constness
,
1485 ty
::ParamEnv { packed: CopyTaggedPtr::new(caller_bounds, ParamTag { reveal, constness }
) }
1488 pub fn with_user_facing(mut self) -> Self {
1489 self.packed
.set_tag(ParamTag { reveal: Reveal::UserFacing, ..self.packed.tag() }
);
1494 pub fn with_constness(mut self, constness
: hir
::Constness
) -> Self {
1495 self.packed
.set_tag(ParamTag { constness, ..self.packed.tag() }
);
1500 pub fn with_const(mut self) -> Self {
1501 self.packed
.set_tag(ParamTag { constness: hir::Constness::Const, ..self.packed.tag() }
);
1506 pub fn without_const(mut self) -> Self {
1507 self.packed
.set_tag(ParamTag { constness: hir::Constness::NotConst, ..self.packed.tag() }
);
1512 pub fn remap_constness_with(&mut self, mut constness
: ty
::BoundConstness
) {
1513 *self = self.with_constness(constness
.and(self.constness()))
1516 /// Returns a new parameter environment with the same clauses, but
1517 /// which "reveals" the true results of projections in all cases
1518 /// (even for associated types that are specializable). This is
1519 /// the desired behavior during codegen and certain other special
1520 /// contexts; normally though we want to use `Reveal::UserFacing`,
1521 /// which is the default.
1522 /// All opaque types in the caller_bounds of the `ParamEnv`
1523 /// will be normalized to their underlying types.
1524 /// See PR #65989 and issue #65918 for more details
1525 pub fn with_reveal_all_normalized(self, tcx
: TyCtxt
<'tcx
>) -> Self {
1526 if self.packed
.tag().reveal
== traits
::Reveal
::All
{
1531 tcx
.normalize_opaque_types(self.caller_bounds()),
1537 /// Returns this same environment but with no caller bounds.
1539 pub fn without_caller_bounds(self) -> Self {
1540 Self::new(List
::empty(), self.reveal(), self.constness())
1543 /// Creates a suitable environment in which to perform trait
1544 /// queries on the given value. When type-checking, this is simply
1545 /// the pair of the environment plus value. But when reveal is set to
1546 /// All, then if `value` does not reference any type parameters, we will
1547 /// pair it with the empty environment. This improves caching and is generally
1550 /// N.B., we preserve the environment when type-checking because it
1551 /// is possible for the user to have wacky where-clauses like
1552 /// `where Box<u32>: Copy`, which are clearly never
1553 /// satisfiable. We generally want to behave as if they were true,
1554 /// although the surrounding function is never reachable.
1555 pub fn and
<T
: TypeFoldable
<'tcx
>>(self, value
: T
) -> ParamEnvAnd
<'tcx
, T
> {
1556 match self.reveal() {
1557 Reveal
::UserFacing
=> ParamEnvAnd { param_env: self, value }
,
1560 if value
.is_global() {
1561 ParamEnvAnd { param_env: self.without_caller_bounds(), value }
1563 ParamEnvAnd { param_env: self, value }
1570 // FIXME(ecstaticmorse): Audit all occurrences of `without_const().to_predicate(tcx)` to ensure that
1571 // the constness of trait bounds is being propagated correctly.
1572 impl<'tcx
> PolyTraitRef
<'tcx
> {
1574 pub fn with_constness(self, constness
: BoundConstness
) -> PolyTraitPredicate
<'tcx
> {
1575 self.map_bound(|trait_ref
| ty
::TraitPredicate
{
1578 polarity
: ty
::ImplPolarity
::Positive
,
1583 pub fn without_const(self) -> PolyTraitPredicate
<'tcx
> {
1584 self.with_constness(BoundConstness
::NotConst
)
1588 #[derive(Copy, Clone, Debug, PartialEq, Eq, Hash, TypeFoldable)]
1589 pub struct ParamEnvAnd
<'tcx
, T
> {
1590 pub param_env
: ParamEnv
<'tcx
>,
1594 impl<'tcx
, T
> ParamEnvAnd
<'tcx
, T
> {
1595 pub fn into_parts(self) -> (ParamEnv
<'tcx
>, T
) {
1596 (self.param_env
, self.value
)
1600 pub fn without_const(mut self) -> Self {
1601 self.param_env
= self.param_env
.without_const();
1606 impl<'a
, 'tcx
, T
> HashStable
<StableHashingContext
<'a
>> for ParamEnvAnd
<'tcx
, T
>
1608 T
: HashStable
<StableHashingContext
<'a
>>,
1610 fn hash_stable(&self, hcx
: &mut StableHashingContext
<'a
>, hasher
: &mut StableHasher
) {
1611 let ParamEnvAnd { ref param_env, ref value }
= *self;
1613 param_env
.hash_stable(hcx
, hasher
);
1614 value
.hash_stable(hcx
, hasher
);
1618 #[derive(Copy, Clone, Debug, HashStable)]
1619 pub struct Destructor
{
1620 /// The `DefId` of the destructor method
1622 /// The constness of the destructor method
1623 pub constness
: hir
::Constness
,
1627 #[derive(HashStable, TyEncodable, TyDecodable)]
1628 pub struct VariantFlags
: u32 {
1629 const NO_VARIANT_FLAGS
= 0;
1630 /// Indicates whether the field list of this variant is `#[non_exhaustive]`.
1631 const IS_FIELD_LIST_NON_EXHAUSTIVE
= 1 << 0;
1632 /// Indicates whether this variant was obtained as part of recovering from
1633 /// a syntactic error. May be incomplete or bogus.
1634 const IS_RECOVERED
= 1 << 1;
1638 /// Definition of a variant -- a struct's fields or an enum variant.
1639 #[derive(Debug, HashStable, TyEncodable, TyDecodable)]
1640 pub struct VariantDef
{
1641 /// `DefId` that identifies the variant itself.
1642 /// If this variant belongs to a struct or union, then this is a copy of its `DefId`.
1644 /// `DefId` that identifies the variant's constructor.
1645 /// If this variant is a struct variant, then this is `None`.
1646 pub ctor_def_id
: Option
<DefId
>,
1647 /// Variant or struct name.
1649 /// Discriminant of this variant.
1650 pub discr
: VariantDiscr
,
1651 /// Fields of this variant.
1652 pub fields
: Vec
<FieldDef
>,
1653 /// Type of constructor of variant.
1654 pub ctor_kind
: CtorKind
,
1655 /// Flags of the variant (e.g. is field list non-exhaustive)?
1656 flags
: VariantFlags
,
1660 /// Creates a new `VariantDef`.
1662 /// `variant_did` is the `DefId` that identifies the enum variant (if this `VariantDef`
1663 /// represents an enum variant).
1665 /// `ctor_did` is the `DefId` that identifies the constructor of unit or
1666 /// tuple-variants/structs. If this is a `struct`-variant then this should be `None`.
1668 /// `parent_did` is the `DefId` of the `AdtDef` representing the enum or struct that
1669 /// owns this variant. It is used for checking if a struct has `#[non_exhaustive]` w/out having
1670 /// to go through the redirect of checking the ctor's attributes - but compiling a small crate
1671 /// requires loading the `AdtDef`s for all the structs in the universe (e.g., coherence for any
1672 /// built-in trait), and we do not want to load attributes twice.
1674 /// If someone speeds up attribute loading to not be a performance concern, they can
1675 /// remove this hack and use the constructor `DefId` everywhere.
1678 variant_did
: Option
<DefId
>,
1679 ctor_def_id
: Option
<DefId
>,
1680 discr
: VariantDiscr
,
1681 fields
: Vec
<FieldDef
>,
1682 ctor_kind
: CtorKind
,
1686 is_field_list_non_exhaustive
: bool
,
1689 "VariantDef::new(name = {:?}, variant_did = {:?}, ctor_def_id = {:?}, discr = {:?},
1690 fields = {:?}, ctor_kind = {:?}, adt_kind = {:?}, parent_did = {:?})",
1691 name
, variant_did
, ctor_def_id
, discr
, fields
, ctor_kind
, adt_kind
, parent_did
,
1694 let mut flags
= VariantFlags
::NO_VARIANT_FLAGS
;
1695 if is_field_list_non_exhaustive
{
1696 flags
|= VariantFlags
::IS_FIELD_LIST_NON_EXHAUSTIVE
;
1700 flags
|= VariantFlags
::IS_RECOVERED
;
1704 def_id
: variant_did
.unwrap_or(parent_did
),
1714 /// Is this field list non-exhaustive?
1716 pub fn is_field_list_non_exhaustive(&self) -> bool
{
1717 self.flags
.intersects(VariantFlags
::IS_FIELD_LIST_NON_EXHAUSTIVE
)
1720 /// Was this variant obtained as part of recovering from a syntactic error?
1722 pub fn is_recovered(&self) -> bool
{
1723 self.flags
.intersects(VariantFlags
::IS_RECOVERED
)
1726 /// Computes the `Ident` of this variant by looking up the `Span`
1727 pub fn ident(&self, tcx
: TyCtxt
<'_
>) -> Ident
{
1728 Ident
::new(self.name
, tcx
.def_ident_span(self.def_id
).unwrap())
1732 #[derive(Copy, Clone, Debug, PartialEq, Eq, TyEncodable, TyDecodable, HashStable)]
1733 pub enum VariantDiscr
{
1734 /// Explicit value for this variant, i.e., `X = 123`.
1735 /// The `DefId` corresponds to the embedded constant.
1738 /// The previous variant's discriminant plus one.
1739 /// For efficiency reasons, the distance from the
1740 /// last `Explicit` discriminant is being stored,
1741 /// or `0` for the first variant, if it has none.
1745 #[derive(Debug, HashStable, TyEncodable, TyDecodable)]
1746 pub struct FieldDef
{
1749 pub vis
: Visibility
,
1753 #[derive(TyEncodable, TyDecodable, Default, HashStable)]
1754 pub struct ReprFlags
: u8 {
1755 const IS_C
= 1 << 0;
1756 const IS_SIMD
= 1 << 1;
1757 const IS_TRANSPARENT
= 1 << 2;
1758 // Internal only for now. If true, don't reorder fields.
1759 const IS_LINEAR
= 1 << 3;
1760 // If true, don't expose any niche to type's context.
1761 const HIDE_NICHE
= 1 << 4;
1762 // If true, the type's layout can be randomized using
1763 // the seed stored in `ReprOptions.layout_seed`
1764 const RANDOMIZE_LAYOUT
= 1 << 5;
1765 // Any of these flags being set prevent field reordering optimisation.
1766 const IS_UNOPTIMISABLE
= ReprFlags
::IS_C
.bits
1767 | ReprFlags
::IS_SIMD
.bits
1768 | ReprFlags
::IS_LINEAR
.bits
;
1772 /// Represents the repr options provided by the user,
1773 #[derive(Copy, Clone, Debug, Eq, PartialEq, TyEncodable, TyDecodable, Default, HashStable)]
1774 pub struct ReprOptions
{
1775 pub int
: Option
<attr
::IntType
>,
1776 pub align
: Option
<Align
>,
1777 pub pack
: Option
<Align
>,
1778 pub flags
: ReprFlags
,
1779 /// The seed to be used for randomizing a type's layout
1781 /// Note: This could technically be a `[u8; 16]` (a `u128`) which would
1782 /// be the "most accurate" hash as it'd encompass the item and crate
1783 /// hash without loss, but it does pay the price of being larger.
1784 /// Everything's a tradeoff, a `u64` seed should be sufficient for our
1785 /// purposes (primarily `-Z randomize-layout`)
1786 pub field_shuffle_seed
: u64,
1790 pub fn new(tcx
: TyCtxt
<'_
>, did
: DefId
) -> ReprOptions
{
1791 let mut flags
= ReprFlags
::empty();
1792 let mut size
= None
;
1793 let mut max_align
: Option
<Align
> = None
;
1794 let mut min_pack
: Option
<Align
> = None
;
1796 // Generate a deterministically-derived seed from the item's path hash
1797 // to allow for cross-crate compilation to actually work
1798 let mut field_shuffle_seed
= tcx
.def_path_hash(did
).0.to_smaller_hash();
1800 // If the user defined a custom seed for layout randomization, xor the item's
1801 // path hash with the user defined seed, this will allowing determinism while
1802 // still allowing users to further randomize layout generation for e.g. fuzzing
1803 if let Some(user_seed
) = tcx
.sess
.opts
.debugging_opts
.layout_seed
{
1804 field_shuffle_seed ^
= user_seed
;
1807 for attr
in tcx
.get_attrs(did
).iter() {
1808 for r
in attr
::find_repr_attrs(&tcx
.sess
, attr
) {
1809 flags
.insert(match r
{
1810 attr
::ReprC
=> ReprFlags
::IS_C
,
1811 attr
::ReprPacked(pack
) => {
1812 let pack
= Align
::from_bytes(pack
as u64).unwrap();
1813 min_pack
= Some(if let Some(min_pack
) = min_pack
{
1820 attr
::ReprTransparent
=> ReprFlags
::IS_TRANSPARENT
,
1821 attr
::ReprNoNiche
=> ReprFlags
::HIDE_NICHE
,
1822 attr
::ReprSimd
=> ReprFlags
::IS_SIMD
,
1823 attr
::ReprInt(i
) => {
1827 attr
::ReprAlign(align
) => {
1828 max_align
= max_align
.max(Some(Align
::from_bytes(align
as u64).unwrap()));
1835 // If `-Z randomize-layout` was enabled for the type definition then we can
1836 // consider performing layout randomization
1837 if tcx
.sess
.opts
.debugging_opts
.randomize_layout
{
1838 flags
.insert(ReprFlags
::RANDOMIZE_LAYOUT
);
1841 // This is here instead of layout because the choice must make it into metadata.
1842 if !tcx
.consider_optimizing(|| format
!("Reorder fields of {:?}", tcx
.def_path_str(did
))) {
1843 flags
.insert(ReprFlags
::IS_LINEAR
);
1846 Self { int: size, align: max_align, pack: min_pack, flags, field_shuffle_seed }
1850 pub fn simd(&self) -> bool
{
1851 self.flags
.contains(ReprFlags
::IS_SIMD
)
1855 pub fn c(&self) -> bool
{
1856 self.flags
.contains(ReprFlags
::IS_C
)
1860 pub fn packed(&self) -> bool
{
1865 pub fn transparent(&self) -> bool
{
1866 self.flags
.contains(ReprFlags
::IS_TRANSPARENT
)
1870 pub fn linear(&self) -> bool
{
1871 self.flags
.contains(ReprFlags
::IS_LINEAR
)
1875 pub fn hide_niche(&self) -> bool
{
1876 self.flags
.contains(ReprFlags
::HIDE_NICHE
)
1879 /// Returns the discriminant type, given these `repr` options.
1880 /// This must only be called on enums!
1881 pub fn discr_type(&self) -> attr
::IntType
{
1882 self.int
.unwrap_or(attr
::SignedInt(ast
::IntTy
::Isize
))
1885 /// Returns `true` if this `#[repr()]` should inhabit "smart enum
1886 /// layout" optimizations, such as representing `Foo<&T>` as a
1888 pub fn inhibit_enum_layout_opt(&self) -> bool
{
1889 self.c() || self.int
.is_some()
1892 /// Returns `true` if this `#[repr()]` should inhibit struct field reordering
1893 /// optimizations, such as with `repr(C)`, `repr(packed(1))`, or `repr(<int>)`.
1894 pub fn inhibit_struct_field_reordering_opt(&self) -> bool
{
1895 if let Some(pack
) = self.pack
{
1896 if pack
.bytes() == 1 {
1901 self.flags
.intersects(ReprFlags
::IS_UNOPTIMISABLE
) || self.int
.is_some()
1904 /// Returns `true` if this type is valid for reordering and `-Z randomize-layout`
1905 /// was enabled for its declaration crate
1906 pub fn can_randomize_type_layout(&self) -> bool
{
1907 !self.inhibit_struct_field_reordering_opt()
1908 && self.flags
.contains(ReprFlags
::RANDOMIZE_LAYOUT
)
1911 /// Returns `true` if this `#[repr()]` should inhibit union ABI optimisations.
1912 pub fn inhibit_union_abi_opt(&self) -> bool
{
1917 impl<'tcx
> FieldDef
{
1918 /// Returns the type of this field. The resulting type is not normalized. The `subst` is
1919 /// typically obtained via the second field of [`TyKind::Adt`].
1920 pub fn ty(&self, tcx
: TyCtxt
<'tcx
>, subst
: SubstsRef
<'tcx
>) -> Ty
<'tcx
> {
1921 tcx
.type_of(self.did
).subst(tcx
, subst
)
1924 /// Computes the `Ident` of this variant by looking up the `Span`
1925 pub fn ident(&self, tcx
: TyCtxt
<'_
>) -> Ident
{
1926 Ident
::new(self.name
, tcx
.def_ident_span(self.did
).unwrap())
1930 pub type Attributes
<'tcx
> = &'tcx
[ast
::Attribute
];
1932 #[derive(Debug, PartialEq, Eq)]
1933 pub enum ImplOverlapKind
{
1934 /// These impls are always allowed to overlap.
1936 /// Whether or not the impl is permitted due to the trait being a `#[marker]` trait
1939 /// These impls are allowed to overlap, but that raises
1940 /// an issue #33140 future-compatibility warning.
1942 /// Some background: in Rust 1.0, the trait-object types `Send + Sync` (today's
1943 /// `dyn Send + Sync`) and `Sync + Send` (now `dyn Sync + Send`) were different.
1945 /// The widely-used version 0.1.0 of the crate `traitobject` had accidentally relied
1946 /// that difference, making what reduces to the following set of impls:
1950 /// impl Trait for dyn Send + Sync {}
1951 /// impl Trait for dyn Sync + Send {}
1954 /// Obviously, once we made these types be identical, that code causes a coherence
1955 /// error and a fairly big headache for us. However, luckily for us, the trait
1956 /// `Trait` used in this case is basically a marker trait, and therefore having
1957 /// overlapping impls for it is sound.
1959 /// To handle this, we basically regard the trait as a marker trait, with an additional
1960 /// future-compatibility warning. To avoid accidentally "stabilizing" this feature,
1961 /// it has the following restrictions:
1963 /// 1. The trait must indeed be a marker-like trait (i.e., no items), and must be
1965 /// 2. The trait-ref of both impls must be equal.
1966 /// 3. The trait-ref of both impls must be a trait object type consisting only of
1968 /// 4. Neither of the impls can have any where-clauses.
1970 /// Once `traitobject` 0.1.0 is no longer an active concern, this hack can be removed.
1974 impl<'tcx
> TyCtxt
<'tcx
> {
1975 pub fn typeck_body(self, body
: hir
::BodyId
) -> &'tcx TypeckResults
<'tcx
> {
1976 self.typeck(self.hir().body_owner_def_id(body
))
1979 pub fn provided_trait_methods(self, id
: DefId
) -> impl 'tcx
+ Iterator
<Item
= &'tcx AssocItem
> {
1980 self.associated_items(id
)
1981 .in_definition_order()
1982 .filter(|item
| item
.kind
== AssocKind
::Fn
&& item
.defaultness
.has_value())
1985 fn item_name_from_hir(self, def_id
: DefId
) -> Option
<Ident
> {
1986 self.hir().get_if_local(def_id
).and_then(|node
| node
.ident())
1989 fn item_name_from_def_id(self, def_id
: DefId
) -> Option
<Symbol
> {
1990 if def_id
.index
== CRATE_DEF_INDEX
{
1991 Some(self.crate_name(def_id
.krate
))
1993 let def_key
= self.def_key(def_id
);
1994 match def_key
.disambiguated_data
.data
{
1995 // The name of a constructor is that of its parent.
1996 rustc_hir
::definitions
::DefPathData
::Ctor
=> self.item_name_from_def_id(DefId
{
1997 krate
: def_id
.krate
,
1998 index
: def_key
.parent
.unwrap(),
2000 _
=> def_key
.disambiguated_data
.data
.get_opt_name(),
2005 /// Look up the name of an item across crates. This does not look at HIR.
2007 /// When possible, this function should be used for cross-crate lookups over
2008 /// [`opt_item_name`] to avoid invalidating the incremental cache. If you
2009 /// need to handle items without a name, or HIR items that will not be
2010 /// serialized cross-crate, or if you need the span of the item, use
2011 /// [`opt_item_name`] instead.
2013 /// [`opt_item_name`]: Self::opt_item_name
2014 pub fn item_name(self, id
: DefId
) -> Symbol
{
2015 // Look at cross-crate items first to avoid invalidating the incremental cache
2016 // unless we have to.
2017 self.item_name_from_def_id(id
).unwrap_or_else(|| {
2018 bug
!("item_name: no name for {:?}", self.def_path(id
));
2022 /// Look up the name and span of an item or [`Node`].
2024 /// See [`item_name`][Self::item_name] for more information.
2025 pub fn opt_item_name(self, def_id
: DefId
) -> Option
<Ident
> {
2026 // Look at the HIR first so the span will be correct if this is a local item.
2027 self.item_name_from_hir(def_id
)
2028 .or_else(|| self.item_name_from_def_id(def_id
).map(Ident
::with_dummy_span
))
2031 pub fn opt_associated_item(self, def_id
: DefId
) -> Option
<&'tcx AssocItem
> {
2032 if let DefKind
::AssocConst
| DefKind
::AssocFn
| DefKind
::AssocTy
= self.def_kind(def_id
) {
2033 Some(self.associated_item(def_id
))
2039 pub fn field_index(self, hir_id
: hir
::HirId
, typeck_results
: &TypeckResults
<'_
>) -> usize {
2040 typeck_results
.field_indices().get(hir_id
).cloned().expect("no index for a field")
2043 pub fn find_field_index(self, ident
: Ident
, variant
: &VariantDef
) -> Option
<usize> {
2047 .position(|field
| self.hygienic_eq(ident
, field
.ident(self), variant
.def_id
))
2050 /// Returns `true` if the impls are the same polarity and the trait either
2051 /// has no items or is annotated `#[marker]` and prevents item overrides.
2052 pub fn impls_are_allowed_to_overlap(
2056 ) -> Option
<ImplOverlapKind
> {
2057 // If either trait impl references an error, they're allowed to overlap,
2058 // as one of them essentially doesn't exist.
2059 if self.impl_trait_ref(def_id1
).map_or(false, |tr
| tr
.references_error())
2060 || self.impl_trait_ref(def_id2
).map_or(false, |tr
| tr
.references_error())
2062 return Some(ImplOverlapKind
::Permitted { marker: false }
);
2065 match (self.impl_polarity(def_id1
), self.impl_polarity(def_id2
)) {
2066 (ImplPolarity
::Reservation
, _
) | (_
, ImplPolarity
::Reservation
) => {
2067 // `#[rustc_reservation_impl]` impls don't overlap with anything
2069 "impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (reservations)",
2072 return Some(ImplOverlapKind
::Permitted { marker: false }
);
2074 (ImplPolarity
::Positive
, ImplPolarity
::Negative
)
2075 | (ImplPolarity
::Negative
, ImplPolarity
::Positive
) => {
2076 // `impl AutoTrait for Type` + `impl !AutoTrait for Type`
2078 "impls_are_allowed_to_overlap({:?}, {:?}) - None (differing polarities)",
2083 (ImplPolarity
::Positive
, ImplPolarity
::Positive
)
2084 | (ImplPolarity
::Negative
, ImplPolarity
::Negative
) => {}
2087 let is_marker_overlap
= {
2088 let is_marker_impl
= |def_id
: DefId
| -> bool
{
2089 let trait_ref
= self.impl_trait_ref(def_id
);
2090 trait_ref
.map_or(false, |tr
| self.trait_def(tr
.def_id
).is_marker
)
2092 is_marker_impl(def_id1
) && is_marker_impl(def_id2
)
2095 if is_marker_overlap
{
2097 "impls_are_allowed_to_overlap({:?}, {:?}) = Some(Permitted) (marker overlap)",
2100 Some(ImplOverlapKind
::Permitted { marker: true }
)
2102 if let Some(self_ty1
) = self.issue33140_self_ty(def_id1
) {
2103 if let Some(self_ty2
) = self.issue33140_self_ty(def_id2
) {
2104 if self_ty1
== self_ty2
{
2106 "impls_are_allowed_to_overlap({:?}, {:?}) - issue #33140 HACK",
2109 return Some(ImplOverlapKind
::Issue33140
);
2112 "impls_are_allowed_to_overlap({:?}, {:?}) - found {:?} != {:?}",
2113 def_id1
, def_id2
, self_ty1
, self_ty2
2119 debug
!("impls_are_allowed_to_overlap({:?}, {:?}) = None", def_id1
, def_id2
);
2124 /// Returns `ty::VariantDef` if `res` refers to a struct,
2125 /// or variant or their constructors, panics otherwise.
2126 pub fn expect_variant_res(self, res
: Res
) -> &'tcx VariantDef
{
2128 Res
::Def(DefKind
::Variant
, did
) => {
2129 let enum_did
= self.parent(did
).unwrap();
2130 self.adt_def(enum_did
).variant_with_id(did
)
2132 Res
::Def(DefKind
::Struct
| DefKind
::Union
, did
) => self.adt_def(did
).non_enum_variant(),
2133 Res
::Def(DefKind
::Ctor(CtorOf
::Variant
, ..), variant_ctor_did
) => {
2134 let variant_did
= self.parent(variant_ctor_did
).unwrap();
2135 let enum_did
= self.parent(variant_did
).unwrap();
2136 self.adt_def(enum_did
).variant_with_ctor_id(variant_ctor_did
)
2138 Res
::Def(DefKind
::Ctor(CtorOf
::Struct
, ..), ctor_did
) => {
2139 let struct_did
= self.parent(ctor_did
).expect("struct ctor has no parent");
2140 self.adt_def(struct_did
).non_enum_variant()
2142 _
=> bug
!("expect_variant_res used with unexpected res {:?}", res
),
2146 /// Returns the possibly-auto-generated MIR of a `(DefId, Subst)` pair.
2147 pub fn instance_mir(self, instance
: ty
::InstanceDef
<'tcx
>) -> &'tcx Body
<'tcx
> {
2149 ty
::InstanceDef
::Item(def
) => match self.def_kind(def
.did
) {
2151 | DefKind
::Static(..)
2152 | DefKind
::AssocConst
2154 | DefKind
::AnonConst
2155 | DefKind
::InlineConst
=> self.mir_for_ctfe_opt_const_arg(def
),
2156 // If the caller wants `mir_for_ctfe` of a function they should not be using
2157 // `instance_mir`, so we'll assume const fn also wants the optimized version.
2159 assert_eq
!(def
.const_param_did
, None
);
2160 self.optimized_mir(def
.did
)
2163 ty
::InstanceDef
::VtableShim(..)
2164 | ty
::InstanceDef
::ReifyShim(..)
2165 | ty
::InstanceDef
::Intrinsic(..)
2166 | ty
::InstanceDef
::FnPtrShim(..)
2167 | ty
::InstanceDef
::Virtual(..)
2168 | ty
::InstanceDef
::ClosureOnceShim { .. }
2169 | ty
::InstanceDef
::DropGlue(..)
2170 | ty
::InstanceDef
::CloneShim(..) => self.mir_shims(instance
),
2174 /// Gets the attributes of a definition.
2175 pub fn get_attrs(self, did
: DefId
) -> Attributes
<'tcx
> {
2176 if let Some(did
) = did
.as_local() {
2177 self.hir().attrs(self.hir().local_def_id_to_hir_id(did
))
2179 self.item_attrs(did
)
2183 /// Determines whether an item is annotated with an attribute.
2184 pub fn has_attr(self, did
: DefId
, attr
: Symbol
) -> bool
{
2185 self.sess
.contains_name(&self.get_attrs(did
), attr
)
2188 /// Returns `true` if this is an `auto trait`.
2189 pub fn trait_is_auto(self, trait_def_id
: DefId
) -> bool
{
2190 self.trait_def(trait_def_id
).has_auto_impl
2193 /// Returns layout of a generator. Layout might be unavailable if the
2194 /// generator is tainted by errors.
2195 pub fn generator_layout(self, def_id
: DefId
) -> Option
<&'tcx GeneratorLayout
<'tcx
>> {
2196 self.optimized_mir(def_id
).generator_layout()
2199 /// Given the `DefId` of an impl, returns the `DefId` of the trait it implements.
2200 /// If it implements no trait, returns `None`.
2201 pub fn trait_id_of_impl(self, def_id
: DefId
) -> Option
<DefId
> {
2202 self.impl_trait_ref(def_id
).map(|tr
| tr
.def_id
)
2205 /// If the given defid describes a method belonging to an impl, returns the
2206 /// `DefId` of the impl that the method belongs to; otherwise, returns `None`.
2207 pub fn impl_of_method(self, def_id
: DefId
) -> Option
<DefId
> {
2208 self.opt_associated_item(def_id
).and_then(|trait_item
| match trait_item
.container
{
2209 TraitContainer(_
) => None
,
2210 ImplContainer(def_id
) => Some(def_id
),
2214 /// Looks up the span of `impl_did` if the impl is local; otherwise returns `Err`
2215 /// with the name of the crate containing the impl.
2216 pub fn span_of_impl(self, impl_did
: DefId
) -> Result
<Span
, Symbol
> {
2217 if let Some(impl_did
) = impl_did
.as_local() {
2218 Ok(self.def_span(impl_did
))
2220 Err(self.crate_name(impl_did
.krate
))
2224 /// Hygienically compares a use-site name (`use_name`) for a field or an associated item with
2225 /// its supposed definition name (`def_name`). The method also needs `DefId` of the supposed
2226 /// definition's parent/scope to perform comparison.
2227 pub fn hygienic_eq(self, use_name
: Ident
, def_name
: Ident
, def_parent_def_id
: DefId
) -> bool
{
2228 // We could use `Ident::eq` here, but we deliberately don't. The name
2229 // comparison fails frequently, and we want to avoid the expensive
2230 // `normalize_to_macros_2_0()` calls required for the span comparison whenever possible.
2231 use_name
.name
== def_name
.name
2235 .hygienic_eq(def_name
.span
.ctxt(), self.expn_that_defined(def_parent_def_id
))
2238 pub fn adjust_ident(self, mut ident
: Ident
, scope
: DefId
) -> Ident
{
2239 ident
.span
.normalize_to_macros_2_0_and_adjust(self.expn_that_defined(scope
));
2243 pub fn adjust_ident_and_get_scope(
2248 ) -> (Ident
, DefId
) {
2251 .normalize_to_macros_2_0_and_adjust(self.expn_that_defined(scope
))
2252 .and_then(|actual_expansion
| actual_expansion
.expn_data().parent_module
)
2253 .unwrap_or_else(|| self.parent_module(block
).to_def_id());
2257 pub fn is_object_safe(self, key
: DefId
) -> bool
{
2258 self.object_safety_violations(key
).is_empty()
2262 pub fn is_const_fn_raw(self, def_id
: DefId
) -> bool
{
2263 matches
!(self.def_kind(def_id
), DefKind
::Fn
| DefKind
::AssocFn
| DefKind
::Ctor(..))
2264 && self.impl_constness(def_id
) == hir
::Constness
::Const
2268 /// Yields the parent function's `LocalDefId` if `def_id` is an `impl Trait` definition.
2269 pub fn is_impl_trait_defn(tcx
: TyCtxt
<'_
>, def_id
: DefId
) -> Option
<LocalDefId
> {
2270 let def_id
= def_id
.as_local()?
;
2271 if let Node
::Item(item
) = tcx
.hir().get_by_def_id(def_id
) {
2272 if let hir
::ItemKind
::OpaqueTy(ref opaque_ty
) = item
.kind
{
2273 return match opaque_ty
.origin
{
2274 hir
::OpaqueTyOrigin
::FnReturn(parent
) | hir
::OpaqueTyOrigin
::AsyncFn(parent
) => {
2277 hir
::OpaqueTyOrigin
::TyAlias
=> None
,
2284 pub fn int_ty(ity
: ast
::IntTy
) -> IntTy
{
2286 ast
::IntTy
::Isize
=> IntTy
::Isize
,
2287 ast
::IntTy
::I8
=> IntTy
::I8
,
2288 ast
::IntTy
::I16
=> IntTy
::I16
,
2289 ast
::IntTy
::I32
=> IntTy
::I32
,
2290 ast
::IntTy
::I64
=> IntTy
::I64
,
2291 ast
::IntTy
::I128
=> IntTy
::I128
,
2295 pub fn uint_ty(uty
: ast
::UintTy
) -> UintTy
{
2297 ast
::UintTy
::Usize
=> UintTy
::Usize
,
2298 ast
::UintTy
::U8
=> UintTy
::U8
,
2299 ast
::UintTy
::U16
=> UintTy
::U16
,
2300 ast
::UintTy
::U32
=> UintTy
::U32
,
2301 ast
::UintTy
::U64
=> UintTy
::U64
,
2302 ast
::UintTy
::U128
=> UintTy
::U128
,
2306 pub fn float_ty(fty
: ast
::FloatTy
) -> FloatTy
{
2308 ast
::FloatTy
::F32
=> FloatTy
::F32
,
2309 ast
::FloatTy
::F64
=> FloatTy
::F64
,
2313 pub fn ast_int_ty(ity
: IntTy
) -> ast
::IntTy
{
2315 IntTy
::Isize
=> ast
::IntTy
::Isize
,
2316 IntTy
::I8
=> ast
::IntTy
::I8
,
2317 IntTy
::I16
=> ast
::IntTy
::I16
,
2318 IntTy
::I32
=> ast
::IntTy
::I32
,
2319 IntTy
::I64
=> ast
::IntTy
::I64
,
2320 IntTy
::I128
=> ast
::IntTy
::I128
,
2324 pub fn ast_uint_ty(uty
: UintTy
) -> ast
::UintTy
{
2326 UintTy
::Usize
=> ast
::UintTy
::Usize
,
2327 UintTy
::U8
=> ast
::UintTy
::U8
,
2328 UintTy
::U16
=> ast
::UintTy
::U16
,
2329 UintTy
::U32
=> ast
::UintTy
::U32
,
2330 UintTy
::U64
=> ast
::UintTy
::U64
,
2331 UintTy
::U128
=> ast
::UintTy
::U128
,
2335 pub fn provide(providers
: &mut ty
::query
::Providers
) {
2336 closure
::provide(providers
);
2337 context
::provide(providers
);
2338 erase_regions
::provide(providers
);
2339 layout
::provide(providers
);
2340 util
::provide(providers
);
2341 print
::provide(providers
);
2342 super::util
::bug
::provide(providers
);
2343 super::middle
::provide(providers
);
2344 *providers
= ty
::query
::Providers
{
2345 trait_impls_of
: trait_def
::trait_impls_of_provider
,
2346 incoherent_impls
: trait_def
::incoherent_impls_provider
,
2347 type_uninhabited_from
: inhabitedness
::type_uninhabited_from
,
2348 const_param_default
: consts
::const_param_default
,
2349 vtable_allocation
: vtable
::vtable_allocation_provider
,
2354 /// A map for the local crate mapping each type to a vector of its
2355 /// inherent impls. This is not meant to be used outside of coherence;
2356 /// rather, you should request the vector for a specific type via
2357 /// `tcx.inherent_impls(def_id)` so as to minimize your dependencies
2358 /// (constructing this map requires touching the entire crate).
2359 #[derive(Clone, Debug, Default, HashStable)]
2360 pub struct CrateInherentImpls
{
2361 pub inherent_impls
: LocalDefIdMap
<Vec
<DefId
>>,
2362 pub incoherent_impls
: FxHashMap
<SimplifiedType
, Vec
<LocalDefId
>>,
2365 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, HashStable)]
2366 pub struct SymbolName
<'tcx
> {
2367 /// `&str` gives a consistent ordering, which ensures reproducible builds.
2368 pub name
: &'tcx
str,
2371 impl<'tcx
> SymbolName
<'tcx
> {
2372 pub fn new(tcx
: TyCtxt
<'tcx
>, name
: &str) -> SymbolName
<'tcx
> {
2374 name
: unsafe { str::from_utf8_unchecked(tcx.arena.alloc_slice(name.as_bytes())) }
,
2379 impl<'tcx
> fmt
::Display
for SymbolName
<'tcx
> {
2380 fn fmt(&self, fmt
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
2381 fmt
::Display
::fmt(&self.name
, fmt
)
2385 impl<'tcx
> fmt
::Debug
for SymbolName
<'tcx
> {
2386 fn fmt(&self, fmt
: &mut fmt
::Formatter
<'_
>) -> fmt
::Result
{
2387 fmt
::Display
::fmt(&self.name
, fmt
)
2391 #[derive(Debug, Default, Copy, Clone)]
2392 pub struct FoundRelationships
{
2393 /// This is true if we identified that this Ty (`?T`) is found in a `?T: Foo`
2394 /// obligation, where:
2396 /// * `Foo` is not `Sized`
2397 /// * `(): Foo` may be satisfied
2398 pub self_in_trait
: bool
,
2399 /// This is true if we identified that this Ty (`?T`) is found in a `<_ as
2400 /// _>::AssocType = ?T`