1 //! This module contains `TyKind` and its major components.
3 #![allow(rustc::usage_of_ty_tykind)]
7 use crate::infer::canonical::Canonical;
8 use crate::ty::fold::ValidateBoundVars;
9 use crate::ty::subst::{GenericArg, InternalSubsts, Subst, SubstsRef};
10 use crate::ty::InferTy::{self, *};
12 self, AdtDef, DefIdTree, Discr, Ty, TyCtxt, TypeFlags, TypeFoldable, WithConstness,
14 use crate::ty::{DelaySpanBugEmitted, List, ParamEnv, TyS};
15 use polonius_engine::Atom;
16 use rustc_data_structures::captures::Captures;
18 use rustc_hir::def_id::DefId;
19 use rustc_index::vec::Idx;
20 use rustc_macros::HashStable;
21 use rustc_span::symbol::{kw, Symbol};
22 use rustc_target::abi::VariantIdx;
23 use rustc_target::spec::abi;
25 use std::cmp::Ordering;
26 use std::marker::PhantomData;
28 use ty::util::IntTypeExt;
30 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
31 #[derive(HashStable, TypeFoldable, Lift)]
32 pub struct TypeAndMut<'tcx> {
34 pub mutbl: hir::Mutability,
37 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
39 /// A "free" region `fr` can be interpreted as "some region
40 /// at least as big as the scope `fr.scope`".
41 pub struct FreeRegion {
43 pub bound_region: BoundRegionKind,
46 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
48 pub enum BoundRegionKind {
49 /// An anonymous region parameter for a given fn (&T)
52 /// Named region parameters for functions (a in &'a T)
54 /// The `DefId` is needed to distinguish free regions in
55 /// the event of shadowing.
56 BrNamed(DefId, Symbol),
58 /// Anonymous region for the implicit env pointer parameter
63 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable, Debug, PartialOrd, Ord)]
65 pub struct BoundRegion {
67 pub kind: BoundRegionKind,
70 impl BoundRegionKind {
71 pub fn is_named(&self) -> bool {
73 BoundRegionKind::BrNamed(_, name) => name != kw::UnderscoreLifetime,
79 /// Defines the kinds of types.
81 /// N.B., if you change this, you'll probably want to change the corresponding
82 /// AST structure in `rustc_ast/src/ast.rs` as well.
83 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable, Debug)]
85 #[rustc_diagnostic_item = "TyKind"]
86 pub enum TyKind<'tcx> {
87 /// The primitive boolean type. Written as `bool`.
90 /// The primitive character type; holds a Unicode scalar value
91 /// (a non-surrogate code point). Written as `char`.
94 /// A primitive signed integer type. For example, `i32`.
97 /// A primitive unsigned integer type. For example, `u32`.
100 /// A primitive floating-point type. For example, `f64`.
103 /// Algebraic data types (ADT). For example: structures, enumerations and unions.
105 /// InternalSubsts here, possibly against intuition, *may* contain `Param`s.
106 /// That is, even after substitution it is possible that there are type
107 /// variables. This happens when the `Adt` corresponds to an ADT
108 /// definition and not a concrete use of it.
109 Adt(&'tcx AdtDef, SubstsRef<'tcx>),
111 /// An unsized FFI type that is opaque to Rust. Written as `extern type T`.
114 /// The pointee of a string slice. Written as `str`.
117 /// An array with the given length. Written as `[T; n]`.
118 Array(Ty<'tcx>, &'tcx ty::Const<'tcx>),
120 /// The pointee of an array slice. Written as `[T]`.
123 /// A raw pointer. Written as `*mut T` or `*const T`
124 RawPtr(TypeAndMut<'tcx>),
126 /// A reference; a pointer with an associated lifetime. Written as
127 /// `&'a mut T` or `&'a T`.
128 Ref(Region<'tcx>, Ty<'tcx>, hir::Mutability),
130 /// The anonymous type of a function declaration/definition. Each
131 /// function has a unique type, which is output (for a function
132 /// named `foo` returning an `i32`) as `fn() -> i32 {foo}`.
134 /// For example the type of `bar` here:
137 /// fn foo() -> i32 { 1 }
138 /// let bar = foo; // bar: fn() -> i32 {foo}
140 FnDef(DefId, SubstsRef<'tcx>),
142 /// A pointer to a function. Written as `fn() -> i32`.
144 /// For example the type of `bar` here:
147 /// fn foo() -> i32 { 1 }
148 /// let bar: fn() -> i32 = foo;
150 FnPtr(PolyFnSig<'tcx>),
152 /// A trait object. Written as `dyn for<'b> Trait<'b, Assoc = u32> + Send + 'a`.
153 Dynamic(&'tcx List<Binder<'tcx, ExistentialPredicate<'tcx>>>, ty::Region<'tcx>),
155 /// The anonymous type of a closure. Used to represent the type of
157 Closure(DefId, SubstsRef<'tcx>),
159 /// The anonymous type of a generator. Used to represent the type of
161 Generator(DefId, SubstsRef<'tcx>, hir::Movability),
163 /// A type representing the types stored inside a generator.
164 /// This should only appear in GeneratorInteriors.
165 GeneratorWitness(Binder<'tcx, &'tcx List<Ty<'tcx>>>),
167 /// The never type `!`.
170 /// A tuple type. For example, `(i32, bool)`.
171 /// Use `TyS::tuple_fields` to iterate over the field types.
172 Tuple(SubstsRef<'tcx>),
174 /// The projection of an associated type. For example,
175 /// `<T as Trait<..>>::N`.
176 Projection(ProjectionTy<'tcx>),
178 /// Opaque (`impl Trait`) type found in a return type.
179 /// The `DefId` comes either from
180 /// * the `impl Trait` ast::Ty node,
181 /// * or the `type Foo = impl Trait` declaration
182 /// The substitutions are for the generics of the function in question.
183 /// After typeck, the concrete type can be found in the `types` map.
184 Opaque(DefId, SubstsRef<'tcx>),
186 /// A type parameter; for example, `T` in `fn f<T>(x: T) {}`.
189 /// Bound type variable, used only when preparing a trait query.
190 Bound(ty::DebruijnIndex, BoundTy),
192 /// A placeholder type - universally quantified higher-ranked type.
193 Placeholder(ty::PlaceholderType),
195 /// A type variable used during type checking.
198 /// A placeholder for a type which could not be computed; this is
199 /// propagated to avoid useless error messages.
200 Error(DelaySpanBugEmitted),
205 pub fn is_primitive(&self) -> bool {
206 matches!(self, Bool | Char | Int(_) | Uint(_) | Float(_))
209 /// Get the article ("a" or "an") to use with this type.
210 pub fn article(&self) -> &'static str {
212 Int(_) | Float(_) | Array(_, _) => "an",
213 Adt(def, _) if def.is_enum() => "an",
214 // This should never happen, but ICEing and causing the user's code
215 // to not compile felt too harsh.
222 // `TyKind` is used a lot. Make sure it doesn't unintentionally get bigger.
223 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
224 static_assert_size!(TyKind<'_>, 32);
226 /// A closure can be modeled as a struct that looks like:
228 /// struct Closure<'l0...'li, T0...Tj, CK, CS, U>(...U);
232 /// - 'l0...'li and T0...Tj are the generic parameters
233 /// in scope on the function that defined the closure,
234 /// - CK represents the *closure kind* (Fn vs FnMut vs FnOnce). This
235 /// is rather hackily encoded via a scalar type. See
236 /// `TyS::to_opt_closure_kind` for details.
237 /// - CS represents the *closure signature*, representing as a `fn()`
238 /// type. For example, `fn(u32, u32) -> u32` would mean that the closure
239 /// implements `CK<(u32, u32), Output = u32>`, where `CK` is the trait
241 /// - U is a type parameter representing the types of its upvars, tupled up
242 /// (borrowed, if appropriate; that is, if a U field represents a by-ref upvar,
243 /// and the up-var has the type `Foo`, then that field of U will be `&Foo`).
245 /// So, for example, given this function:
247 /// fn foo<'a, T>(data: &'a mut T) {
248 /// do(|| data.count += 1)
251 /// the type of the closure would be something like:
253 /// struct Closure<'a, T, U>(...U);
255 /// Note that the type of the upvar is not specified in the struct.
256 /// You may wonder how the impl would then be able to use the upvar,
257 /// if it doesn't know it's type? The answer is that the impl is
258 /// (conceptually) not fully generic over Closure but rather tied to
259 /// instances with the expected upvar types:
261 /// impl<'b, 'a, T> FnMut() for Closure<'a, T, (&'b mut &'a mut T,)> {
265 /// You can see that the *impl* fully specified the type of the upvar
266 /// and thus knows full well that `data` has type `&'b mut &'a mut T`.
267 /// (Here, I am assuming that `data` is mut-borrowed.)
269 /// Now, the last question you may ask is: Why include the upvar types
270 /// in an extra type parameter? The reason for this design is that the
271 /// upvar types can reference lifetimes that are internal to the
272 /// creating function. In my example above, for example, the lifetime
273 /// `'b` represents the scope of the closure itself; this is some
274 /// subset of `foo`, probably just the scope of the call to the to
275 /// `do()`. If we just had the lifetime/type parameters from the
276 /// enclosing function, we couldn't name this lifetime `'b`. Note that
277 /// there can also be lifetimes in the types of the upvars themselves,
278 /// if one of them happens to be a reference to something that the
279 /// creating fn owns.
281 /// OK, you say, so why not create a more minimal set of parameters
282 /// that just includes the extra lifetime parameters? The answer is
283 /// primarily that it would be hard --- we don't know at the time when
284 /// we create the closure type what the full types of the upvars are,
285 /// nor do we know which are borrowed and which are not. In this
286 /// design, we can just supply a fresh type parameter and figure that
289 /// All right, you say, but why include the type parameters from the
290 /// original function then? The answer is that codegen may need them
291 /// when monomorphizing, and they may not appear in the upvars. A
292 /// closure could capture no variables but still make use of some
293 /// in-scope type parameter with a bound (e.g., if our example above
294 /// had an extra `U: Default`, and the closure called `U::default()`).
296 /// There is another reason. This design (implicitly) prohibits
297 /// closures from capturing themselves (except via a trait
298 /// object). This simplifies closure inference considerably, since it
299 /// means that when we infer the kind of a closure or its upvars, we
300 /// don't have to handle cycles where the decisions we make for
301 /// closure C wind up influencing the decisions we ought to make for
302 /// closure C (which would then require fixed point iteration to
303 /// handle). Plus it fixes an ICE. :P
307 /// Generators are handled similarly in `GeneratorSubsts`. The set of
308 /// type parameters is similar, but `CK` and `CS` are replaced by the
309 /// following type parameters:
311 /// * `GS`: The generator's "resume type", which is the type of the
312 /// argument passed to `resume`, and the type of `yield` expressions
313 /// inside the generator.
314 /// * `GY`: The "yield type", which is the type of values passed to
315 /// `yield` inside the generator.
316 /// * `GR`: The "return type", which is the type of value returned upon
317 /// completion of the generator.
318 /// * `GW`: The "generator witness".
319 #[derive(Copy, Clone, Debug, TypeFoldable)]
320 pub struct ClosureSubsts<'tcx> {
321 /// Lifetime and type parameters from the enclosing function,
322 /// concatenated with a tuple containing the types of the upvars.
324 /// These are separated out because codegen wants to pass them around
325 /// when monomorphizing.
326 pub substs: SubstsRef<'tcx>,
329 /// Struct returned by `split()`.
330 pub struct ClosureSubstsParts<'tcx, T> {
331 pub parent_substs: &'tcx [GenericArg<'tcx>],
332 pub closure_kind_ty: T,
333 pub closure_sig_as_fn_ptr_ty: T,
334 pub tupled_upvars_ty: T,
337 impl<'tcx> ClosureSubsts<'tcx> {
338 /// Construct `ClosureSubsts` from `ClosureSubstsParts`, containing `Substs`
339 /// for the closure parent, alongside additional closure-specific components.
342 parts: ClosureSubstsParts<'tcx, Ty<'tcx>>,
343 ) -> ClosureSubsts<'tcx> {
345 substs: tcx.mk_substs(
346 parts.parent_substs.iter().copied().chain(
347 [parts.closure_kind_ty, parts.closure_sig_as_fn_ptr_ty, parts.tupled_upvars_ty]
349 .map(|&ty| ty.into()),
355 /// Divides the closure substs into their respective components.
356 /// The ordering assumed here must match that used by `ClosureSubsts::new` above.
357 fn split(self) -> ClosureSubstsParts<'tcx, GenericArg<'tcx>> {
358 match self.substs[..] {
360 ref parent_substs @ ..,
362 closure_sig_as_fn_ptr_ty,
364 ] => ClosureSubstsParts {
367 closure_sig_as_fn_ptr_ty,
370 _ => bug!("closure substs missing synthetics"),
374 /// Returns `true` only if enough of the synthetic types are known to
375 /// allow using all of the methods on `ClosureSubsts` without panicking.
377 /// Used primarily by `ty::print::pretty` to be able to handle closure
378 /// types that haven't had their synthetic types substituted in.
379 pub fn is_valid(self) -> bool {
380 self.substs.len() >= 3
381 && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
384 /// Returns the substitutions of the closure's parent.
385 pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
386 self.split().parent_substs
389 /// Returns an iterator over the list of types of captured paths by the closure.
390 /// In case there was a type error in figuring out the types of the captured path, an
391 /// empty iterator is returned.
393 pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
394 match self.tupled_upvars_ty().kind() {
395 TyKind::Error(_) => None,
396 TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
397 TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
398 ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
404 /// Returns the tuple type representing the upvars for this closure.
406 pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
407 self.split().tupled_upvars_ty.expect_ty()
410 /// Returns the closure kind for this closure; may return a type
411 /// variable during inference. To get the closure kind during
412 /// inference, use `infcx.closure_kind(substs)`.
413 pub fn kind_ty(self) -> Ty<'tcx> {
414 self.split().closure_kind_ty.expect_ty()
417 /// Returns the `fn` pointer type representing the closure signature for this
419 // FIXME(eddyb) this should be unnecessary, as the shallowly resolved
420 // type is known at the time of the creation of `ClosureSubsts`,
421 // see `rustc_typeck::check::closure`.
422 pub fn sig_as_fn_ptr_ty(self) -> Ty<'tcx> {
423 self.split().closure_sig_as_fn_ptr_ty.expect_ty()
426 /// Returns the closure kind for this closure; only usable outside
427 /// of an inference context, because in that context we know that
428 /// there are no type variables.
430 /// If you have an inference context, use `infcx.closure_kind()`.
431 pub fn kind(self) -> ty::ClosureKind {
432 self.kind_ty().to_opt_closure_kind().unwrap()
435 /// Extracts the signature from the closure.
436 pub fn sig(self) -> ty::PolyFnSig<'tcx> {
437 let ty = self.sig_as_fn_ptr_ty();
439 ty::FnPtr(sig) => *sig,
440 _ => bug!("closure_sig_as_fn_ptr_ty is not a fn-ptr: {:?}", ty.kind()),
445 /// Similar to `ClosureSubsts`; see the above documentation for more.
446 #[derive(Copy, Clone, Debug, TypeFoldable)]
447 pub struct GeneratorSubsts<'tcx> {
448 pub substs: SubstsRef<'tcx>,
451 pub struct GeneratorSubstsParts<'tcx, T> {
452 pub parent_substs: &'tcx [GenericArg<'tcx>],
457 pub tupled_upvars_ty: T,
460 impl<'tcx> GeneratorSubsts<'tcx> {
461 /// Construct `GeneratorSubsts` from `GeneratorSubstsParts`, containing `Substs`
462 /// for the generator parent, alongside additional generator-specific components.
465 parts: GeneratorSubstsParts<'tcx, Ty<'tcx>>,
466 ) -> GeneratorSubsts<'tcx> {
468 substs: tcx.mk_substs(
469 parts.parent_substs.iter().copied().chain(
475 parts.tupled_upvars_ty,
478 .map(|&ty| ty.into()),
484 /// Divides the generator substs into their respective components.
485 /// The ordering assumed here must match that used by `GeneratorSubsts::new` above.
486 fn split(self) -> GeneratorSubstsParts<'tcx, GenericArg<'tcx>> {
487 match self.substs[..] {
488 [ref parent_substs @ .., resume_ty, yield_ty, return_ty, witness, tupled_upvars_ty] => {
489 GeneratorSubstsParts {
498 _ => bug!("generator substs missing synthetics"),
502 /// Returns `true` only if enough of the synthetic types are known to
503 /// allow using all of the methods on `GeneratorSubsts` without panicking.
505 /// Used primarily by `ty::print::pretty` to be able to handle generator
506 /// types that haven't had their synthetic types substituted in.
507 pub fn is_valid(self) -> bool {
508 self.substs.len() >= 5
509 && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
512 /// Returns the substitutions of the generator's parent.
513 pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
514 self.split().parent_substs
517 /// This describes the types that can be contained in a generator.
518 /// It will be a type variable initially and unified in the last stages of typeck of a body.
519 /// It contains a tuple of all the types that could end up on a generator frame.
520 /// The state transformation MIR pass may only produce layouts which mention types
521 /// in this tuple. Upvars are not counted here.
522 pub fn witness(self) -> Ty<'tcx> {
523 self.split().witness.expect_ty()
526 /// Returns an iterator over the list of types of captured paths by the generator.
527 /// In case there was a type error in figuring out the types of the captured path, an
528 /// empty iterator is returned.
530 pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
531 match self.tupled_upvars_ty().kind() {
532 TyKind::Error(_) => None,
533 TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
534 TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
535 ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
541 /// Returns the tuple type representing the upvars for this generator.
543 pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
544 self.split().tupled_upvars_ty.expect_ty()
547 /// Returns the type representing the resume type of the generator.
548 pub fn resume_ty(self) -> Ty<'tcx> {
549 self.split().resume_ty.expect_ty()
552 /// Returns the type representing the yield type of the generator.
553 pub fn yield_ty(self) -> Ty<'tcx> {
554 self.split().yield_ty.expect_ty()
557 /// Returns the type representing the return type of the generator.
558 pub fn return_ty(self) -> Ty<'tcx> {
559 self.split().return_ty.expect_ty()
562 /// Returns the "generator signature", which consists of its yield
563 /// and return types.
565 /// N.B., some bits of the code prefers to see this wrapped in a
566 /// binder, but it never contains bound regions. Probably this
567 /// function should be removed.
568 pub fn poly_sig(self) -> PolyGenSig<'tcx> {
569 ty::Binder::dummy(self.sig())
572 /// Returns the "generator signature", which consists of its resume, yield
573 /// and return types.
574 pub fn sig(self) -> GenSig<'tcx> {
576 resume_ty: self.resume_ty(),
577 yield_ty: self.yield_ty(),
578 return_ty: self.return_ty(),
583 impl<'tcx> GeneratorSubsts<'tcx> {
584 /// Generator has not been resumed yet.
585 pub const UNRESUMED: usize = 0;
586 /// Generator has returned or is completed.
587 pub const RETURNED: usize = 1;
588 /// Generator has been poisoned.
589 pub const POISONED: usize = 2;
591 const UNRESUMED_NAME: &'static str = "Unresumed";
592 const RETURNED_NAME: &'static str = "Returned";
593 const POISONED_NAME: &'static str = "Panicked";
595 /// The valid variant indices of this generator.
597 pub fn variant_range(&self, def_id: DefId, tcx: TyCtxt<'tcx>) -> Range<VariantIdx> {
598 // FIXME requires optimized MIR
599 let num_variants = tcx.generator_layout(def_id).unwrap().variant_fields.len();
600 VariantIdx::new(0)..VariantIdx::new(num_variants)
603 /// The discriminant for the given variant. Panics if the `variant_index` is
606 pub fn discriminant_for_variant(
610 variant_index: VariantIdx,
612 // Generators don't support explicit discriminant values, so they are
613 // the same as the variant index.
614 assert!(self.variant_range(def_id, tcx).contains(&variant_index));
615 Discr { val: variant_index.as_usize() as u128, ty: self.discr_ty(tcx) }
618 /// The set of all discriminants for the generator, enumerated with their
621 pub fn discriminants(
625 ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx> {
626 self.variant_range(def_id, tcx).map(move |index| {
627 (index, Discr { val: index.as_usize() as u128, ty: self.discr_ty(tcx) })
631 /// Calls `f` with a reference to the name of the enumerator for the given
633 pub fn variant_name(v: VariantIdx) -> Cow<'static, str> {
635 Self::UNRESUMED => Cow::from(Self::UNRESUMED_NAME),
636 Self::RETURNED => Cow::from(Self::RETURNED_NAME),
637 Self::POISONED => Cow::from(Self::POISONED_NAME),
638 _ => Cow::from(format!("Suspend{}", v.as_usize() - 3)),
642 /// The type of the state discriminant used in the generator type.
644 pub fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
648 /// This returns the types of the MIR locals which had to be stored across suspension points.
649 /// It is calculated in rustc_const_eval::transform::generator::StateTransform.
650 /// All the types here must be in the tuple in GeneratorInterior.
652 /// The locals are grouped by their variant number. Note that some locals may
653 /// be repeated in multiple variants.
659 ) -> impl Iterator<Item = impl Iterator<Item = Ty<'tcx>> + Captures<'tcx>> {
660 let layout = tcx.generator_layout(def_id).unwrap();
661 layout.variant_fields.iter().map(move |variant| {
662 variant.iter().map(move |field| layout.field_tys[*field].subst(tcx, self.substs))
666 /// This is the types of the fields of a generator which are not stored in a
669 pub fn prefix_tys(self) -> impl Iterator<Item = Ty<'tcx>> {
674 #[derive(Debug, Copy, Clone, HashStable)]
675 pub enum UpvarSubsts<'tcx> {
676 Closure(SubstsRef<'tcx>),
677 Generator(SubstsRef<'tcx>),
680 impl<'tcx> UpvarSubsts<'tcx> {
681 /// Returns an iterator over the list of types of captured paths by the closure/generator.
682 /// In case there was a type error in figuring out the types of the captured path, an
683 /// empty iterator is returned.
685 pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
686 let tupled_tys = match self {
687 UpvarSubsts::Closure(substs) => substs.as_closure().tupled_upvars_ty(),
688 UpvarSubsts::Generator(substs) => substs.as_generator().tupled_upvars_ty(),
691 match tupled_tys.kind() {
692 TyKind::Error(_) => None,
693 TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
694 TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
695 ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
702 pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
704 UpvarSubsts::Closure(substs) => substs.as_closure().tupled_upvars_ty(),
705 UpvarSubsts::Generator(substs) => substs.as_generator().tupled_upvars_ty(),
710 /// An inline const is modeled like
712 /// const InlineConst<'l0...'li, T0...Tj, R>: R;
716 /// - 'l0...'li and T0...Tj are the generic parameters
717 /// inherited from the item that defined the inline const,
718 /// - R represents the type of the constant.
720 /// When the inline const is instantiated, `R` is substituted as the actual inferred
721 /// type of the constant. The reason that `R` is represented as an extra type parameter
722 /// is the same reason that [`ClosureSubsts`] have `CS` and `U` as type parameters:
723 /// inline const can reference lifetimes that are internal to the creating function.
724 #[derive(Copy, Clone, Debug, TypeFoldable)]
725 pub struct InlineConstSubsts<'tcx> {
726 /// Generic parameters from the enclosing item,
727 /// concatenated with the inferred type of the constant.
728 pub substs: SubstsRef<'tcx>,
731 /// Struct returned by `split()`.
732 pub struct InlineConstSubstsParts<'tcx, T> {
733 pub parent_substs: &'tcx [GenericArg<'tcx>],
737 impl<'tcx> InlineConstSubsts<'tcx> {
738 /// Construct `InlineConstSubsts` from `InlineConstSubstsParts`.
741 parts: InlineConstSubstsParts<'tcx, Ty<'tcx>>,
742 ) -> InlineConstSubsts<'tcx> {
744 substs: tcx.mk_substs(
745 parts.parent_substs.iter().copied().chain(std::iter::once(parts.ty.into())),
750 /// Divides the inline const substs into their respective components.
751 /// The ordering assumed here must match that used by `InlineConstSubsts::new` above.
752 fn split(self) -> InlineConstSubstsParts<'tcx, GenericArg<'tcx>> {
753 match self.substs[..] {
754 [ref parent_substs @ .., ty] => InlineConstSubstsParts { parent_substs, ty },
755 _ => bug!("inline const substs missing synthetics"),
759 /// Returns the substitutions of the inline const's parent.
760 pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
761 self.split().parent_substs
764 /// Returns the type of this inline const.
765 pub fn ty(self) -> Ty<'tcx> {
766 self.split().ty.expect_ty()
770 #[derive(Debug, Copy, Clone, PartialEq, PartialOrd, Ord, Eq, Hash, TyEncodable, TyDecodable)]
771 #[derive(HashStable, TypeFoldable)]
772 pub enum ExistentialPredicate<'tcx> {
773 /// E.g., `Iterator`.
774 Trait(ExistentialTraitRef<'tcx>),
775 /// E.g., `Iterator::Item = T`.
776 Projection(ExistentialProjection<'tcx>),
781 impl<'tcx> ExistentialPredicate<'tcx> {
782 /// Compares via an ordering that will not change if modules are reordered or other changes are
783 /// made to the tree. In particular, this ordering is preserved across incremental compilations.
784 pub fn stable_cmp(&self, tcx: TyCtxt<'tcx>, other: &Self) -> Ordering {
785 use self::ExistentialPredicate::*;
786 match (*self, *other) {
787 (Trait(_), Trait(_)) => Ordering::Equal,
788 (Projection(ref a), Projection(ref b)) => {
789 tcx.def_path_hash(a.item_def_id).cmp(&tcx.def_path_hash(b.item_def_id))
791 (AutoTrait(ref a), AutoTrait(ref b)) => {
792 tcx.trait_def(*a).def_path_hash.cmp(&tcx.trait_def(*b).def_path_hash)
794 (Trait(_), _) => Ordering::Less,
795 (Projection(_), Trait(_)) => Ordering::Greater,
796 (Projection(_), _) => Ordering::Less,
797 (AutoTrait(_), _) => Ordering::Greater,
802 impl<'tcx> Binder<'tcx, ExistentialPredicate<'tcx>> {
803 pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::Predicate<'tcx> {
804 use crate::ty::ToPredicate;
805 match self.skip_binder() {
806 ExistentialPredicate::Trait(tr) => {
807 self.rebind(tr).with_self_ty(tcx, self_ty).without_const().to_predicate(tcx)
809 ExistentialPredicate::Projection(p) => {
810 self.rebind(p.with_self_ty(tcx, self_ty)).to_predicate(tcx)
812 ExistentialPredicate::AutoTrait(did) => {
813 let trait_ref = self.rebind(ty::TraitRef {
815 substs: tcx.mk_substs_trait(self_ty, &[]),
817 trait_ref.without_const().to_predicate(tcx)
823 impl<'tcx> List<ty::Binder<'tcx, ExistentialPredicate<'tcx>>> {
824 /// Returns the "principal `DefId`" of this set of existential predicates.
826 /// A Rust trait object type consists (in addition to a lifetime bound)
827 /// of a set of trait bounds, which are separated into any number
828 /// of auto-trait bounds, and at most one non-auto-trait bound. The
829 /// non-auto-trait bound is called the "principal" of the trait
832 /// Only the principal can have methods or type parameters (because
833 /// auto traits can have neither of them). This is important, because
834 /// it means the auto traits can be treated as an unordered set (methods
835 /// would force an order for the vtable, while relating traits with
836 /// type parameters without knowing the order to relate them in is
837 /// a rather non-trivial task).
839 /// For example, in the trait object `dyn fmt::Debug + Sync`, the
840 /// principal bound is `Some(fmt::Debug)`, while the auto-trait bounds
841 /// are the set `{Sync}`.
843 /// It is also possible to have a "trivial" trait object that
844 /// consists only of auto traits, with no principal - for example,
845 /// `dyn Send + Sync`. In that case, the set of auto-trait bounds
846 /// is `{Send, Sync}`, while there is no principal. These trait objects
847 /// have a "trivial" vtable consisting of just the size, alignment,
849 pub fn principal(&self) -> Option<ty::Binder<'tcx, ExistentialTraitRef<'tcx>>> {
851 .map_bound(|this| match this {
852 ExistentialPredicate::Trait(tr) => Some(tr),
858 pub fn principal_def_id(&self) -> Option<DefId> {
859 self.principal().map(|trait_ref| trait_ref.skip_binder().def_id)
863 pub fn projection_bounds<'a>(
865 ) -> impl Iterator<Item = ty::Binder<'tcx, ExistentialProjection<'tcx>>> + 'a {
866 self.iter().filter_map(|predicate| {
868 .map_bound(|pred| match pred {
869 ExistentialPredicate::Projection(projection) => Some(projection),
877 pub fn auto_traits<'a>(&'a self) -> impl Iterator<Item = DefId> + 'a {
878 self.iter().filter_map(|predicate| match predicate.skip_binder() {
879 ExistentialPredicate::AutoTrait(did) => Some(did),
885 /// A complete reference to a trait. These take numerous guises in syntax,
886 /// but perhaps the most recognizable form is in a where-clause:
890 /// This would be represented by a trait-reference where the `DefId` is the
891 /// `DefId` for the trait `Foo` and the substs define `T` as parameter 0,
892 /// and `U` as parameter 1.
894 /// Trait references also appear in object types like `Foo<U>`, but in
895 /// that case the `Self` parameter is absent from the substitutions.
896 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
897 #[derive(HashStable, TypeFoldable)]
898 pub struct TraitRef<'tcx> {
900 pub substs: SubstsRef<'tcx>,
903 impl<'tcx> TraitRef<'tcx> {
904 pub fn new(def_id: DefId, substs: SubstsRef<'tcx>) -> TraitRef<'tcx> {
905 TraitRef { def_id, substs }
908 /// Returns a `TraitRef` of the form `P0: Foo<P1..Pn>` where `Pi`
909 /// are the parameters defined on trait.
910 pub fn identity(tcx: TyCtxt<'tcx>, def_id: DefId) -> Binder<'tcx, TraitRef<'tcx>> {
911 ty::Binder::dummy(TraitRef {
913 substs: InternalSubsts::identity_for_item(tcx, def_id),
918 pub fn self_ty(&self) -> Ty<'tcx> {
919 self.substs.type_at(0)
925 substs: SubstsRef<'tcx>,
926 ) -> ty::TraitRef<'tcx> {
927 let defs = tcx.generics_of(trait_id);
929 ty::TraitRef { def_id: trait_id, substs: tcx.intern_substs(&substs[..defs.params.len()]) }
933 pub type PolyTraitRef<'tcx> = Binder<'tcx, TraitRef<'tcx>>;
935 impl<'tcx> PolyTraitRef<'tcx> {
936 pub fn self_ty(&self) -> Binder<'tcx, Ty<'tcx>> {
937 self.map_bound_ref(|tr| tr.self_ty())
940 pub fn def_id(&self) -> DefId {
941 self.skip_binder().def_id
944 pub fn to_poly_trait_predicate(&self) -> ty::PolyTraitPredicate<'tcx> {
945 self.map_bound(|trait_ref| ty::TraitPredicate {
947 constness: ty::BoundConstness::NotConst,
948 polarity: ty::ImplPolarity::Positive,
953 /// An existential reference to a trait, where `Self` is erased.
954 /// For example, the trait object `Trait<'a, 'b, X, Y>` is:
956 /// exists T. T: Trait<'a, 'b, X, Y>
958 /// The substitutions don't include the erased `Self`, only trait
959 /// type and lifetime parameters (`[X, Y]` and `['a, 'b]` above).
960 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
961 #[derive(HashStable, TypeFoldable)]
962 pub struct ExistentialTraitRef<'tcx> {
964 pub substs: SubstsRef<'tcx>,
967 impl<'tcx> ExistentialTraitRef<'tcx> {
968 pub fn erase_self_ty(
970 trait_ref: ty::TraitRef<'tcx>,
971 ) -> ty::ExistentialTraitRef<'tcx> {
972 // Assert there is a Self.
973 trait_ref.substs.type_at(0);
975 ty::ExistentialTraitRef {
976 def_id: trait_ref.def_id,
977 substs: tcx.intern_substs(&trait_ref.substs[1..]),
981 /// Object types don't have a self type specified. Therefore, when
982 /// we convert the principal trait-ref into a normal trait-ref,
983 /// you must give *some* self type. A common choice is `mk_err()`
984 /// or some placeholder type.
985 pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::TraitRef<'tcx> {
986 // otherwise the escaping vars would be captured by the binder
987 // debug_assert!(!self_ty.has_escaping_bound_vars());
989 ty::TraitRef { def_id: self.def_id, substs: tcx.mk_substs_trait(self_ty, self.substs) }
993 pub type PolyExistentialTraitRef<'tcx> = Binder<'tcx, ExistentialTraitRef<'tcx>>;
995 impl<'tcx> PolyExistentialTraitRef<'tcx> {
996 pub fn def_id(&self) -> DefId {
997 self.skip_binder().def_id
1000 /// Object types don't have a self type specified. Therefore, when
1001 /// we convert the principal trait-ref into a normal trait-ref,
1002 /// you must give *some* self type. A common choice is `mk_err()`
1003 /// or some placeholder type.
1004 pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::PolyTraitRef<'tcx> {
1005 self.map_bound(|trait_ref| trait_ref.with_self_ty(tcx, self_ty))
1009 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1010 #[derive(HashStable)]
1011 pub enum BoundVariableKind {
1013 Region(BoundRegionKind),
1017 /// Binder is a binder for higher-ranked lifetimes or types. It is part of the
1018 /// compiler's representation for things like `for<'a> Fn(&'a isize)`
1019 /// (which would be represented by the type `PolyTraitRef ==
1020 /// Binder<'tcx, TraitRef>`). Note that when we instantiate,
1021 /// erase, or otherwise "discharge" these bound vars, we change the
1022 /// type from `Binder<'tcx, T>` to just `T` (see
1023 /// e.g., `liberate_late_bound_regions`).
1025 /// `Decodable` and `Encodable` are implemented for `Binder<T>` using the `impl_binder_encode_decode!` macro.
1026 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
1027 pub struct Binder<'tcx, T>(T, &'tcx List<BoundVariableKind>);
1029 impl<'tcx, T> Binder<'tcx, T>
1031 T: TypeFoldable<'tcx>,
1033 /// Wraps `value` in a binder, asserting that `value` does not
1034 /// contain any bound vars that would be bound by the
1035 /// binder. This is commonly used to 'inject' a value T into a
1036 /// different binding level.
1037 pub fn dummy(value: T) -> Binder<'tcx, T> {
1038 assert!(!value.has_escaping_bound_vars());
1039 Binder(value, ty::List::empty())
1042 pub fn bind_with_vars(value: T, vars: &'tcx List<BoundVariableKind>) -> Binder<'tcx, T> {
1043 if cfg!(debug_assertions) {
1044 let mut validator = ValidateBoundVars::new(vars);
1045 value.visit_with(&mut validator);
1051 impl<'tcx, T> Binder<'tcx, T> {
1052 /// Skips the binder and returns the "bound" value. This is a
1053 /// risky thing to do because it's easy to get confused about
1054 /// De Bruijn indices and the like. It is usually better to
1055 /// discharge the binder using `no_bound_vars` or
1056 /// `replace_late_bound_regions` or something like
1057 /// that. `skip_binder` is only valid when you are either
1058 /// extracting data that has nothing to do with bound vars, you
1059 /// are doing some sort of test that does not involve bound
1060 /// regions, or you are being very careful about your depth
1063 /// Some examples where `skip_binder` is reasonable:
1065 /// - extracting the `DefId` from a PolyTraitRef;
1066 /// - comparing the self type of a PolyTraitRef to see if it is equal to
1067 /// a type parameter `X`, since the type `X` does not reference any regions
1068 pub fn skip_binder(self) -> T {
1072 pub fn bound_vars(&self) -> &'tcx List<BoundVariableKind> {
1076 pub fn as_ref(&self) -> Binder<'tcx, &T> {
1077 Binder(&self.0, self.1)
1080 pub fn map_bound_ref_unchecked<F, U>(&self, f: F) -> Binder<'tcx, U>
1084 let value = f(&self.0);
1085 Binder(value, self.1)
1088 pub fn map_bound_ref<F, U: TypeFoldable<'tcx>>(&self, f: F) -> Binder<'tcx, U>
1092 self.as_ref().map_bound(f)
1095 pub fn map_bound<F, U: TypeFoldable<'tcx>>(self, f: F) -> Binder<'tcx, U>
1099 let value = f(self.0);
1100 if cfg!(debug_assertions) {
1101 let mut validator = ValidateBoundVars::new(self.1);
1102 value.visit_with(&mut validator);
1104 Binder(value, self.1)
1107 pub fn try_map_bound<F, U: TypeFoldable<'tcx>, E>(self, f: F) -> Result<Binder<'tcx, U>, E>
1109 F: FnOnce(T) -> Result<U, E>,
1111 let value = f(self.0)?;
1112 if cfg!(debug_assertions) {
1113 let mut validator = ValidateBoundVars::new(self.1);
1114 value.visit_with(&mut validator);
1116 Ok(Binder(value, self.1))
1119 /// Wraps a `value` in a binder, using the same bound variables as the
1120 /// current `Binder`. This should not be used if the new value *changes*
1121 /// the bound variables. Note: the (old or new) value itself does not
1122 /// necessarily need to *name* all the bound variables.
1124 /// This currently doesn't do anything different than `bind`, because we
1125 /// don't actually track bound vars. However, semantically, it is different
1126 /// because bound vars aren't allowed to change here, whereas they are
1127 /// in `bind`. This may be (debug) asserted in the future.
1128 pub fn rebind<U>(&self, value: U) -> Binder<'tcx, U>
1130 U: TypeFoldable<'tcx>,
1132 if cfg!(debug_assertions) {
1133 let mut validator = ValidateBoundVars::new(self.bound_vars());
1134 value.visit_with(&mut validator);
1136 Binder(value, self.1)
1139 /// Unwraps and returns the value within, but only if it contains
1140 /// no bound vars at all. (In other words, if this binder --
1141 /// and indeed any enclosing binder -- doesn't bind anything at
1142 /// all.) Otherwise, returns `None`.
1144 /// (One could imagine having a method that just unwraps a single
1145 /// binder, but permits late-bound vars bound by enclosing
1146 /// binders, but that would require adjusting the debruijn
1147 /// indices, and given the shallow binding structure we often use,
1148 /// would not be that useful.)
1149 pub fn no_bound_vars(self) -> Option<T>
1151 T: TypeFoldable<'tcx>,
1153 if self.0.has_escaping_bound_vars() { None } else { Some(self.skip_binder()) }
1156 /// Splits the contents into two things that share the same binder
1157 /// level as the original, returning two distinct binders.
1159 /// `f` should consider bound regions at depth 1 to be free, and
1160 /// anything it produces with bound regions at depth 1 will be
1161 /// bound in the resulting return values.
1162 pub fn split<U, V, F>(self, f: F) -> (Binder<'tcx, U>, Binder<'tcx, V>)
1164 F: FnOnce(T) -> (U, V),
1166 let (u, v) = f(self.0);
1167 (Binder(u, self.1), Binder(v, self.1))
1171 impl<'tcx, T> Binder<'tcx, Option<T>> {
1172 pub fn transpose(self) -> Option<Binder<'tcx, T>> {
1173 let bound_vars = self.1;
1174 self.0.map(|v| Binder(v, bound_vars))
1178 /// Represents the projection of an associated type. In explicit UFCS
1179 /// form this would be written `<T as Trait<..>>::N`.
1180 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1181 #[derive(HashStable, TypeFoldable)]
1182 pub struct ProjectionTy<'tcx> {
1183 /// The parameters of the associated item.
1184 pub substs: SubstsRef<'tcx>,
1186 /// The `DefId` of the `TraitItem` for the associated type `N`.
1188 /// Note that this is not the `DefId` of the `TraitRef` containing this
1189 /// associated type, which is in `tcx.associated_item(item_def_id).container`.
1190 pub item_def_id: DefId,
1193 impl<'tcx> ProjectionTy<'tcx> {
1194 pub fn trait_def_id(&self, tcx: TyCtxt<'tcx>) -> DefId {
1195 tcx.associated_item(self.item_def_id).container.id()
1198 /// Extracts the underlying trait reference and own substs from this projection.
1199 /// For example, if this is a projection of `<T as StreamingIterator>::Item<'a>`,
1200 /// then this function would return a `T: Iterator` trait reference and `['a]` as the own substs
1201 pub fn trait_ref_and_own_substs(
1204 ) -> (ty::TraitRef<'tcx>, &'tcx [ty::GenericArg<'tcx>]) {
1205 let def_id = tcx.associated_item(self.item_def_id).container.id();
1206 let trait_generics = tcx.generics_of(def_id);
1208 ty::TraitRef { def_id, substs: self.substs.truncate_to(tcx, trait_generics) },
1209 &self.substs[trait_generics.count()..],
1213 /// Extracts the underlying trait reference from this projection.
1214 /// For example, if this is a projection of `<T as Iterator>::Item`,
1215 /// then this function would return a `T: Iterator` trait reference.
1217 /// WARNING: This will drop the substs for generic associated types
1218 /// consider calling [Self::trait_ref_and_own_substs] to get those
1220 pub fn trait_ref(&self, tcx: TyCtxt<'tcx>) -> ty::TraitRef<'tcx> {
1221 let def_id = self.trait_def_id(tcx);
1222 ty::TraitRef { def_id, substs: self.substs.truncate_to(tcx, tcx.generics_of(def_id)) }
1225 pub fn self_ty(&self) -> Ty<'tcx> {
1226 self.substs.type_at(0)
1230 #[derive(Copy, Clone, Debug, TypeFoldable)]
1231 pub struct GenSig<'tcx> {
1232 pub resume_ty: Ty<'tcx>,
1233 pub yield_ty: Ty<'tcx>,
1234 pub return_ty: Ty<'tcx>,
1237 pub type PolyGenSig<'tcx> = Binder<'tcx, GenSig<'tcx>>;
1239 /// Signature of a function type, which we have arbitrarily
1240 /// decided to use to refer to the input/output types.
1242 /// - `inputs`: is the list of arguments and their modes.
1243 /// - `output`: is the return type.
1244 /// - `c_variadic`: indicates whether this is a C-variadic function.
1245 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1246 #[derive(HashStable, TypeFoldable)]
1247 pub struct FnSig<'tcx> {
1248 pub inputs_and_output: &'tcx List<Ty<'tcx>>,
1249 pub c_variadic: bool,
1250 pub unsafety: hir::Unsafety,
1254 impl<'tcx> FnSig<'tcx> {
1255 pub fn inputs(&self) -> &'tcx [Ty<'tcx>] {
1256 &self.inputs_and_output[..self.inputs_and_output.len() - 1]
1259 pub fn output(&self) -> Ty<'tcx> {
1260 self.inputs_and_output[self.inputs_and_output.len() - 1]
1263 // Creates a minimal `FnSig` to be used when encountering a `TyKind::Error` in a fallible
1265 fn fake() -> FnSig<'tcx> {
1267 inputs_and_output: List::empty(),
1269 unsafety: hir::Unsafety::Normal,
1270 abi: abi::Abi::Rust,
1275 pub type PolyFnSig<'tcx> = Binder<'tcx, FnSig<'tcx>>;
1277 impl<'tcx> PolyFnSig<'tcx> {
1279 pub fn inputs(&self) -> Binder<'tcx, &'tcx [Ty<'tcx>]> {
1280 self.map_bound_ref_unchecked(|fn_sig| fn_sig.inputs())
1283 pub fn input(&self, index: usize) -> ty::Binder<'tcx, Ty<'tcx>> {
1284 self.map_bound_ref(|fn_sig| fn_sig.inputs()[index])
1286 pub fn inputs_and_output(&self) -> ty::Binder<'tcx, &'tcx List<Ty<'tcx>>> {
1287 self.map_bound_ref(|fn_sig| fn_sig.inputs_and_output)
1290 pub fn output(&self) -> ty::Binder<'tcx, Ty<'tcx>> {
1291 self.map_bound_ref(|fn_sig| fn_sig.output())
1293 pub fn c_variadic(&self) -> bool {
1294 self.skip_binder().c_variadic
1296 pub fn unsafety(&self) -> hir::Unsafety {
1297 self.skip_binder().unsafety
1299 pub fn abi(&self) -> abi::Abi {
1300 self.skip_binder().abi
1304 pub type CanonicalPolyFnSig<'tcx> = Canonical<'tcx, Binder<'tcx, FnSig<'tcx>>>;
1306 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1307 #[derive(HashStable)]
1308 pub struct ParamTy {
1313 impl<'tcx> ParamTy {
1314 pub fn new(index: u32, name: Symbol) -> ParamTy {
1315 ParamTy { index, name }
1318 pub fn for_def(def: &ty::GenericParamDef) -> ParamTy {
1319 ParamTy::new(def.index, def.name)
1323 pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1324 tcx.mk_ty_param(self.index, self.name)
1328 #[derive(Copy, Clone, Hash, TyEncodable, TyDecodable, Eq, PartialEq, Ord, PartialOrd)]
1329 #[derive(HashStable)]
1330 pub struct ParamConst {
1336 pub fn new(index: u32, name: Symbol) -> ParamConst {
1337 ParamConst { index, name }
1340 pub fn for_def(def: &ty::GenericParamDef) -> ParamConst {
1341 ParamConst::new(def.index, def.name)
1345 pub type Region<'tcx> = &'tcx RegionKind;
1347 /// Representation of regions. Note that the NLL checker uses a distinct
1348 /// representation of regions. For this reason, it internally replaces all the
1349 /// regions with inference variables -- the index of the variable is then used
1350 /// to index into internal NLL data structures. See `rustc_const_eval::borrow_check`
1351 /// module for more information.
1353 /// ## The Region lattice within a given function
1355 /// In general, the region lattice looks like
1358 /// static ----------+-----...------+ (greatest)
1360 /// early-bound and | |
1361 /// free regions | |
1364 /// empty(root) placeholder(U1) |
1366 /// | / placeholder(Un)
1371 /// empty(Un) -------- (smallest)
1374 /// Early-bound/free regions are the named lifetimes in scope from the
1375 /// function declaration. They have relationships to one another
1376 /// determined based on the declared relationships from the
1379 /// Note that inference variables and bound regions are not included
1380 /// in this diagram. In the case of inference variables, they should
1381 /// be inferred to some other region from the diagram. In the case of
1382 /// bound regions, they are excluded because they don't make sense to
1383 /// include -- the diagram indicates the relationship between free
1386 /// ## Inference variables
1388 /// During region inference, we sometimes create inference variables,
1389 /// represented as `ReVar`. These will be inferred by the code in
1390 /// `infer::lexical_region_resolve` to some free region from the
1391 /// lattice above (the minimal region that meets the
1394 /// During NLL checking, where regions are defined differently, we
1395 /// also use `ReVar` -- in that case, the index is used to index into
1396 /// the NLL region checker's data structures. The variable may in fact
1397 /// represent either a free region or an inference variable, in that
1400 /// ## Bound Regions
1402 /// These are regions that are stored behind a binder and must be substituted
1403 /// with some concrete region before being used. There are two kind of
1404 /// bound regions: early-bound, which are bound in an item's `Generics`,
1405 /// and are substituted by an `InternalSubsts`, and late-bound, which are part of
1406 /// higher-ranked types (e.g., `for<'a> fn(&'a ())`), and are substituted by
1407 /// the likes of `liberate_late_bound_regions`. The distinction exists
1408 /// because higher-ranked lifetimes aren't supported in all places. See [1][2].
1410 /// Unlike `Param`s, bound regions are not supposed to exist "in the wild"
1411 /// outside their binder, e.g., in types passed to type inference, and
1412 /// should first be substituted (by placeholder regions, free regions,
1413 /// or region variables).
1415 /// ## Placeholder and Free Regions
1417 /// One often wants to work with bound regions without knowing their precise
1418 /// identity. For example, when checking a function, the lifetime of a borrow
1419 /// can end up being assigned to some region parameter. In these cases,
1420 /// it must be ensured that bounds on the region can't be accidentally
1421 /// assumed without being checked.
1423 /// To do this, we replace the bound regions with placeholder markers,
1424 /// which don't satisfy any relation not explicitly provided.
1426 /// There are two kinds of placeholder regions in rustc: `ReFree` and
1427 /// `RePlaceholder`. When checking an item's body, `ReFree` is supposed
1428 /// to be used. These also support explicit bounds: both the internally-stored
1429 /// *scope*, which the region is assumed to outlive, as well as other
1430 /// relations stored in the `FreeRegionMap`. Note that these relations
1431 /// aren't checked when you `make_subregion` (or `eq_types`), only by
1432 /// `resolve_regions_and_report_errors`.
1434 /// When working with higher-ranked types, some region relations aren't
1435 /// yet known, so you can't just call `resolve_regions_and_report_errors`.
1436 /// `RePlaceholder` is designed for this purpose. In these contexts,
1437 /// there's also the risk that some inference variable laying around will
1438 /// get unified with your placeholder region: if you want to check whether
1439 /// `for<'a> Foo<'_>: 'a`, and you substitute your bound region `'a`
1440 /// with a placeholder region `'%a`, the variable `'_` would just be
1441 /// instantiated to the placeholder region `'%a`, which is wrong because
1442 /// the inference variable is supposed to satisfy the relation
1443 /// *for every value of the placeholder region*. To ensure that doesn't
1444 /// happen, you can use `leak_check`. This is more clearly explained
1445 /// by the [rustc dev guide].
1447 /// [1]: https://smallcultfollowing.com/babysteps/blog/2013/10/29/intermingled-parameter-lists/
1448 /// [2]: https://smallcultfollowing.com/babysteps/blog/2013/11/04/intermingled-parameter-lists/
1449 /// [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/traits/hrtb.html
1450 #[derive(Clone, PartialEq, Eq, Hash, Copy, TyEncodable, TyDecodable, PartialOrd, Ord)]
1451 pub enum RegionKind {
1452 /// Region bound in a type or fn declaration which will be
1453 /// substituted 'early' -- that is, at the same time when type
1454 /// parameters are substituted.
1455 ReEarlyBound(EarlyBoundRegion),
1457 /// Region bound in a function scope, which will be substituted when the
1458 /// function is called.
1459 ReLateBound(ty::DebruijnIndex, BoundRegion),
1461 /// When checking a function body, the types of all arguments and so forth
1462 /// that refer to bound region parameters are modified to refer to free
1463 /// region parameters.
1466 /// Static data that has an "infinite" lifetime. Top in the region lattice.
1469 /// A region variable. Should not exist after typeck.
1472 /// A placeholder region -- basically, the higher-ranked version of `ReFree`.
1473 /// Should not exist after typeck.
1474 RePlaceholder(ty::PlaceholderRegion),
1476 /// Empty lifetime is for data that is never accessed. We tag the
1477 /// empty lifetime with a universe -- the idea is that we don't
1478 /// want `exists<'a> { forall<'b> { 'b: 'a } }` to be satisfiable.
1479 /// Therefore, the `'empty` in a universe `U` is less than all
1480 /// regions visible from `U`, but not less than regions not visible
1482 ReEmpty(ty::UniverseIndex),
1484 /// Erased region, used by trait selection, in MIR and during codegen.
1488 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable, Debug, PartialOrd, Ord)]
1489 pub struct EarlyBoundRegion {
1495 /// A **`const`** **v**ariable **ID**.
1496 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1497 pub struct ConstVid<'tcx> {
1499 pub phantom: PhantomData<&'tcx ()>,
1502 rustc_index::newtype_index! {
1503 /// A **region** (lifetime) **v**ariable **ID**.
1504 pub struct RegionVid {
1505 DEBUG_FORMAT = custom,
1509 impl Atom for RegionVid {
1510 fn index(self) -> usize {
1515 rustc_index::newtype_index! {
1516 pub struct BoundVar { .. }
1519 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1520 #[derive(HashStable)]
1521 pub struct BoundTy {
1523 pub kind: BoundTyKind,
1526 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1527 #[derive(HashStable)]
1528 pub enum BoundTyKind {
1533 impl From<BoundVar> for BoundTy {
1534 fn from(var: BoundVar) -> Self {
1535 BoundTy { var, kind: BoundTyKind::Anon }
1539 /// A `ProjectionPredicate` for an `ExistentialTraitRef`.
1540 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1541 #[derive(HashStable, TypeFoldable)]
1542 pub struct ExistentialProjection<'tcx> {
1543 pub item_def_id: DefId,
1544 pub substs: SubstsRef<'tcx>,
1548 pub type PolyExistentialProjection<'tcx> = Binder<'tcx, ExistentialProjection<'tcx>>;
1550 impl<'tcx> ExistentialProjection<'tcx> {
1551 /// Extracts the underlying existential trait reference from this projection.
1552 /// For example, if this is a projection of `exists T. <T as Iterator>::Item == X`,
1553 /// then this function would return an `exists T. T: Iterator` existential trait
1555 pub fn trait_ref(&self, tcx: TyCtxt<'tcx>) -> ty::ExistentialTraitRef<'tcx> {
1556 let def_id = tcx.associated_item(self.item_def_id).container.id();
1557 let subst_count = tcx.generics_of(def_id).count() - 1;
1558 let substs = tcx.intern_substs(&self.substs[..subst_count]);
1559 ty::ExistentialTraitRef { def_id, substs }
1562 pub fn with_self_ty(
1566 ) -> ty::ProjectionPredicate<'tcx> {
1567 // otherwise the escaping regions would be captured by the binders
1568 debug_assert!(!self_ty.has_escaping_bound_vars());
1570 ty::ProjectionPredicate {
1571 projection_ty: ty::ProjectionTy {
1572 item_def_id: self.item_def_id,
1573 substs: tcx.mk_substs_trait(self_ty, self.substs),
1579 pub fn erase_self_ty(
1581 projection_predicate: ty::ProjectionPredicate<'tcx>,
1583 // Assert there is a Self.
1584 projection_predicate.projection_ty.substs.type_at(0);
1587 item_def_id: projection_predicate.projection_ty.item_def_id,
1588 substs: tcx.intern_substs(&projection_predicate.projection_ty.substs[1..]),
1589 ty: projection_predicate.ty,
1594 impl<'tcx> PolyExistentialProjection<'tcx> {
1595 pub fn with_self_ty(
1599 ) -> ty::PolyProjectionPredicate<'tcx> {
1600 self.map_bound(|p| p.with_self_ty(tcx, self_ty))
1603 pub fn item_def_id(&self) -> DefId {
1604 self.skip_binder().item_def_id
1608 /// Region utilities
1610 /// Is this region named by the user?
1611 pub fn has_name(&self) -> bool {
1613 RegionKind::ReEarlyBound(ebr) => ebr.has_name(),
1614 RegionKind::ReLateBound(_, br) => br.kind.is_named(),
1615 RegionKind::ReFree(fr) => fr.bound_region.is_named(),
1616 RegionKind::ReStatic => true,
1617 RegionKind::ReVar(..) => false,
1618 RegionKind::RePlaceholder(placeholder) => placeholder.name.is_named(),
1619 RegionKind::ReEmpty(_) => false,
1620 RegionKind::ReErased => false,
1625 pub fn is_late_bound(&self) -> bool {
1626 matches!(*self, ty::ReLateBound(..))
1630 pub fn is_placeholder(&self) -> bool {
1631 matches!(*self, ty::RePlaceholder(..))
1635 pub fn bound_at_or_above_binder(&self, index: ty::DebruijnIndex) -> bool {
1637 ty::ReLateBound(debruijn, _) => debruijn >= index,
1642 pub fn type_flags(&self) -> TypeFlags {
1643 let mut flags = TypeFlags::empty();
1647 flags = flags | TypeFlags::HAS_KNOWN_FREE_REGIONS;
1648 flags = flags | TypeFlags::HAS_KNOWN_FREE_LOCAL_REGIONS;
1649 flags = flags | TypeFlags::HAS_RE_INFER;
1651 ty::RePlaceholder(..) => {
1652 flags = flags | TypeFlags::HAS_KNOWN_FREE_REGIONS;
1653 flags = flags | TypeFlags::HAS_KNOWN_FREE_LOCAL_REGIONS;
1654 flags = flags | TypeFlags::HAS_RE_PLACEHOLDER;
1656 ty::ReEarlyBound(..) => {
1657 flags = flags | TypeFlags::HAS_KNOWN_FREE_REGIONS;
1658 flags = flags | TypeFlags::HAS_KNOWN_FREE_LOCAL_REGIONS;
1659 flags = flags | TypeFlags::HAS_KNOWN_RE_PARAM;
1661 ty::ReFree { .. } => {
1662 flags = flags | TypeFlags::HAS_KNOWN_FREE_REGIONS;
1663 flags = flags | TypeFlags::HAS_KNOWN_FREE_LOCAL_REGIONS;
1665 ty::ReEmpty(_) | ty::ReStatic => {
1666 flags = flags | TypeFlags::HAS_KNOWN_FREE_REGIONS;
1668 ty::ReLateBound(..) => {
1669 flags = flags | TypeFlags::HAS_RE_LATE_BOUND;
1672 flags = flags | TypeFlags::HAS_RE_ERASED;
1676 debug!("type_flags({:?}) = {:?}", self, flags);
1681 /// Given an early-bound or free region, returns the `DefId` where it was bound.
1682 /// For example, consider the regions in this snippet of code:
1686 /// ^^ -- early bound, declared on an impl
1688 /// fn bar<'b, 'c>(x: &self, y: &'b u32, z: &'c u64) where 'static: 'c
1689 /// ^^ ^^ ^ anonymous, late-bound
1690 /// | early-bound, appears in where-clauses
1691 /// late-bound, appears only in fn args
1696 /// Here, `free_region_binding_scope('a)` would return the `DefId`
1697 /// of the impl, and for all the other highlighted regions, it
1698 /// would return the `DefId` of the function. In other cases (not shown), this
1699 /// function might return the `DefId` of a closure.
1700 pub fn free_region_binding_scope(&self, tcx: TyCtxt<'_>) -> DefId {
1702 ty::ReEarlyBound(br) => tcx.parent(br.def_id).unwrap(),
1703 ty::ReFree(fr) => fr.scope,
1704 _ => bug!("free_region_binding_scope invoked on inappropriate region: {:?}", self),
1710 impl<'tcx> TyS<'tcx> {
1712 pub fn kind(&self) -> &TyKind<'tcx> {
1717 pub fn flags(&self) -> TypeFlags {
1722 pub fn is_unit(&self) -> bool {
1724 Tuple(ref tys) => tys.is_empty(),
1730 pub fn is_never(&self) -> bool {
1731 matches!(self.kind(), Never)
1735 pub fn is_primitive(&self) -> bool {
1736 self.kind().is_primitive()
1740 pub fn is_adt(&self) -> bool {
1741 matches!(self.kind(), Adt(..))
1745 pub fn is_ref(&self) -> bool {
1746 matches!(self.kind(), Ref(..))
1750 pub fn is_ty_var(&self) -> bool {
1751 matches!(self.kind(), Infer(TyVar(_)))
1755 pub fn ty_vid(&self) -> Option<ty::TyVid> {
1757 &Infer(TyVar(vid)) => Some(vid),
1763 pub fn is_ty_infer(&self) -> bool {
1764 matches!(self.kind(), Infer(_))
1768 pub fn is_phantom_data(&self) -> bool {
1769 if let Adt(def, _) = self.kind() { def.is_phantom_data() } else { false }
1773 pub fn is_bool(&self) -> bool {
1774 *self.kind() == Bool
1777 /// Returns `true` if this type is a `str`.
1779 pub fn is_str(&self) -> bool {
1784 pub fn is_param(&self, index: u32) -> bool {
1786 ty::Param(ref data) => data.index == index,
1792 pub fn is_slice(&self) -> bool {
1794 RawPtr(TypeAndMut { ty, .. }) | Ref(_, ty, _) => matches!(ty.kind(), Slice(_) | Str),
1800 pub fn is_array(&self) -> bool {
1801 matches!(self.kind(), Array(..))
1805 pub fn is_simd(&self) -> bool {
1807 Adt(def, _) => def.repr.simd(),
1812 pub fn sequence_element_type(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1814 Array(ty, _) | Slice(ty) => ty,
1815 Str => tcx.mk_mach_uint(ty::UintTy::U8),
1816 _ => bug!("`sequence_element_type` called on non-sequence value: {}", self),
1820 pub fn simd_size_and_type(&self, tcx: TyCtxt<'tcx>) -> (u64, Ty<'tcx>) {
1822 Adt(def, substs) => {
1823 assert!(def.repr.simd(), "`simd_size_and_type` called on non-SIMD type");
1824 let variant = def.non_enum_variant();
1825 let f0_ty = variant.fields[0].ty(tcx, substs);
1827 match f0_ty.kind() {
1828 // If the first field is an array, we assume it is the only field and its
1829 // elements are the SIMD components.
1830 Array(f0_elem_ty, f0_len) => {
1831 // FIXME(repr_simd): https://github.com/rust-lang/rust/pull/78863#discussion_r522784112
1832 // The way we evaluate the `N` in `[T; N]` here only works since we use
1833 // `simd_size_and_type` post-monomorphization. It will probably start to ICE
1834 // if we use it in generic code. See the `simd-array-trait` ui test.
1835 (f0_len.eval_usize(tcx, ParamEnv::empty()) as u64, f0_elem_ty)
1837 // Otherwise, the fields of this Adt are the SIMD components (and we assume they
1838 // all have the same type).
1839 _ => (variant.fields.len() as u64, f0_ty),
1842 _ => bug!("`simd_size_and_type` called on invalid type"),
1847 pub fn is_region_ptr(&self) -> bool {
1848 matches!(self.kind(), Ref(..))
1852 pub fn is_mutable_ptr(&self) -> bool {
1855 RawPtr(TypeAndMut { mutbl: hir::Mutability::Mut, .. })
1856 | Ref(_, _, hir::Mutability::Mut)
1860 /// Get the mutability of the reference or `None` when not a reference
1862 pub fn ref_mutability(&self) -> Option<hir::Mutability> {
1864 Ref(_, _, mutability) => Some(*mutability),
1870 pub fn is_unsafe_ptr(&self) -> bool {
1871 matches!(self.kind(), RawPtr(_))
1874 /// Tests if this is any kind of primitive pointer type (reference, raw pointer, fn pointer).
1876 pub fn is_any_ptr(&self) -> bool {
1877 self.is_region_ptr() || self.is_unsafe_ptr() || self.is_fn_ptr()
1881 pub fn is_box(&self) -> bool {
1883 Adt(def, _) => def.is_box(),
1888 /// Panics if called on any type other than `Box<T>`.
1889 pub fn boxed_ty(&self) -> Ty<'tcx> {
1891 Adt(def, substs) if def.is_box() => substs.type_at(0),
1892 _ => bug!("`boxed_ty` is called on non-box type {:?}", self),
1896 /// A scalar type is one that denotes an atomic datum, with no sub-components.
1897 /// (A RawPtr is scalar because it represents a non-managed pointer, so its
1898 /// contents are abstract to rustc.)
1900 pub fn is_scalar(&self) -> bool {
1910 | Infer(IntVar(_) | FloatVar(_))
1914 /// Returns `true` if this type is a floating point type.
1916 pub fn is_floating_point(&self) -> bool {
1917 matches!(self.kind(), Float(_) | Infer(FloatVar(_)))
1921 pub fn is_trait(&self) -> bool {
1922 matches!(self.kind(), Dynamic(..))
1926 pub fn is_enum(&self) -> bool {
1927 matches!(self.kind(), Adt(adt_def, _) if adt_def.is_enum())
1931 pub fn is_union(&self) -> bool {
1932 matches!(self.kind(), Adt(adt_def, _) if adt_def.is_union())
1936 pub fn is_closure(&self) -> bool {
1937 matches!(self.kind(), Closure(..))
1941 pub fn is_generator(&self) -> bool {
1942 matches!(self.kind(), Generator(..))
1946 pub fn is_integral(&self) -> bool {
1947 matches!(self.kind(), Infer(IntVar(_)) | Int(_) | Uint(_))
1951 pub fn is_fresh_ty(&self) -> bool {
1952 matches!(self.kind(), Infer(FreshTy(_)))
1956 pub fn is_fresh(&self) -> bool {
1957 matches!(self.kind(), Infer(FreshTy(_) | FreshIntTy(_) | FreshFloatTy(_)))
1961 pub fn is_char(&self) -> bool {
1962 matches!(self.kind(), Char)
1966 pub fn is_numeric(&self) -> bool {
1967 self.is_integral() || self.is_floating_point()
1971 pub fn is_signed(&self) -> bool {
1972 matches!(self.kind(), Int(_))
1976 pub fn is_ptr_sized_integral(&self) -> bool {
1977 matches!(self.kind(), Int(ty::IntTy::Isize) | Uint(ty::UintTy::Usize))
1981 pub fn has_concrete_skeleton(&self) -> bool {
1982 !matches!(self.kind(), Param(_) | Infer(_) | Error(_))
1985 /// Returns the type and mutability of `*ty`.
1987 /// The parameter `explicit` indicates if this is an *explicit* dereference.
1988 /// Some types -- notably unsafe ptrs -- can only be dereferenced explicitly.
1989 pub fn builtin_deref(&self, explicit: bool) -> Option<TypeAndMut<'tcx>> {
1991 Adt(def, _) if def.is_box() => {
1992 Some(TypeAndMut { ty: self.boxed_ty(), mutbl: hir::Mutability::Not })
1994 Ref(_, ty, mutbl) => Some(TypeAndMut { ty, mutbl: *mutbl }),
1995 RawPtr(mt) if explicit => Some(*mt),
2000 /// Returns the type of `ty[i]`.
2001 pub fn builtin_index(&self) -> Option<Ty<'tcx>> {
2003 Array(ty, _) | Slice(ty) => Some(ty),
2008 pub fn fn_sig(&self, tcx: TyCtxt<'tcx>) -> PolyFnSig<'tcx> {
2010 FnDef(def_id, substs) => tcx.fn_sig(*def_id).subst(tcx, substs),
2013 // ignore errors (#54954)
2014 ty::Binder::dummy(FnSig::fake())
2016 Closure(..) => bug!(
2017 "to get the signature of a closure, use `substs.as_closure().sig()` not `fn_sig()`",
2019 _ => bug!("Ty::fn_sig() called on non-fn type: {:?}", self),
2024 pub fn is_fn(&self) -> bool {
2025 matches!(self.kind(), FnDef(..) | FnPtr(_))
2029 pub fn is_fn_ptr(&self) -> bool {
2030 matches!(self.kind(), FnPtr(_))
2034 pub fn is_impl_trait(&self) -> bool {
2035 matches!(self.kind(), Opaque(..))
2039 pub fn ty_adt_def(&self) -> Option<&'tcx AdtDef> {
2041 Adt(adt, _) => Some(adt),
2046 /// Iterates over tuple fields.
2047 /// Panics when called on anything but a tuple.
2048 pub fn tuple_fields(&self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> {
2050 Tuple(substs) => substs.iter().map(|field| field.expect_ty()),
2051 _ => bug!("tuple_fields called on non-tuple"),
2055 /// Get the `i`-th element of a tuple.
2056 /// Panics when called on anything but a tuple.
2057 pub fn tuple_element_ty(&self, i: usize) -> Option<Ty<'tcx>> {
2059 Tuple(substs) => substs.iter().nth(i).map(|field| field.expect_ty()),
2060 _ => bug!("tuple_fields called on non-tuple"),
2064 /// If the type contains variants, returns the valid range of variant indices.
2066 // FIXME: This requires the optimized MIR in the case of generators.
2068 pub fn variant_range(&self, tcx: TyCtxt<'tcx>) -> Option<Range<VariantIdx>> {
2070 TyKind::Adt(adt, _) => Some(adt.variant_range()),
2071 TyKind::Generator(def_id, substs, _) => {
2072 Some(substs.as_generator().variant_range(*def_id, tcx))
2078 /// If the type contains variants, returns the variant for `variant_index`.
2079 /// Panics if `variant_index` is out of range.
2081 // FIXME: This requires the optimized MIR in the case of generators.
2083 pub fn discriminant_for_variant(
2086 variant_index: VariantIdx,
2087 ) -> Option<Discr<'tcx>> {
2089 TyKind::Adt(adt, _) if adt.variants.is_empty() => {
2090 // This can actually happen during CTFE, see
2091 // https://github.com/rust-lang/rust/issues/89765.
2094 TyKind::Adt(adt, _) if adt.is_enum() => {
2095 Some(adt.discriminant_for_variant(tcx, variant_index))
2097 TyKind::Generator(def_id, substs, _) => {
2098 Some(substs.as_generator().discriminant_for_variant(*def_id, tcx, variant_index))
2104 /// Returns the type of the discriminant of this type.
2105 pub fn discriminant_ty(&'tcx self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2107 ty::Adt(adt, _) if adt.is_enum() => adt.repr.discr_type().to_ty(tcx),
2108 ty::Generator(_, substs, _) => substs.as_generator().discr_ty(tcx),
2110 ty::Param(_) | ty::Projection(_) | ty::Opaque(..) | ty::Infer(ty::TyVar(_)) => {
2111 let assoc_items = tcx.associated_item_def_ids(
2112 tcx.require_lang_item(hir::LangItem::DiscriminantKind, None),
2114 tcx.mk_projection(assoc_items[0], tcx.intern_substs(&[self.into()]))
2133 | ty::GeneratorWitness(..)
2137 | ty::Infer(IntVar(_) | FloatVar(_)) => tcx.types.u8,
2140 | ty::Placeholder(_)
2141 | ty::Infer(FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2142 bug!("`discriminant_ty` applied to unexpected type: {:?}", self)
2147 /// Returns the type of metadata for (potentially fat) pointers to this type.
2148 pub fn ptr_metadata_ty(&'tcx self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2149 // FIXME: should this normalize?
2150 let tail = tcx.struct_tail_without_normalization(self);
2153 ty::Infer(ty::IntVar(_) | ty::FloatVar(_))
2164 | ty::GeneratorWitness(..)
2170 // If returned by `struct_tail_without_normalization` this is a unit struct
2171 // without any fields, or not a struct, and therefore is Sized.
2173 // If returned by `struct_tail_without_normalization` this is the empty tuple,
2174 // a.k.a. unit type, which is Sized
2175 | ty::Tuple(..) => tcx.types.unit,
2177 ty::Str | ty::Slice(_) => tcx.types.usize,
2178 ty::Dynamic(..) => {
2179 let dyn_metadata = tcx.lang_items().dyn_metadata().unwrap();
2180 tcx.type_of(dyn_metadata).subst(tcx, &[tail.into()])
2186 | ty::Infer(ty::TyVar(_))
2188 | ty::Placeholder(..)
2189 | ty::Infer(ty::FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2190 bug!("`ptr_metadata_ty` applied to unexpected type: {:?}", tail)
2195 /// When we create a closure, we record its kind (i.e., what trait
2196 /// it implements) into its `ClosureSubsts` using a type
2197 /// parameter. This is kind of a phantom type, except that the
2198 /// most convenient thing for us to are the integral types. This
2199 /// function converts such a special type into the closure
2200 /// kind. To go the other way, use
2201 /// `tcx.closure_kind_ty(closure_kind)`.
2203 /// Note that during type checking, we use an inference variable
2204 /// to represent the closure kind, because it has not yet been
2205 /// inferred. Once upvar inference (in `rustc_typeck/src/check/upvar.rs`)
2206 /// is complete, that type variable will be unified.
2207 pub fn to_opt_closure_kind(&self) -> Option<ty::ClosureKind> {
2209 Int(int_ty) => match int_ty {
2210 ty::IntTy::I8 => Some(ty::ClosureKind::Fn),
2211 ty::IntTy::I16 => Some(ty::ClosureKind::FnMut),
2212 ty::IntTy::I32 => Some(ty::ClosureKind::FnOnce),
2213 _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2216 // "Bound" types appear in canonical queries when the
2217 // closure type is not yet known
2218 Bound(..) | Infer(_) => None,
2220 Error(_) => Some(ty::ClosureKind::Fn),
2222 _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2226 /// Fast path helper for testing if a type is `Sized`.
2228 /// Returning true means the type is known to be sized. Returning
2229 /// `false` means nothing -- could be sized, might not be.
2231 /// Note that we could never rely on the fact that a type such as `[_]` is
2232 /// trivially `!Sized` because we could be in a type environment with a
2233 /// bound such as `[_]: Copy`. A function with such a bound obviously never
2234 /// can be called, but that doesn't mean it shouldn't typecheck. This is why
2235 /// this method doesn't return `Option<bool>`.
2236 pub fn is_trivially_sized(&self, tcx: TyCtxt<'tcx>) -> bool {
2238 ty::Infer(ty::IntVar(_) | ty::FloatVar(_))
2249 | ty::GeneratorWitness(..)
2253 | ty::Error(_) => true,
2255 ty::Str | ty::Slice(_) | ty::Dynamic(..) | ty::Foreign(..) => false,
2257 ty::Tuple(tys) => tys.iter().all(|ty| ty.expect_ty().is_trivially_sized(tcx)),
2259 ty::Adt(def, _substs) => def.sized_constraint(tcx).is_empty(),
2261 ty::Projection(_) | ty::Param(_) | ty::Opaque(..) => false,
2263 ty::Infer(ty::TyVar(_)) => false,
2266 | ty::Placeholder(..)
2267 | ty::Infer(ty::FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2268 bug!("`is_trivially_sized` applied to unexpected type: {:?}", self)
2274 /// Extra information about why we ended up with a particular variance.
2275 /// This is only used to add more information to error messages, and
2276 /// has no effect on soundness. While choosing the 'wrong' `VarianceDiagInfo`
2277 /// may lead to confusing notes in error messages, it will never cause
2278 /// a miscompilation or unsoundness.
2280 /// When in doubt, use `VarianceDiagInfo::default()`
2281 #[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
2282 pub enum VarianceDiagInfo<'tcx> {
2283 /// No additional information - this is the default.
2284 /// We will not add any additional information to error messages.
2287 /// We switched our variance because a type occurs inside
2288 /// the generic argument of a mutable reference or pointer
2289 /// (`*mut T` or `&mut T`). In either case, our variance
2290 /// will always be `Invariant`.
2292 /// Tracks whether we had a mutable pointer or reference,
2293 /// for better error messages
2294 kind: VarianceDiagMutKind,
2295 /// The type parameter of the mutable pointer/reference
2296 /// (the `T` in `&mut T` or `*mut T`).
2301 #[derive(Copy, Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
2302 pub enum VarianceDiagMutKind {
2303 /// A mutable raw pointer (`*mut T`)
2305 /// A mutable reference (`&mut T`)
2309 impl<'tcx> VarianceDiagInfo<'tcx> {
2310 /// Mirrors `Variance::xform` - used to 'combine' the existing
2311 /// and new `VarianceDiagInfo`s when our variance changes.
2312 pub fn xform(self, other: VarianceDiagInfo<'tcx>) -> VarianceDiagInfo<'tcx> {
2313 // For now, just use the first `VarianceDiagInfo::Mut` that we see
2315 VarianceDiagInfo::None => other,
2316 VarianceDiagInfo::Mut { .. } => self,