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, Term, Ty, TyCtxt, TypeFlags, TypeFoldable, TypeVisitor,
14 use crate::ty::{DelaySpanBugEmitted, List, ParamEnv};
15 use polonius_engine::Atom;
16 use rustc_data_structures::captures::Captures;
17 use rustc_data_structures::intern::Interned;
19 use rustc_hir::def_id::DefId;
20 use rustc_index::vec::Idx;
21 use rustc_macros::HashStable;
22 use rustc_span::symbol::{kw, Symbol};
23 use rustc_target::abi::VariantIdx;
24 use rustc_target::spec::abi;
26 use std::cmp::Ordering;
28 use std::marker::PhantomData;
29 use std::ops::{ControlFlow, Deref, Range};
30 use ty::util::IntTypeExt;
32 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
33 #[derive(HashStable, TypeFoldable, Lift)]
34 pub struct TypeAndMut<'tcx> {
36 pub mutbl: hir::Mutability,
39 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
41 /// A "free" region `fr` can be interpreted as "some region
42 /// at least as big as the scope `fr.scope`".
43 pub struct FreeRegion {
45 pub bound_region: BoundRegionKind,
48 #[derive(Clone, PartialEq, PartialOrd, Eq, Ord, Hash, TyEncodable, TyDecodable, Copy)]
50 pub enum BoundRegionKind {
51 /// An anonymous region parameter for a given fn (&T)
54 /// Named region parameters for functions (a in &'a T)
56 /// The `DefId` is needed to distinguish free regions in
57 /// the event of shadowing.
58 BrNamed(DefId, Symbol),
60 /// Anonymous region for the implicit env pointer parameter
65 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable, Debug, PartialOrd, Ord)]
67 pub struct BoundRegion {
69 pub kind: BoundRegionKind,
72 impl BoundRegionKind {
73 pub fn is_named(&self) -> bool {
75 BoundRegionKind::BrNamed(_, name) => name != kw::UnderscoreLifetime,
81 /// Defines the kinds of types used by the type system.
83 /// Types written by the user start out as [hir::TyKind](rustc_hir::TyKind) and get
84 /// converted to this representation using `AstConv::ast_ty_to_ty`.
85 #[derive(Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable, Debug)]
87 #[rustc_diagnostic_item = "TyKind"]
88 pub enum TyKind<'tcx> {
89 /// The primitive boolean type. Written as `bool`.
92 /// The primitive character type; holds a Unicode scalar value
93 /// (a non-surrogate code point). Written as `char`.
96 /// A primitive signed integer type. For example, `i32`.
99 /// A primitive unsigned integer type. For example, `u32`.
102 /// A primitive floating-point type. For example, `f64`.
105 /// Algebraic data types (ADT). For example: structures, enumerations and unions.
107 /// For example, the type `List<i32>` would be represented using the `AdtDef`
108 /// for `struct List<T>` and the substs `[i32]`.
110 /// Note that generic parameters in fields only get lazily substituted
111 /// by using something like `adt_def.all_fields().map(|field| field.ty(tcx, substs))`.
112 Adt(&'tcx AdtDef, SubstsRef<'tcx>),
114 /// An unsized FFI type that is opaque to Rust. Written as `extern type T`.
117 /// The pointee of a string slice. Written as `str`.
120 /// An array with the given length. Written as `[T; N]`.
121 Array(Ty<'tcx>, ty::Const<'tcx>),
123 /// The pointee of an array slice. Written as `[T]`.
126 /// A raw pointer. Written as `*mut T` or `*const T`
127 RawPtr(TypeAndMut<'tcx>),
129 /// A reference; a pointer with an associated lifetime. Written as
130 /// `&'a mut T` or `&'a T`.
131 Ref(Region<'tcx>, Ty<'tcx>, hir::Mutability),
133 /// The anonymous type of a function declaration/definition. Each
134 /// function has a unique type.
136 /// For the function `fn foo() -> i32 { 3 }` this type would be
137 /// shown to the user as `fn() -> i32 {foo}`.
139 /// For example the type of `bar` here:
141 /// fn foo() -> i32 { 1 }
142 /// let bar = foo; // bar: fn() -> i32 {foo}
144 FnDef(DefId, SubstsRef<'tcx>),
146 /// A pointer to a function. Written as `fn() -> i32`.
148 /// Note that both functions and closures start out as either
149 /// [FnDef] or [Closure] which can be then be coerced to this variant.
151 /// For example the type of `bar` here:
154 /// fn foo() -> i32 { 1 }
155 /// let bar: fn() -> i32 = foo;
157 FnPtr(PolyFnSig<'tcx>),
159 /// A trait object. Written as `dyn for<'b> Trait<'b, Assoc = u32> + Send + 'a`.
160 Dynamic(&'tcx List<Binder<'tcx, ExistentialPredicate<'tcx>>>, ty::Region<'tcx>),
162 /// The anonymous type of a closure. Used to represent the type of `|a| a`.
164 /// Closure substs contain both the - potentially substituted - generic parameters
165 /// of its parent and some synthetic parameters. See the documentation for
166 /// [ClosureSubsts] for more details.
167 Closure(DefId, SubstsRef<'tcx>),
169 /// The anonymous type of a generator. Used to represent the type of
172 /// For more info about generator substs, visit the documentation for
173 /// [GeneratorSubsts].
174 Generator(DefId, SubstsRef<'tcx>, hir::Movability),
176 /// A type representing the types stored inside a generator.
177 /// This should only appear as part of the [GeneratorSubsts].
179 /// Note that the captured variables for generators are stored separately
180 /// using a tuple in the same way as for closures.
182 /// Unlike upvars, the witness can reference lifetimes from
183 /// inside of the generator itself. To deal with them in
184 /// the type of the generator, we convert them to higher ranked
185 /// lifetimes bound by the witness itself.
187 /// Looking at the following example, the witness for this generator
188 /// may end up as something like `for<'a> [Vec<i32>, &'a Vec<i32>]`:
192 /// let x = &vec![3];
197 GeneratorWitness(Binder<'tcx, &'tcx List<Ty<'tcx>>>),
199 /// The never type `!`.
202 /// A tuple type. For example, `(i32, bool)`.
203 /// Use `Ty::tuple_fields` to iterate over the field types.
204 Tuple(SubstsRef<'tcx>),
206 /// The projection of an associated type. For example,
207 /// `<T as Trait<..>>::N`.
208 Projection(ProjectionTy<'tcx>),
210 /// Opaque (`impl Trait`) type found in a return type.
212 /// The `DefId` comes either from
213 /// * the `impl Trait` ast::Ty node,
214 /// * or the `type Foo = impl Trait` declaration
216 /// For RPIT the substitutions are for the generics of the function,
217 /// while for TAIT it is used for the generic parameters of the alias.
219 /// During codegen, `tcx.type_of(def_id)` can be used to get the underlying type.
220 Opaque(DefId, SubstsRef<'tcx>),
222 /// A type parameter; for example, `T` in `fn f<T>(x: T) {}`.
225 /// Bound type variable, used to represent the `'a` in `for<'a> fn(&'a ())`.
227 /// For canonical queries, we replace inference variables with bound variables,
228 /// so e.g. when checking whether `&'_ (): Trait<_>` holds, we canonicalize that to
229 /// `for<'a, T> &'a (): Trait<T>` and then convert the introduced bound variables
230 /// back to inference variables in a new inference context when inside of the query.
232 /// See the `rustc-dev-guide` for more details about
233 /// [higher-ranked trait bounds][1] and [canonical queries][2].
235 /// [1]: https://rustc-dev-guide.rust-lang.org/traits/hrtb.html
236 /// [2]: https://rustc-dev-guide.rust-lang.org/traits/canonical-queries.html
237 Bound(ty::DebruijnIndex, BoundTy),
239 /// A placeholder type, used during higher ranked subtyping to instantiate
241 Placeholder(ty::PlaceholderType),
243 /// A type variable used during type checking.
245 /// Similar to placeholders, inference variables also live in a universe to
246 /// correctly deal with higher ranked types. Though unlike placeholders,
247 /// that universe is stored in the `InferCtxt` instead of directly
248 /// inside of the type.
251 /// A placeholder for a type which could not be computed; this is
252 /// propagated to avoid useless error messages.
253 Error(DelaySpanBugEmitted),
256 impl<'tcx> TyKind<'tcx> {
258 pub fn is_primitive(&self) -> bool {
259 matches!(self, Bool | Char | Int(_) | Uint(_) | Float(_))
262 /// Get the article ("a" or "an") to use with this type.
263 pub fn article(&self) -> &'static str {
265 Int(_) | Float(_) | Array(_, _) => "an",
266 Adt(def, _) if def.is_enum() => "an",
267 // This should never happen, but ICEing and causing the user's code
268 // to not compile felt too harsh.
275 // `TyKind` is used a lot. Make sure it doesn't unintentionally get bigger.
276 #[cfg(all(target_arch = "x86_64", target_pointer_width = "64"))]
277 static_assert_size!(TyKind<'_>, 32);
279 /// A closure can be modeled as a struct that looks like:
281 /// struct Closure<'l0...'li, T0...Tj, CK, CS, U>(...U);
285 /// - 'l0...'li and T0...Tj are the generic parameters
286 /// in scope on the function that defined the closure,
287 /// - CK represents the *closure kind* (Fn vs FnMut vs FnOnce). This
288 /// is rather hackily encoded via a scalar type. See
289 /// `Ty::to_opt_closure_kind` for details.
290 /// - CS represents the *closure signature*, representing as a `fn()`
291 /// type. For example, `fn(u32, u32) -> u32` would mean that the closure
292 /// implements `CK<(u32, u32), Output = u32>`, where `CK` is the trait
294 /// - U is a type parameter representing the types of its upvars, tupled up
295 /// (borrowed, if appropriate; that is, if a U field represents a by-ref upvar,
296 /// and the up-var has the type `Foo`, then that field of U will be `&Foo`).
298 /// So, for example, given this function:
300 /// fn foo<'a, T>(data: &'a mut T) {
301 /// do(|| data.count += 1)
304 /// the type of the closure would be something like:
306 /// struct Closure<'a, T, U>(...U);
308 /// Note that the type of the upvar is not specified in the struct.
309 /// You may wonder how the impl would then be able to use the upvar,
310 /// if it doesn't know it's type? The answer is that the impl is
311 /// (conceptually) not fully generic over Closure but rather tied to
312 /// instances with the expected upvar types:
314 /// impl<'b, 'a, T> FnMut() for Closure<'a, T, (&'b mut &'a mut T,)> {
318 /// You can see that the *impl* fully specified the type of the upvar
319 /// and thus knows full well that `data` has type `&'b mut &'a mut T`.
320 /// (Here, I am assuming that `data` is mut-borrowed.)
322 /// Now, the last question you may ask is: Why include the upvar types
323 /// in an extra type parameter? The reason for this design is that the
324 /// upvar types can reference lifetimes that are internal to the
325 /// creating function. In my example above, for example, the lifetime
326 /// `'b` represents the scope of the closure itself; this is some
327 /// subset of `foo`, probably just the scope of the call to the to
328 /// `do()`. If we just had the lifetime/type parameters from the
329 /// enclosing function, we couldn't name this lifetime `'b`. Note that
330 /// there can also be lifetimes in the types of the upvars themselves,
331 /// if one of them happens to be a reference to something that the
332 /// creating fn owns.
334 /// OK, you say, so why not create a more minimal set of parameters
335 /// that just includes the extra lifetime parameters? The answer is
336 /// primarily that it would be hard --- we don't know at the time when
337 /// we create the closure type what the full types of the upvars are,
338 /// nor do we know which are borrowed and which are not. In this
339 /// design, we can just supply a fresh type parameter and figure that
342 /// All right, you say, but why include the type parameters from the
343 /// original function then? The answer is that codegen may need them
344 /// when monomorphizing, and they may not appear in the upvars. A
345 /// closure could capture no variables but still make use of some
346 /// in-scope type parameter with a bound (e.g., if our example above
347 /// had an extra `U: Default`, and the closure called `U::default()`).
349 /// There is another reason. This design (implicitly) prohibits
350 /// closures from capturing themselves (except via a trait
351 /// object). This simplifies closure inference considerably, since it
352 /// means that when we infer the kind of a closure or its upvars, we
353 /// don't have to handle cycles where the decisions we make for
354 /// closure C wind up influencing the decisions we ought to make for
355 /// closure C (which would then require fixed point iteration to
356 /// handle). Plus it fixes an ICE. :P
360 /// Generators are handled similarly in `GeneratorSubsts`. The set of
361 /// type parameters is similar, but `CK` and `CS` are replaced by the
362 /// following type parameters:
364 /// * `GS`: The generator's "resume type", which is the type of the
365 /// argument passed to `resume`, and the type of `yield` expressions
366 /// inside the generator.
367 /// * `GY`: The "yield type", which is the type of values passed to
368 /// `yield` inside the generator.
369 /// * `GR`: The "return type", which is the type of value returned upon
370 /// completion of the generator.
371 /// * `GW`: The "generator witness".
372 #[derive(Copy, Clone, Debug, TypeFoldable)]
373 pub struct ClosureSubsts<'tcx> {
374 /// Lifetime and type parameters from the enclosing function,
375 /// concatenated with a tuple containing the types of the upvars.
377 /// These are separated out because codegen wants to pass them around
378 /// when monomorphizing.
379 pub substs: SubstsRef<'tcx>,
382 /// Struct returned by `split()`.
383 pub struct ClosureSubstsParts<'tcx, T> {
384 pub parent_substs: &'tcx [GenericArg<'tcx>],
385 pub closure_kind_ty: T,
386 pub closure_sig_as_fn_ptr_ty: T,
387 pub tupled_upvars_ty: T,
390 impl<'tcx> ClosureSubsts<'tcx> {
391 /// Construct `ClosureSubsts` from `ClosureSubstsParts`, containing `Substs`
392 /// for the closure parent, alongside additional closure-specific components.
395 parts: ClosureSubstsParts<'tcx, Ty<'tcx>>,
396 ) -> ClosureSubsts<'tcx> {
398 substs: tcx.mk_substs(
399 parts.parent_substs.iter().copied().chain(
400 [parts.closure_kind_ty, parts.closure_sig_as_fn_ptr_ty, parts.tupled_upvars_ty]
402 .map(|&ty| ty.into()),
408 /// Divides the closure substs into their respective components.
409 /// The ordering assumed here must match that used by `ClosureSubsts::new` above.
410 fn split(self) -> ClosureSubstsParts<'tcx, GenericArg<'tcx>> {
411 match self.substs[..] {
413 ref parent_substs @ ..,
415 closure_sig_as_fn_ptr_ty,
417 ] => ClosureSubstsParts {
420 closure_sig_as_fn_ptr_ty,
423 _ => bug!("closure substs missing synthetics"),
427 /// Returns `true` only if enough of the synthetic types are known to
428 /// allow using all of the methods on `ClosureSubsts` without panicking.
430 /// Used primarily by `ty::print::pretty` to be able to handle closure
431 /// types that haven't had their synthetic types substituted in.
432 pub fn is_valid(self) -> bool {
433 self.substs.len() >= 3
434 && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
437 /// Returns the substitutions of the closure's parent.
438 pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
439 self.split().parent_substs
442 /// Returns an iterator over the list of types of captured paths by the closure.
443 /// In case there was a type error in figuring out the types of the captured path, an
444 /// empty iterator is returned.
446 pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
447 match self.tupled_upvars_ty().kind() {
448 TyKind::Error(_) => None,
449 TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
450 TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
451 ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
457 /// Returns the tuple type representing the upvars for this closure.
459 pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
460 self.split().tupled_upvars_ty.expect_ty()
463 /// Returns the closure kind for this closure; may return a type
464 /// variable during inference. To get the closure kind during
465 /// inference, use `infcx.closure_kind(substs)`.
466 pub fn kind_ty(self) -> Ty<'tcx> {
467 self.split().closure_kind_ty.expect_ty()
470 /// Returns the `fn` pointer type representing the closure signature for this
472 // FIXME(eddyb) this should be unnecessary, as the shallowly resolved
473 // type is known at the time of the creation of `ClosureSubsts`,
474 // see `rustc_typeck::check::closure`.
475 pub fn sig_as_fn_ptr_ty(self) -> Ty<'tcx> {
476 self.split().closure_sig_as_fn_ptr_ty.expect_ty()
479 /// Returns the closure kind for this closure; only usable outside
480 /// of an inference context, because in that context we know that
481 /// there are no type variables.
483 /// If you have an inference context, use `infcx.closure_kind()`.
484 pub fn kind(self) -> ty::ClosureKind {
485 self.kind_ty().to_opt_closure_kind().unwrap()
488 /// Extracts the signature from the closure.
489 pub fn sig(self) -> ty::PolyFnSig<'tcx> {
490 let ty = self.sig_as_fn_ptr_ty();
492 ty::FnPtr(sig) => *sig,
493 _ => bug!("closure_sig_as_fn_ptr_ty is not a fn-ptr: {:?}", ty.kind()),
498 /// Similar to `ClosureSubsts`; see the above documentation for more.
499 #[derive(Copy, Clone, Debug, TypeFoldable)]
500 pub struct GeneratorSubsts<'tcx> {
501 pub substs: SubstsRef<'tcx>,
504 pub struct GeneratorSubstsParts<'tcx, T> {
505 pub parent_substs: &'tcx [GenericArg<'tcx>],
510 pub tupled_upvars_ty: T,
513 impl<'tcx> GeneratorSubsts<'tcx> {
514 /// Construct `GeneratorSubsts` from `GeneratorSubstsParts`, containing `Substs`
515 /// for the generator parent, alongside additional generator-specific components.
518 parts: GeneratorSubstsParts<'tcx, Ty<'tcx>>,
519 ) -> GeneratorSubsts<'tcx> {
521 substs: tcx.mk_substs(
522 parts.parent_substs.iter().copied().chain(
528 parts.tupled_upvars_ty,
531 .map(|&ty| ty.into()),
537 /// Divides the generator substs into their respective components.
538 /// The ordering assumed here must match that used by `GeneratorSubsts::new` above.
539 fn split(self) -> GeneratorSubstsParts<'tcx, GenericArg<'tcx>> {
540 match self.substs[..] {
541 [ref parent_substs @ .., resume_ty, yield_ty, return_ty, witness, tupled_upvars_ty] => {
542 GeneratorSubstsParts {
551 _ => bug!("generator substs missing synthetics"),
555 /// Returns `true` only if enough of the synthetic types are known to
556 /// allow using all of the methods on `GeneratorSubsts` without panicking.
558 /// Used primarily by `ty::print::pretty` to be able to handle generator
559 /// types that haven't had their synthetic types substituted in.
560 pub fn is_valid(self) -> bool {
561 self.substs.len() >= 5
562 && matches!(self.split().tupled_upvars_ty.expect_ty().kind(), Tuple(_))
565 /// Returns the substitutions of the generator's parent.
566 pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
567 self.split().parent_substs
570 /// This describes the types that can be contained in a generator.
571 /// It will be a type variable initially and unified in the last stages of typeck of a body.
572 /// It contains a tuple of all the types that could end up on a generator frame.
573 /// The state transformation MIR pass may only produce layouts which mention types
574 /// in this tuple. Upvars are not counted here.
575 pub fn witness(self) -> Ty<'tcx> {
576 self.split().witness.expect_ty()
579 /// Returns an iterator over the list of types of captured paths by the generator.
580 /// In case there was a type error in figuring out the types of the captured path, an
581 /// empty iterator is returned.
583 pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
584 match self.tupled_upvars_ty().kind() {
585 TyKind::Error(_) => None,
586 TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
587 TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
588 ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
594 /// Returns the tuple type representing the upvars for this generator.
596 pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
597 self.split().tupled_upvars_ty.expect_ty()
600 /// Returns the type representing the resume type of the generator.
601 pub fn resume_ty(self) -> Ty<'tcx> {
602 self.split().resume_ty.expect_ty()
605 /// Returns the type representing the yield type of the generator.
606 pub fn yield_ty(self) -> Ty<'tcx> {
607 self.split().yield_ty.expect_ty()
610 /// Returns the type representing the return type of the generator.
611 pub fn return_ty(self) -> Ty<'tcx> {
612 self.split().return_ty.expect_ty()
615 /// Returns the "generator signature", which consists of its yield
616 /// and return types.
618 /// N.B., some bits of the code prefers to see this wrapped in a
619 /// binder, but it never contains bound regions. Probably this
620 /// function should be removed.
621 pub fn poly_sig(self) -> PolyGenSig<'tcx> {
622 ty::Binder::dummy(self.sig())
625 /// Returns the "generator signature", which consists of its resume, yield
626 /// and return types.
627 pub fn sig(self) -> GenSig<'tcx> {
629 resume_ty: self.resume_ty(),
630 yield_ty: self.yield_ty(),
631 return_ty: self.return_ty(),
636 impl<'tcx> GeneratorSubsts<'tcx> {
637 /// Generator has not been resumed yet.
638 pub const UNRESUMED: usize = 0;
639 /// Generator has returned or is completed.
640 pub const RETURNED: usize = 1;
641 /// Generator has been poisoned.
642 pub const POISONED: usize = 2;
644 const UNRESUMED_NAME: &'static str = "Unresumed";
645 const RETURNED_NAME: &'static str = "Returned";
646 const POISONED_NAME: &'static str = "Panicked";
648 /// The valid variant indices of this generator.
650 pub fn variant_range(&self, def_id: DefId, tcx: TyCtxt<'tcx>) -> Range<VariantIdx> {
651 // FIXME requires optimized MIR
652 let num_variants = tcx.generator_layout(def_id).unwrap().variant_fields.len();
653 VariantIdx::new(0)..VariantIdx::new(num_variants)
656 /// The discriminant for the given variant. Panics if the `variant_index` is
659 pub fn discriminant_for_variant(
663 variant_index: VariantIdx,
665 // Generators don't support explicit discriminant values, so they are
666 // the same as the variant index.
667 assert!(self.variant_range(def_id, tcx).contains(&variant_index));
668 Discr { val: variant_index.as_usize() as u128, ty: self.discr_ty(tcx) }
671 /// The set of all discriminants for the generator, enumerated with their
674 pub fn discriminants(
678 ) -> impl Iterator<Item = (VariantIdx, Discr<'tcx>)> + Captures<'tcx> {
679 self.variant_range(def_id, tcx).map(move |index| {
680 (index, Discr { val: index.as_usize() as u128, ty: self.discr_ty(tcx) })
684 /// Calls `f` with a reference to the name of the enumerator for the given
686 pub fn variant_name(v: VariantIdx) -> Cow<'static, str> {
688 Self::UNRESUMED => Cow::from(Self::UNRESUMED_NAME),
689 Self::RETURNED => Cow::from(Self::RETURNED_NAME),
690 Self::POISONED => Cow::from(Self::POISONED_NAME),
691 _ => Cow::from(format!("Suspend{}", v.as_usize() - 3)),
695 /// The type of the state discriminant used in the generator type.
697 pub fn discr_ty(&self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
701 /// This returns the types of the MIR locals which had to be stored across suspension points.
702 /// It is calculated in rustc_const_eval::transform::generator::StateTransform.
703 /// All the types here must be in the tuple in GeneratorInterior.
705 /// The locals are grouped by their variant number. Note that some locals may
706 /// be repeated in multiple variants.
712 ) -> impl Iterator<Item = impl Iterator<Item = Ty<'tcx>> + Captures<'tcx>> {
713 let layout = tcx.generator_layout(def_id).unwrap();
714 layout.variant_fields.iter().map(move |variant| {
715 variant.iter().map(move |field| layout.field_tys[*field].subst(tcx, self.substs))
719 /// This is the types of the fields of a generator which are not stored in a
722 pub fn prefix_tys(self) -> impl Iterator<Item = Ty<'tcx>> {
727 #[derive(Debug, Copy, Clone, HashStable)]
728 pub enum UpvarSubsts<'tcx> {
729 Closure(SubstsRef<'tcx>),
730 Generator(SubstsRef<'tcx>),
733 impl<'tcx> UpvarSubsts<'tcx> {
734 /// Returns an iterator over the list of types of captured paths by the closure/generator.
735 /// In case there was a type error in figuring out the types of the captured path, an
736 /// empty iterator is returned.
738 pub fn upvar_tys(self) -> impl Iterator<Item = Ty<'tcx>> + 'tcx {
739 let tupled_tys = match self {
740 UpvarSubsts::Closure(substs) => substs.as_closure().tupled_upvars_ty(),
741 UpvarSubsts::Generator(substs) => substs.as_generator().tupled_upvars_ty(),
744 match tupled_tys.kind() {
745 TyKind::Error(_) => None,
746 TyKind::Tuple(..) => Some(self.tupled_upvars_ty().tuple_fields()),
747 TyKind::Infer(_) => bug!("upvar_tys called before capture types are inferred"),
748 ty => bug!("Unexpected representation of upvar types tuple {:?}", ty),
755 pub fn tupled_upvars_ty(self) -> Ty<'tcx> {
757 UpvarSubsts::Closure(substs) => substs.as_closure().tupled_upvars_ty(),
758 UpvarSubsts::Generator(substs) => substs.as_generator().tupled_upvars_ty(),
763 /// An inline const is modeled like
765 /// const InlineConst<'l0...'li, T0...Tj, R>: R;
769 /// - 'l0...'li and T0...Tj are the generic parameters
770 /// inherited from the item that defined the inline const,
771 /// - R represents the type of the constant.
773 /// When the inline const is instantiated, `R` is substituted as the actual inferred
774 /// type of the constant. The reason that `R` is represented as an extra type parameter
775 /// is the same reason that [`ClosureSubsts`] have `CS` and `U` as type parameters:
776 /// inline const can reference lifetimes that are internal to the creating function.
777 #[derive(Copy, Clone, Debug, TypeFoldable)]
778 pub struct InlineConstSubsts<'tcx> {
779 /// Generic parameters from the enclosing item,
780 /// concatenated with the inferred type of the constant.
781 pub substs: SubstsRef<'tcx>,
784 /// Struct returned by `split()`.
785 pub struct InlineConstSubstsParts<'tcx, T> {
786 pub parent_substs: &'tcx [GenericArg<'tcx>],
790 impl<'tcx> InlineConstSubsts<'tcx> {
791 /// Construct `InlineConstSubsts` from `InlineConstSubstsParts`.
794 parts: InlineConstSubstsParts<'tcx, Ty<'tcx>>,
795 ) -> InlineConstSubsts<'tcx> {
797 substs: tcx.mk_substs(
798 parts.parent_substs.iter().copied().chain(std::iter::once(parts.ty.into())),
803 /// Divides the inline const substs into their respective components.
804 /// The ordering assumed here must match that used by `InlineConstSubsts::new` above.
805 fn split(self) -> InlineConstSubstsParts<'tcx, GenericArg<'tcx>> {
806 match self.substs[..] {
807 [ref parent_substs @ .., ty] => InlineConstSubstsParts { parent_substs, ty },
808 _ => bug!("inline const substs missing synthetics"),
812 /// Returns the substitutions of the inline const's parent.
813 pub fn parent_substs(self) -> &'tcx [GenericArg<'tcx>] {
814 self.split().parent_substs
817 /// Returns the type of this inline const.
818 pub fn ty(self) -> Ty<'tcx> {
819 self.split().ty.expect_ty()
823 #[derive(Debug, Copy, Clone, PartialEq, PartialOrd, Ord, Eq, Hash, TyEncodable, TyDecodable)]
824 #[derive(HashStable, TypeFoldable)]
825 pub enum ExistentialPredicate<'tcx> {
826 /// E.g., `Iterator`.
827 Trait(ExistentialTraitRef<'tcx>),
828 /// E.g., `Iterator::Item = T`.
829 Projection(ExistentialProjection<'tcx>),
834 impl<'tcx> ExistentialPredicate<'tcx> {
835 /// Compares via an ordering that will not change if modules are reordered or other changes are
836 /// made to the tree. In particular, this ordering is preserved across incremental compilations.
837 pub fn stable_cmp(&self, tcx: TyCtxt<'tcx>, other: &Self) -> Ordering {
838 use self::ExistentialPredicate::*;
839 match (*self, *other) {
840 (Trait(_), Trait(_)) => Ordering::Equal,
841 (Projection(ref a), Projection(ref b)) => {
842 tcx.def_path_hash(a.item_def_id).cmp(&tcx.def_path_hash(b.item_def_id))
844 (AutoTrait(ref a), AutoTrait(ref b)) => {
845 tcx.def_path_hash(*a).cmp(&tcx.def_path_hash(*b))
847 (Trait(_), _) => Ordering::Less,
848 (Projection(_), Trait(_)) => Ordering::Greater,
849 (Projection(_), _) => Ordering::Less,
850 (AutoTrait(_), _) => Ordering::Greater,
855 impl<'tcx> Binder<'tcx, ExistentialPredicate<'tcx>> {
856 pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::Predicate<'tcx> {
857 use crate::ty::ToPredicate;
858 match self.skip_binder() {
859 ExistentialPredicate::Trait(tr) => {
860 self.rebind(tr).with_self_ty(tcx, self_ty).without_const().to_predicate(tcx)
862 ExistentialPredicate::Projection(p) => {
863 self.rebind(p.with_self_ty(tcx, self_ty)).to_predicate(tcx)
865 ExistentialPredicate::AutoTrait(did) => {
866 let trait_ref = self.rebind(ty::TraitRef {
868 substs: tcx.mk_substs_trait(self_ty, &[]),
870 trait_ref.without_const().to_predicate(tcx)
876 impl<'tcx> List<ty::Binder<'tcx, ExistentialPredicate<'tcx>>> {
877 /// Returns the "principal `DefId`" of this set of existential predicates.
879 /// A Rust trait object type consists (in addition to a lifetime bound)
880 /// of a set of trait bounds, which are separated into any number
881 /// of auto-trait bounds, and at most one non-auto-trait bound. The
882 /// non-auto-trait bound is called the "principal" of the trait
885 /// Only the principal can have methods or type parameters (because
886 /// auto traits can have neither of them). This is important, because
887 /// it means the auto traits can be treated as an unordered set (methods
888 /// would force an order for the vtable, while relating traits with
889 /// type parameters without knowing the order to relate them in is
890 /// a rather non-trivial task).
892 /// For example, in the trait object `dyn fmt::Debug + Sync`, the
893 /// principal bound is `Some(fmt::Debug)`, while the auto-trait bounds
894 /// are the set `{Sync}`.
896 /// It is also possible to have a "trivial" trait object that
897 /// consists only of auto traits, with no principal - for example,
898 /// `dyn Send + Sync`. In that case, the set of auto-trait bounds
899 /// is `{Send, Sync}`, while there is no principal. These trait objects
900 /// have a "trivial" vtable consisting of just the size, alignment,
902 pub fn principal(&self) -> Option<ty::Binder<'tcx, ExistentialTraitRef<'tcx>>> {
904 .map_bound(|this| match this {
905 ExistentialPredicate::Trait(tr) => Some(tr),
911 pub fn principal_def_id(&self) -> Option<DefId> {
912 self.principal().map(|trait_ref| trait_ref.skip_binder().def_id)
916 pub fn projection_bounds<'a>(
918 ) -> impl Iterator<Item = ty::Binder<'tcx, ExistentialProjection<'tcx>>> + 'a {
919 self.iter().filter_map(|predicate| {
921 .map_bound(|pred| match pred {
922 ExistentialPredicate::Projection(projection) => Some(projection),
930 pub fn auto_traits<'a>(&'a self) -> impl Iterator<Item = DefId> + 'a {
931 self.iter().filter_map(|predicate| match predicate.skip_binder() {
932 ExistentialPredicate::AutoTrait(did) => Some(did),
938 /// A complete reference to a trait. These take numerous guises in syntax,
939 /// but perhaps the most recognizable form is in a where-clause:
943 /// This would be represented by a trait-reference where the `DefId` is the
944 /// `DefId` for the trait `Foo` and the substs define `T` as parameter 0,
945 /// and `U` as parameter 1.
947 /// Trait references also appear in object types like `Foo<U>`, but in
948 /// that case the `Self` parameter is absent from the substitutions.
949 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
950 #[derive(HashStable, TypeFoldable)]
951 pub struct TraitRef<'tcx> {
953 pub substs: SubstsRef<'tcx>,
956 impl<'tcx> TraitRef<'tcx> {
957 pub fn new(def_id: DefId, substs: SubstsRef<'tcx>) -> TraitRef<'tcx> {
958 TraitRef { def_id, substs }
961 /// Returns a `TraitRef` of the form `P0: Foo<P1..Pn>` where `Pi`
962 /// are the parameters defined on trait.
963 pub fn identity(tcx: TyCtxt<'tcx>, def_id: DefId) -> Binder<'tcx, TraitRef<'tcx>> {
964 ty::Binder::dummy(TraitRef {
966 substs: InternalSubsts::identity_for_item(tcx, def_id),
971 pub fn self_ty(&self) -> Ty<'tcx> {
972 self.substs.type_at(0)
978 substs: SubstsRef<'tcx>,
979 ) -> ty::TraitRef<'tcx> {
980 let defs = tcx.generics_of(trait_id);
982 ty::TraitRef { def_id: trait_id, substs: tcx.intern_substs(&substs[..defs.params.len()]) }
986 pub type PolyTraitRef<'tcx> = Binder<'tcx, TraitRef<'tcx>>;
988 impl<'tcx> PolyTraitRef<'tcx> {
989 pub fn self_ty(&self) -> Binder<'tcx, Ty<'tcx>> {
990 self.map_bound_ref(|tr| tr.self_ty())
993 pub fn def_id(&self) -> DefId {
994 self.skip_binder().def_id
997 pub fn to_poly_trait_predicate(&self) -> ty::PolyTraitPredicate<'tcx> {
998 self.map_bound(|trait_ref| ty::TraitPredicate {
1000 constness: ty::BoundConstness::NotConst,
1001 polarity: ty::ImplPolarity::Positive,
1006 /// An existential reference to a trait, where `Self` is erased.
1007 /// For example, the trait object `Trait<'a, 'b, X, Y>` is:
1009 /// exists T. T: Trait<'a, 'b, X, Y>
1011 /// The substitutions don't include the erased `Self`, only trait
1012 /// type and lifetime parameters (`[X, Y]` and `['a, 'b]` above).
1013 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1014 #[derive(HashStable, TypeFoldable)]
1015 pub struct ExistentialTraitRef<'tcx> {
1017 pub substs: SubstsRef<'tcx>,
1020 impl<'tcx> ExistentialTraitRef<'tcx> {
1021 pub fn erase_self_ty(
1023 trait_ref: ty::TraitRef<'tcx>,
1024 ) -> ty::ExistentialTraitRef<'tcx> {
1025 // Assert there is a Self.
1026 trait_ref.substs.type_at(0);
1028 ty::ExistentialTraitRef {
1029 def_id: trait_ref.def_id,
1030 substs: tcx.intern_substs(&trait_ref.substs[1..]),
1034 /// Object types don't have a self type specified. Therefore, when
1035 /// we convert the principal trait-ref into a normal trait-ref,
1036 /// you must give *some* self type. A common choice is `mk_err()`
1037 /// or some placeholder type.
1038 pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::TraitRef<'tcx> {
1039 // otherwise the escaping vars would be captured by the binder
1040 // debug_assert!(!self_ty.has_escaping_bound_vars());
1042 ty::TraitRef { def_id: self.def_id, substs: tcx.mk_substs_trait(self_ty, self.substs) }
1046 pub type PolyExistentialTraitRef<'tcx> = Binder<'tcx, ExistentialTraitRef<'tcx>>;
1048 impl<'tcx> PolyExistentialTraitRef<'tcx> {
1049 pub fn def_id(&self) -> DefId {
1050 self.skip_binder().def_id
1053 /// Object types don't have a self type specified. Therefore, when
1054 /// we convert the principal trait-ref into a normal trait-ref,
1055 /// you must give *some* self type. A common choice is `mk_err()`
1056 /// or some placeholder type.
1057 pub fn with_self_ty(&self, tcx: TyCtxt<'tcx>, self_ty: Ty<'tcx>) -> ty::PolyTraitRef<'tcx> {
1058 self.map_bound(|trait_ref| trait_ref.with_self_ty(tcx, self_ty))
1062 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1063 #[derive(HashStable)]
1064 pub enum BoundVariableKind {
1066 Region(BoundRegionKind),
1070 /// Binder is a binder for higher-ranked lifetimes or types. It is part of the
1071 /// compiler's representation for things like `for<'a> Fn(&'a isize)`
1072 /// (which would be represented by the type `PolyTraitRef ==
1073 /// Binder<'tcx, TraitRef>`). Note that when we instantiate,
1074 /// erase, or otherwise "discharge" these bound vars, we change the
1075 /// type from `Binder<'tcx, T>` to just `T` (see
1076 /// e.g., `liberate_late_bound_regions`).
1078 /// `Decodable` and `Encodable` are implemented for `Binder<T>` using the `impl_binder_encode_decode!` macro.
1079 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug)]
1080 pub struct Binder<'tcx, T>(T, &'tcx List<BoundVariableKind>);
1082 impl<'tcx, T> Binder<'tcx, T>
1084 T: TypeFoldable<'tcx>,
1086 /// Wraps `value` in a binder, asserting that `value` does not
1087 /// contain any bound vars that would be bound by the
1088 /// binder. This is commonly used to 'inject' a value T into a
1089 /// different binding level.
1090 pub fn dummy(value: T) -> Binder<'tcx, T> {
1091 assert!(!value.has_escaping_bound_vars());
1092 Binder(value, ty::List::empty())
1095 pub fn bind_with_vars(value: T, vars: &'tcx List<BoundVariableKind>) -> Binder<'tcx, T> {
1096 if cfg!(debug_assertions) {
1097 let mut validator = ValidateBoundVars::new(vars);
1098 value.visit_with(&mut validator);
1104 impl<'tcx, T> Binder<'tcx, T> {
1105 /// Skips the binder and returns the "bound" value. This is a
1106 /// risky thing to do because it's easy to get confused about
1107 /// De Bruijn indices and the like. It is usually better to
1108 /// discharge the binder using `no_bound_vars` or
1109 /// `replace_late_bound_regions` or something like
1110 /// that. `skip_binder` is only valid when you are either
1111 /// extracting data that has nothing to do with bound vars, you
1112 /// are doing some sort of test that does not involve bound
1113 /// regions, or you are being very careful about your depth
1116 /// Some examples where `skip_binder` is reasonable:
1118 /// - extracting the `DefId` from a PolyTraitRef;
1119 /// - comparing the self type of a PolyTraitRef to see if it is equal to
1120 /// a type parameter `X`, since the type `X` does not reference any regions
1121 pub fn skip_binder(self) -> T {
1125 pub fn bound_vars(&self) -> &'tcx List<BoundVariableKind> {
1129 pub fn as_ref(&self) -> Binder<'tcx, &T> {
1130 Binder(&self.0, self.1)
1133 pub fn map_bound_ref_unchecked<F, U>(&self, f: F) -> Binder<'tcx, U>
1137 let value = f(&self.0);
1138 Binder(value, self.1)
1141 pub fn map_bound_ref<F, U: TypeFoldable<'tcx>>(&self, f: F) -> Binder<'tcx, U>
1145 self.as_ref().map_bound(f)
1148 pub fn map_bound<F, U: TypeFoldable<'tcx>>(self, f: F) -> Binder<'tcx, U>
1152 let value = f(self.0);
1153 if cfg!(debug_assertions) {
1154 let mut validator = ValidateBoundVars::new(self.1);
1155 value.visit_with(&mut validator);
1157 Binder(value, self.1)
1160 pub fn try_map_bound<F, U: TypeFoldable<'tcx>, E>(self, f: F) -> Result<Binder<'tcx, U>, E>
1162 F: FnOnce(T) -> Result<U, E>,
1164 let value = f(self.0)?;
1165 if cfg!(debug_assertions) {
1166 let mut validator = ValidateBoundVars::new(self.1);
1167 value.visit_with(&mut validator);
1169 Ok(Binder(value, self.1))
1172 /// Wraps a `value` in a binder, using the same bound variables as the
1173 /// current `Binder`. This should not be used if the new value *changes*
1174 /// the bound variables. Note: the (old or new) value itself does not
1175 /// necessarily need to *name* all the bound variables.
1177 /// This currently doesn't do anything different than `bind`, because we
1178 /// don't actually track bound vars. However, semantically, it is different
1179 /// because bound vars aren't allowed to change here, whereas they are
1180 /// in `bind`. This may be (debug) asserted in the future.
1181 pub fn rebind<U>(&self, value: U) -> Binder<'tcx, U>
1183 U: TypeFoldable<'tcx>,
1185 if cfg!(debug_assertions) {
1186 let mut validator = ValidateBoundVars::new(self.bound_vars());
1187 value.visit_with(&mut validator);
1189 Binder(value, self.1)
1192 /// Unwraps and returns the value within, but only if it contains
1193 /// no bound vars at all. (In other words, if this binder --
1194 /// and indeed any enclosing binder -- doesn't bind anything at
1195 /// all.) Otherwise, returns `None`.
1197 /// (One could imagine having a method that just unwraps a single
1198 /// binder, but permits late-bound vars bound by enclosing
1199 /// binders, but that would require adjusting the debruijn
1200 /// indices, and given the shallow binding structure we often use,
1201 /// would not be that useful.)
1202 pub fn no_bound_vars(self) -> Option<T>
1204 T: TypeFoldable<'tcx>,
1206 if self.0.has_escaping_bound_vars() { None } else { Some(self.skip_binder()) }
1209 /// Splits the contents into two things that share the same binder
1210 /// level as the original, returning two distinct binders.
1212 /// `f` should consider bound regions at depth 1 to be free, and
1213 /// anything it produces with bound regions at depth 1 will be
1214 /// bound in the resulting return values.
1215 pub fn split<U, V, F>(self, f: F) -> (Binder<'tcx, U>, Binder<'tcx, V>)
1217 F: FnOnce(T) -> (U, V),
1219 let (u, v) = f(self.0);
1220 (Binder(u, self.1), Binder(v, self.1))
1224 impl<'tcx, T> Binder<'tcx, Option<T>> {
1225 pub fn transpose(self) -> Option<Binder<'tcx, T>> {
1226 let bound_vars = self.1;
1227 self.0.map(|v| Binder(v, bound_vars))
1231 /// Represents the projection of an associated type. In explicit UFCS
1232 /// form this would be written `<T as Trait<..>>::N`.
1233 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1234 #[derive(HashStable, TypeFoldable)]
1235 pub struct ProjectionTy<'tcx> {
1236 /// The parameters of the associated item.
1237 pub substs: SubstsRef<'tcx>,
1239 /// The `DefId` of the `TraitItem` for the associated type `N`.
1241 /// Note that this is not the `DefId` of the `TraitRef` containing this
1242 /// associated type, which is in `tcx.associated_item(item_def_id).container`.
1243 pub item_def_id: DefId,
1246 impl<'tcx> ProjectionTy<'tcx> {
1247 pub fn trait_def_id(&self, tcx: TyCtxt<'tcx>) -> DefId {
1248 tcx.associated_item(self.item_def_id).container.id()
1251 /// Extracts the underlying trait reference and own substs from this projection.
1252 /// For example, if this is a projection of `<T as StreamingIterator>::Item<'a>`,
1253 /// then this function would return a `T: Iterator` trait reference and `['a]` as the own substs
1254 pub fn trait_ref_and_own_substs(
1257 ) -> (ty::TraitRef<'tcx>, &'tcx [ty::GenericArg<'tcx>]) {
1258 let def_id = tcx.associated_item(self.item_def_id).container.id();
1259 let trait_generics = tcx.generics_of(def_id);
1261 ty::TraitRef { def_id, substs: self.substs.truncate_to(tcx, trait_generics) },
1262 &self.substs[trait_generics.count()..],
1266 /// Extracts the underlying trait reference from this projection.
1267 /// For example, if this is a projection of `<T as Iterator>::Item`,
1268 /// then this function would return a `T: Iterator` trait reference.
1270 /// WARNING: This will drop the substs for generic associated types
1271 /// consider calling [Self::trait_ref_and_own_substs] to get those
1273 pub fn trait_ref(&self, tcx: TyCtxt<'tcx>) -> ty::TraitRef<'tcx> {
1274 let def_id = self.trait_def_id(tcx);
1275 ty::TraitRef { def_id, substs: self.substs.truncate_to(tcx, tcx.generics_of(def_id)) }
1278 pub fn self_ty(&self) -> Ty<'tcx> {
1279 self.substs.type_at(0)
1283 #[derive(Copy, Clone, Debug, TypeFoldable)]
1284 pub struct GenSig<'tcx> {
1285 pub resume_ty: Ty<'tcx>,
1286 pub yield_ty: Ty<'tcx>,
1287 pub return_ty: Ty<'tcx>,
1290 pub type PolyGenSig<'tcx> = Binder<'tcx, GenSig<'tcx>>;
1292 /// Signature of a function type, which we have arbitrarily
1293 /// decided to use to refer to the input/output types.
1295 /// - `inputs`: is the list of arguments and their modes.
1296 /// - `output`: is the return type.
1297 /// - `c_variadic`: indicates whether this is a C-variadic function.
1298 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1299 #[derive(HashStable, TypeFoldable)]
1300 pub struct FnSig<'tcx> {
1301 pub inputs_and_output: &'tcx List<Ty<'tcx>>,
1302 pub c_variadic: bool,
1303 pub unsafety: hir::Unsafety,
1307 impl<'tcx> FnSig<'tcx> {
1308 pub fn inputs(&self) -> &'tcx [Ty<'tcx>] {
1309 &self.inputs_and_output[..self.inputs_and_output.len() - 1]
1312 pub fn output(&self) -> Ty<'tcx> {
1313 self.inputs_and_output[self.inputs_and_output.len() - 1]
1316 // Creates a minimal `FnSig` to be used when encountering a `TyKind::Error` in a fallible
1318 fn fake() -> FnSig<'tcx> {
1320 inputs_and_output: List::empty(),
1322 unsafety: hir::Unsafety::Normal,
1323 abi: abi::Abi::Rust,
1328 pub type PolyFnSig<'tcx> = Binder<'tcx, FnSig<'tcx>>;
1330 impl<'tcx> PolyFnSig<'tcx> {
1332 pub fn inputs(&self) -> Binder<'tcx, &'tcx [Ty<'tcx>]> {
1333 self.map_bound_ref_unchecked(|fn_sig| fn_sig.inputs())
1336 pub fn input(&self, index: usize) -> ty::Binder<'tcx, Ty<'tcx>> {
1337 self.map_bound_ref(|fn_sig| fn_sig.inputs()[index])
1339 pub fn inputs_and_output(&self) -> ty::Binder<'tcx, &'tcx List<Ty<'tcx>>> {
1340 self.map_bound_ref(|fn_sig| fn_sig.inputs_and_output)
1343 pub fn output(&self) -> ty::Binder<'tcx, Ty<'tcx>> {
1344 self.map_bound_ref(|fn_sig| fn_sig.output())
1346 pub fn c_variadic(&self) -> bool {
1347 self.skip_binder().c_variadic
1349 pub fn unsafety(&self) -> hir::Unsafety {
1350 self.skip_binder().unsafety
1352 pub fn abi(&self) -> abi::Abi {
1353 self.skip_binder().abi
1357 pub type CanonicalPolyFnSig<'tcx> = Canonical<'tcx, Binder<'tcx, FnSig<'tcx>>>;
1359 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1360 #[derive(HashStable)]
1361 pub struct ParamTy {
1366 impl<'tcx> ParamTy {
1367 pub fn new(index: u32, name: Symbol) -> ParamTy {
1368 ParamTy { index, name }
1371 pub fn for_def(def: &ty::GenericParamDef) -> ParamTy {
1372 ParamTy::new(def.index, def.name)
1376 pub fn to_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1377 tcx.mk_ty_param(self.index, self.name)
1381 #[derive(Copy, Clone, Hash, TyEncodable, TyDecodable, Eq, PartialEq, Ord, PartialOrd)]
1382 #[derive(HashStable)]
1383 pub struct ParamConst {
1389 pub fn new(index: u32, name: Symbol) -> ParamConst {
1390 ParamConst { index, name }
1393 pub fn for_def(def: &ty::GenericParamDef) -> ParamConst {
1394 ParamConst::new(def.index, def.name)
1398 /// Use this rather than `TyKind`, whenever possible.
1399 #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, HashStable)]
1400 #[cfg_attr(not(bootstrap), rustc_pass_by_value)]
1401 pub struct Region<'tcx>(pub Interned<'tcx, RegionKind>);
1403 impl<'tcx> Deref for Region<'tcx> {
1404 type Target = RegionKind;
1406 fn deref(&self) -> &RegionKind {
1411 impl<'tcx> fmt::Debug for Region<'tcx> {
1412 fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
1413 write!(f, "{:?}", self.kind())
1417 /// Representation of regions. Note that the NLL checker uses a distinct
1418 /// representation of regions. For this reason, it internally replaces all the
1419 /// regions with inference variables -- the index of the variable is then used
1420 /// to index into internal NLL data structures. See `rustc_const_eval::borrow_check`
1421 /// module for more information.
1423 /// Note: operations are on the wrapper `Region` type, which is interned,
1424 /// rather than this type.
1426 /// ## The Region lattice within a given function
1428 /// In general, the region lattice looks like
1431 /// static ----------+-----...------+ (greatest)
1433 /// early-bound and | |
1434 /// free regions | |
1437 /// empty(root) placeholder(U1) |
1439 /// | / placeholder(Un)
1444 /// empty(Un) -------- (smallest)
1447 /// Early-bound/free regions are the named lifetimes in scope from the
1448 /// function declaration. They have relationships to one another
1449 /// determined based on the declared relationships from the
1452 /// Note that inference variables and bound regions are not included
1453 /// in this diagram. In the case of inference variables, they should
1454 /// be inferred to some other region from the diagram. In the case of
1455 /// bound regions, they are excluded because they don't make sense to
1456 /// include -- the diagram indicates the relationship between free
1459 /// ## Inference variables
1461 /// During region inference, we sometimes create inference variables,
1462 /// represented as `ReVar`. These will be inferred by the code in
1463 /// `infer::lexical_region_resolve` to some free region from the
1464 /// lattice above (the minimal region that meets the
1467 /// During NLL checking, where regions are defined differently, we
1468 /// also use `ReVar` -- in that case, the index is used to index into
1469 /// the NLL region checker's data structures. The variable may in fact
1470 /// represent either a free region or an inference variable, in that
1473 /// ## Bound Regions
1475 /// These are regions that are stored behind a binder and must be substituted
1476 /// with some concrete region before being used. There are two kind of
1477 /// bound regions: early-bound, which are bound in an item's `Generics`,
1478 /// and are substituted by an `InternalSubsts`, and late-bound, which are part of
1479 /// higher-ranked types (e.g., `for<'a> fn(&'a ())`), and are substituted by
1480 /// the likes of `liberate_late_bound_regions`. The distinction exists
1481 /// because higher-ranked lifetimes aren't supported in all places. See [1][2].
1483 /// Unlike `Param`s, bound regions are not supposed to exist "in the wild"
1484 /// outside their binder, e.g., in types passed to type inference, and
1485 /// should first be substituted (by placeholder regions, free regions,
1486 /// or region variables).
1488 /// ## Placeholder and Free Regions
1490 /// One often wants to work with bound regions without knowing their precise
1491 /// identity. For example, when checking a function, the lifetime of a borrow
1492 /// can end up being assigned to some region parameter. In these cases,
1493 /// it must be ensured that bounds on the region can't be accidentally
1494 /// assumed without being checked.
1496 /// To do this, we replace the bound regions with placeholder markers,
1497 /// which don't satisfy any relation not explicitly provided.
1499 /// There are two kinds of placeholder regions in rustc: `ReFree` and
1500 /// `RePlaceholder`. When checking an item's body, `ReFree` is supposed
1501 /// to be used. These also support explicit bounds: both the internally-stored
1502 /// *scope*, which the region is assumed to outlive, as well as other
1503 /// relations stored in the `FreeRegionMap`. Note that these relations
1504 /// aren't checked when you `make_subregion` (or `eq_types`), only by
1505 /// `resolve_regions_and_report_errors`.
1507 /// When working with higher-ranked types, some region relations aren't
1508 /// yet known, so you can't just call `resolve_regions_and_report_errors`.
1509 /// `RePlaceholder` is designed for this purpose. In these contexts,
1510 /// there's also the risk that some inference variable laying around will
1511 /// get unified with your placeholder region: if you want to check whether
1512 /// `for<'a> Foo<'_>: 'a`, and you substitute your bound region `'a`
1513 /// with a placeholder region `'%a`, the variable `'_` would just be
1514 /// instantiated to the placeholder region `'%a`, which is wrong because
1515 /// the inference variable is supposed to satisfy the relation
1516 /// *for every value of the placeholder region*. To ensure that doesn't
1517 /// happen, you can use `leak_check`. This is more clearly explained
1518 /// by the [rustc dev guide].
1520 /// [1]: https://smallcultfollowing.com/babysteps/blog/2013/10/29/intermingled-parameter-lists/
1521 /// [2]: https://smallcultfollowing.com/babysteps/blog/2013/11/04/intermingled-parameter-lists/
1522 /// [rustc dev guide]: https://rustc-dev-guide.rust-lang.org/traits/hrtb.html
1523 #[derive(Clone, PartialEq, Eq, Hash, Copy, TyEncodable, TyDecodable, PartialOrd, Ord)]
1524 pub enum RegionKind {
1525 /// Region bound in a type or fn declaration which will be
1526 /// substituted 'early' -- that is, at the same time when type
1527 /// parameters are substituted.
1528 ReEarlyBound(EarlyBoundRegion),
1530 /// Region bound in a function scope, which will be substituted when the
1531 /// function is called.
1532 ReLateBound(ty::DebruijnIndex, BoundRegion),
1534 /// When checking a function body, the types of all arguments and so forth
1535 /// that refer to bound region parameters are modified to refer to free
1536 /// region parameters.
1539 /// Static data that has an "infinite" lifetime. Top in the region lattice.
1542 /// A region variable. Should not exist outside of type inference.
1545 /// A placeholder region -- basically, the higher-ranked version of `ReFree`.
1546 /// Should not exist outside of type inference.
1547 RePlaceholder(ty::PlaceholderRegion),
1549 /// Empty lifetime is for data that is never accessed. We tag the
1550 /// empty lifetime with a universe -- the idea is that we don't
1551 /// want `exists<'a> { forall<'b> { 'b: 'a } }` to be satisfiable.
1552 /// Therefore, the `'empty` in a universe `U` is less than all
1553 /// regions visible from `U`, but not less than regions not visible
1555 ReEmpty(ty::UniverseIndex),
1557 /// Erased region, used by trait selection, in MIR and during codegen.
1561 #[derive(Copy, Clone, PartialEq, Eq, Hash, TyEncodable, TyDecodable, Debug, PartialOrd, Ord)]
1562 pub struct EarlyBoundRegion {
1568 /// A **`const`** **v**ariable **ID**.
1569 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, TyEncodable, TyDecodable)]
1570 pub struct ConstVid<'tcx> {
1572 pub phantom: PhantomData<&'tcx ()>,
1575 rustc_index::newtype_index! {
1576 /// A **region** (lifetime) **v**ariable **ID**.
1577 pub struct RegionVid {
1578 DEBUG_FORMAT = custom,
1582 impl Atom for RegionVid {
1583 fn index(self) -> usize {
1588 rustc_index::newtype_index! {
1589 pub struct BoundVar { .. }
1592 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1593 #[derive(HashStable)]
1594 pub struct BoundTy {
1596 pub kind: BoundTyKind,
1599 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1600 #[derive(HashStable)]
1601 pub enum BoundTyKind {
1606 impl From<BoundVar> for BoundTy {
1607 fn from(var: BoundVar) -> Self {
1608 BoundTy { var, kind: BoundTyKind::Anon }
1612 /// A `ProjectionPredicate` for an `ExistentialTraitRef`.
1613 #[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Debug, TyEncodable, TyDecodable)]
1614 #[derive(HashStable, TypeFoldable)]
1615 pub struct ExistentialProjection<'tcx> {
1616 pub item_def_id: DefId,
1617 pub substs: SubstsRef<'tcx>,
1618 pub term: Term<'tcx>,
1621 pub type PolyExistentialProjection<'tcx> = Binder<'tcx, ExistentialProjection<'tcx>>;
1623 impl<'tcx> ExistentialProjection<'tcx> {
1624 /// Extracts the underlying existential trait reference from this projection.
1625 /// For example, if this is a projection of `exists T. <T as Iterator>::Item == X`,
1626 /// then this function would return an `exists T. T: Iterator` existential trait
1628 pub fn trait_ref(&self, tcx: TyCtxt<'tcx>) -> ty::ExistentialTraitRef<'tcx> {
1629 let def_id = tcx.associated_item(self.item_def_id).container.id();
1630 let subst_count = tcx.generics_of(def_id).count() - 1;
1631 let substs = tcx.intern_substs(&self.substs[..subst_count]);
1632 ty::ExistentialTraitRef { def_id, substs }
1635 pub fn with_self_ty(
1639 ) -> ty::ProjectionPredicate<'tcx> {
1640 // otherwise the escaping regions would be captured by the binders
1641 debug_assert!(!self_ty.has_escaping_bound_vars());
1643 ty::ProjectionPredicate {
1644 projection_ty: ty::ProjectionTy {
1645 item_def_id: self.item_def_id,
1646 substs: tcx.mk_substs_trait(self_ty, self.substs),
1652 pub fn erase_self_ty(
1654 projection_predicate: ty::ProjectionPredicate<'tcx>,
1656 // Assert there is a Self.
1657 projection_predicate.projection_ty.substs.type_at(0);
1660 item_def_id: projection_predicate.projection_ty.item_def_id,
1661 substs: tcx.intern_substs(&projection_predicate.projection_ty.substs[1..]),
1662 term: projection_predicate.term,
1667 impl<'tcx> PolyExistentialProjection<'tcx> {
1668 pub fn with_self_ty(
1672 ) -> ty::PolyProjectionPredicate<'tcx> {
1673 self.map_bound(|p| p.with_self_ty(tcx, self_ty))
1676 pub fn item_def_id(&self) -> DefId {
1677 self.skip_binder().item_def_id
1681 /// Region utilities
1682 impl<'tcx> Region<'tcx> {
1683 pub fn kind(self) -> RegionKind {
1687 /// Is this region named by the user?
1688 pub fn has_name(self) -> bool {
1690 ty::ReEarlyBound(ebr) => ebr.has_name(),
1691 ty::ReLateBound(_, br) => br.kind.is_named(),
1692 ty::ReFree(fr) => fr.bound_region.is_named(),
1693 ty::ReStatic => true,
1694 ty::ReVar(..) => false,
1695 ty::RePlaceholder(placeholder) => placeholder.name.is_named(),
1696 ty::ReEmpty(_) => false,
1697 ty::ReErased => false,
1702 pub fn is_static(self) -> bool {
1703 matches!(*self, ty::ReStatic)
1707 pub fn is_erased(self) -> bool {
1708 matches!(*self, ty::ReErased)
1712 pub fn is_late_bound(self) -> bool {
1713 matches!(*self, ty::ReLateBound(..))
1717 pub fn is_placeholder(self) -> bool {
1718 matches!(*self, ty::RePlaceholder(..))
1722 pub fn is_empty(self) -> bool {
1723 matches!(*self, ty::ReEmpty(..))
1727 pub fn bound_at_or_above_binder(self, index: ty::DebruijnIndex) -> bool {
1729 ty::ReLateBound(debruijn, _) => debruijn >= index,
1734 pub fn type_flags(self) -> TypeFlags {
1735 let mut flags = TypeFlags::empty();
1739 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1740 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1741 flags = flags | TypeFlags::HAS_RE_INFER;
1743 ty::RePlaceholder(..) => {
1744 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1745 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1746 flags = flags | TypeFlags::HAS_RE_PLACEHOLDER;
1748 ty::ReEarlyBound(..) => {
1749 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1750 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1751 flags = flags | TypeFlags::HAS_RE_PARAM;
1753 ty::ReFree { .. } => {
1754 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1755 flags = flags | TypeFlags::HAS_FREE_LOCAL_REGIONS;
1757 ty::ReEmpty(_) | ty::ReStatic => {
1758 flags = flags | TypeFlags::HAS_FREE_REGIONS;
1760 ty::ReLateBound(..) => {
1761 flags = flags | TypeFlags::HAS_RE_LATE_BOUND;
1764 flags = flags | TypeFlags::HAS_RE_ERASED;
1768 debug!("type_flags({:?}) = {:?}", self, flags);
1773 /// Given an early-bound or free region, returns the `DefId` where it was bound.
1774 /// For example, consider the regions in this snippet of code:
1778 /// ^^ -- early bound, declared on an impl
1780 /// fn bar<'b, 'c>(x: &self, y: &'b u32, z: &'c u64) where 'static: 'c
1781 /// ^^ ^^ ^ anonymous, late-bound
1782 /// | early-bound, appears in where-clauses
1783 /// late-bound, appears only in fn args
1788 /// Here, `free_region_binding_scope('a)` would return the `DefId`
1789 /// of the impl, and for all the other highlighted regions, it
1790 /// would return the `DefId` of the function. In other cases (not shown), this
1791 /// function might return the `DefId` of a closure.
1792 pub fn free_region_binding_scope(self, tcx: TyCtxt<'_>) -> DefId {
1794 ty::ReEarlyBound(br) => tcx.parent(br.def_id).unwrap(),
1795 ty::ReFree(fr) => fr.scope,
1796 _ => bug!("free_region_binding_scope invoked on inappropriate region: {:?}", self),
1802 impl<'tcx> Ty<'tcx> {
1804 pub fn kind(self) -> &'tcx TyKind<'tcx> {
1809 pub fn flags(self) -> TypeFlags {
1814 pub fn is_unit(self) -> bool {
1816 Tuple(ref tys) => tys.is_empty(),
1822 pub fn is_never(self) -> bool {
1823 matches!(self.kind(), Never)
1827 pub fn is_primitive(self) -> bool {
1828 self.kind().is_primitive()
1832 pub fn is_adt(self) -> bool {
1833 matches!(self.kind(), Adt(..))
1837 pub fn is_ref(self) -> bool {
1838 matches!(self.kind(), Ref(..))
1842 pub fn is_ty_var(self) -> bool {
1843 matches!(self.kind(), Infer(TyVar(_)))
1847 pub fn ty_vid(self) -> Option<ty::TyVid> {
1849 &Infer(TyVar(vid)) => Some(vid),
1855 pub fn is_ty_infer(self) -> bool {
1856 matches!(self.kind(), Infer(_))
1860 pub fn is_phantom_data(self) -> bool {
1861 if let Adt(def, _) = self.kind() { def.is_phantom_data() } else { false }
1865 pub fn is_bool(self) -> bool {
1866 *self.kind() == Bool
1869 /// Returns `true` if this type is a `str`.
1871 pub fn is_str(self) -> bool {
1876 pub fn is_param(self, index: u32) -> bool {
1878 ty::Param(ref data) => data.index == index,
1884 pub fn is_slice(self) -> bool {
1886 RawPtr(TypeAndMut { ty, .. }) | Ref(_, ty, _) => matches!(ty.kind(), Slice(_) | Str),
1892 pub fn is_array(self) -> bool {
1893 matches!(self.kind(), Array(..))
1897 pub fn is_simd(self) -> bool {
1899 Adt(def, _) => def.repr.simd(),
1904 pub fn sequence_element_type(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
1906 Array(ty, _) | Slice(ty) => *ty,
1907 Str => tcx.types.u8,
1908 _ => bug!("`sequence_element_type` called on non-sequence value: {}", self),
1912 pub fn simd_size_and_type(self, tcx: TyCtxt<'tcx>) -> (u64, Ty<'tcx>) {
1914 Adt(def, substs) => {
1915 assert!(def.repr.simd(), "`simd_size_and_type` called on non-SIMD type");
1916 let variant = def.non_enum_variant();
1917 let f0_ty = variant.fields[0].ty(tcx, substs);
1919 match f0_ty.kind() {
1920 // If the first field is an array, we assume it is the only field and its
1921 // elements are the SIMD components.
1922 Array(f0_elem_ty, f0_len) => {
1923 // FIXME(repr_simd): https://github.com/rust-lang/rust/pull/78863#discussion_r522784112
1924 // The way we evaluate the `N` in `[T; N]` here only works since we use
1925 // `simd_size_and_type` post-monomorphization. It will probably start to ICE
1926 // if we use it in generic code. See the `simd-array-trait` ui test.
1927 (f0_len.eval_usize(tcx, ParamEnv::empty()) as u64, *f0_elem_ty)
1929 // Otherwise, the fields of this Adt are the SIMD components (and we assume they
1930 // all have the same type).
1931 _ => (variant.fields.len() as u64, f0_ty),
1934 _ => bug!("`simd_size_and_type` called on invalid type"),
1939 pub fn is_region_ptr(self) -> bool {
1940 matches!(self.kind(), Ref(..))
1944 pub fn is_mutable_ptr(self) -> bool {
1947 RawPtr(TypeAndMut { mutbl: hir::Mutability::Mut, .. })
1948 | Ref(_, _, hir::Mutability::Mut)
1952 /// Get the mutability of the reference or `None` when not a reference
1954 pub fn ref_mutability(self) -> Option<hir::Mutability> {
1956 Ref(_, _, mutability) => Some(*mutability),
1962 pub fn is_unsafe_ptr(self) -> bool {
1963 matches!(self.kind(), RawPtr(_))
1966 /// Tests if this is any kind of primitive pointer type (reference, raw pointer, fn pointer).
1968 pub fn is_any_ptr(self) -> bool {
1969 self.is_region_ptr() || self.is_unsafe_ptr() || self.is_fn_ptr()
1973 pub fn is_box(self) -> bool {
1975 Adt(def, _) => def.is_box(),
1980 /// Panics if called on any type other than `Box<T>`.
1981 pub fn boxed_ty(self) -> Ty<'tcx> {
1983 Adt(def, substs) if def.is_box() => substs.type_at(0),
1984 _ => bug!("`boxed_ty` is called on non-box type {:?}", self),
1988 /// A scalar type is one that denotes an atomic datum, with no sub-components.
1989 /// (A RawPtr is scalar because it represents a non-managed pointer, so its
1990 /// contents are abstract to rustc.)
1992 pub fn is_scalar(self) -> bool {
2002 | Infer(IntVar(_) | FloatVar(_))
2006 /// Returns `true` if this type is a floating point type.
2008 pub fn is_floating_point(self) -> bool {
2009 matches!(self.kind(), Float(_) | Infer(FloatVar(_)))
2013 pub fn is_trait(self) -> bool {
2014 matches!(self.kind(), Dynamic(..))
2018 pub fn is_enum(self) -> bool {
2019 matches!(self.kind(), Adt(adt_def, _) if adt_def.is_enum())
2023 pub fn is_union(self) -> bool {
2024 matches!(self.kind(), Adt(adt_def, _) if adt_def.is_union())
2028 pub fn is_closure(self) -> bool {
2029 matches!(self.kind(), Closure(..))
2033 pub fn is_generator(self) -> bool {
2034 matches!(self.kind(), Generator(..))
2038 pub fn is_integral(self) -> bool {
2039 matches!(self.kind(), Infer(IntVar(_)) | Int(_) | Uint(_))
2043 pub fn is_fresh_ty(self) -> bool {
2044 matches!(self.kind(), Infer(FreshTy(_)))
2048 pub fn is_fresh(self) -> bool {
2049 matches!(self.kind(), Infer(FreshTy(_) | FreshIntTy(_) | FreshFloatTy(_)))
2053 pub fn is_char(self) -> bool {
2054 matches!(self.kind(), Char)
2058 pub fn is_numeric(self) -> bool {
2059 self.is_integral() || self.is_floating_point()
2063 pub fn is_signed(self) -> bool {
2064 matches!(self.kind(), Int(_))
2068 pub fn is_ptr_sized_integral(self) -> bool {
2069 matches!(self.kind(), Int(ty::IntTy::Isize) | Uint(ty::UintTy::Usize))
2073 pub fn has_concrete_skeleton(self) -> bool {
2074 !matches!(self.kind(), Param(_) | Infer(_) | Error(_))
2077 /// Checks whether a type recursively contains another type
2079 /// Example: `Option<()>` contains `()`
2080 pub fn contains(self, other: Ty<'tcx>) -> bool {
2081 struct ContainsTyVisitor<'tcx>(Ty<'tcx>);
2083 impl<'tcx> TypeVisitor<'tcx> for ContainsTyVisitor<'tcx> {
2086 fn visit_ty(&mut self, t: Ty<'tcx>) -> ControlFlow<Self::BreakTy> {
2087 if self.0 == t { ControlFlow::BREAK } else { t.super_visit_with(self) }
2091 let cf = self.visit_with(&mut ContainsTyVisitor(other));
2095 /// Returns the type and mutability of `*ty`.
2097 /// The parameter `explicit` indicates if this is an *explicit* dereference.
2098 /// Some types -- notably unsafe ptrs -- can only be dereferenced explicitly.
2099 pub fn builtin_deref(self, explicit: bool) -> Option<TypeAndMut<'tcx>> {
2101 Adt(def, _) if def.is_box() => {
2102 Some(TypeAndMut { ty: self.boxed_ty(), mutbl: hir::Mutability::Not })
2104 Ref(_, ty, mutbl) => Some(TypeAndMut { ty: *ty, mutbl: *mutbl }),
2105 RawPtr(mt) if explicit => Some(*mt),
2110 /// Returns the type of `ty[i]`.
2111 pub fn builtin_index(self) -> Option<Ty<'tcx>> {
2113 Array(ty, _) | Slice(ty) => Some(*ty),
2118 pub fn fn_sig(self, tcx: TyCtxt<'tcx>) -> PolyFnSig<'tcx> {
2120 FnDef(def_id, substs) => tcx.fn_sig(*def_id).subst(tcx, substs),
2123 // ignore errors (#54954)
2124 ty::Binder::dummy(FnSig::fake())
2126 Closure(..) => bug!(
2127 "to get the signature of a closure, use `substs.as_closure().sig()` not `fn_sig()`",
2129 _ => bug!("Ty::fn_sig() called on non-fn type: {:?}", self),
2134 pub fn is_fn(self) -> bool {
2135 matches!(self.kind(), FnDef(..) | FnPtr(_))
2139 pub fn is_fn_ptr(self) -> bool {
2140 matches!(self.kind(), FnPtr(_))
2144 pub fn is_impl_trait(self) -> bool {
2145 matches!(self.kind(), Opaque(..))
2149 pub fn ty_adt_def(self) -> Option<&'tcx AdtDef> {
2151 Adt(adt, _) => Some(adt),
2156 /// Iterates over tuple fields.
2157 /// Panics when called on anything but a tuple.
2158 pub fn tuple_fields(self) -> impl DoubleEndedIterator<Item = Ty<'tcx>> {
2160 Tuple(substs) => substs.iter().map(|field| field.expect_ty()),
2161 _ => bug!("tuple_fields called on non-tuple"),
2165 /// Get the `i`-th element of a tuple.
2166 /// Panics when called on anything but a tuple.
2167 pub fn tuple_element_ty(self, i: usize) -> Option<Ty<'tcx>> {
2169 Tuple(substs) => substs.iter().nth(i).map(|field| field.expect_ty()),
2170 _ => bug!("tuple_fields called on non-tuple"),
2174 /// If the type contains variants, returns the valid range of variant indices.
2176 // FIXME: This requires the optimized MIR in the case of generators.
2178 pub fn variant_range(self, tcx: TyCtxt<'tcx>) -> Option<Range<VariantIdx>> {
2180 TyKind::Adt(adt, _) => Some(adt.variant_range()),
2181 TyKind::Generator(def_id, substs, _) => {
2182 Some(substs.as_generator().variant_range(*def_id, tcx))
2188 /// If the type contains variants, returns the variant for `variant_index`.
2189 /// Panics if `variant_index` is out of range.
2191 // FIXME: This requires the optimized MIR in the case of generators.
2193 pub fn discriminant_for_variant(
2196 variant_index: VariantIdx,
2197 ) -> Option<Discr<'tcx>> {
2199 TyKind::Adt(adt, _) if adt.variants.is_empty() => {
2200 // This can actually happen during CTFE, see
2201 // https://github.com/rust-lang/rust/issues/89765.
2204 TyKind::Adt(adt, _) if adt.is_enum() => {
2205 Some(adt.discriminant_for_variant(tcx, variant_index))
2207 TyKind::Generator(def_id, substs, _) => {
2208 Some(substs.as_generator().discriminant_for_variant(*def_id, tcx, variant_index))
2214 /// Returns the type of the discriminant of this type.
2215 pub fn discriminant_ty(self, tcx: TyCtxt<'tcx>) -> Ty<'tcx> {
2217 ty::Adt(adt, _) if adt.is_enum() => adt.repr.discr_type().to_ty(tcx),
2218 ty::Generator(_, substs, _) => substs.as_generator().discr_ty(tcx),
2220 ty::Param(_) | ty::Projection(_) | ty::Opaque(..) | ty::Infer(ty::TyVar(_)) => {
2221 let assoc_items = tcx.associated_item_def_ids(
2222 tcx.require_lang_item(hir::LangItem::DiscriminantKind, None),
2224 tcx.mk_projection(assoc_items[0], tcx.intern_substs(&[self.into()]))
2243 | ty::GeneratorWitness(..)
2247 | ty::Infer(IntVar(_) | FloatVar(_)) => tcx.types.u8,
2250 | ty::Placeholder(_)
2251 | ty::Infer(FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2252 bug!("`discriminant_ty` applied to unexpected type: {:?}", self)
2257 /// Returns the type of metadata for (potentially fat) pointers to this type.
2258 pub fn ptr_metadata_ty(
2261 normalize: impl FnMut(Ty<'tcx>) -> Ty<'tcx>,
2263 let tail = tcx.struct_tail_with_normalize(self, normalize);
2266 ty::Infer(ty::IntVar(_) | ty::FloatVar(_))
2277 | ty::GeneratorWitness(..)
2283 // If returned by `struct_tail_without_normalization` this is a unit struct
2284 // without any fields, or not a struct, and therefore is Sized.
2286 // If returned by `struct_tail_without_normalization` this is the empty tuple,
2287 // a.k.a. unit type, which is Sized
2288 | ty::Tuple(..) => tcx.types.unit,
2290 ty::Str | ty::Slice(_) => tcx.types.usize,
2291 ty::Dynamic(..) => {
2292 let dyn_metadata = tcx.lang_items().dyn_metadata().unwrap();
2293 tcx.type_of(dyn_metadata).subst(tcx, &[tail.into()])
2299 | ty::Infer(ty::TyVar(_))
2301 | ty::Placeholder(..)
2302 | ty::Infer(ty::FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2303 bug!("`ptr_metadata_ty` applied to unexpected type: {:?}", tail)
2308 /// When we create a closure, we record its kind (i.e., what trait
2309 /// it implements) into its `ClosureSubsts` using a type
2310 /// parameter. This is kind of a phantom type, except that the
2311 /// most convenient thing for us to are the integral types. This
2312 /// function converts such a special type into the closure
2313 /// kind. To go the other way, use
2314 /// `tcx.closure_kind_ty(closure_kind)`.
2316 /// Note that during type checking, we use an inference variable
2317 /// to represent the closure kind, because it has not yet been
2318 /// inferred. Once upvar inference (in `rustc_typeck/src/check/upvar.rs`)
2319 /// is complete, that type variable will be unified.
2320 pub fn to_opt_closure_kind(self) -> Option<ty::ClosureKind> {
2322 Int(int_ty) => match int_ty {
2323 ty::IntTy::I8 => Some(ty::ClosureKind::Fn),
2324 ty::IntTy::I16 => Some(ty::ClosureKind::FnMut),
2325 ty::IntTy::I32 => Some(ty::ClosureKind::FnOnce),
2326 _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2329 // "Bound" types appear in canonical queries when the
2330 // closure type is not yet known
2331 Bound(..) | Infer(_) => None,
2333 Error(_) => Some(ty::ClosureKind::Fn),
2335 _ => bug!("cannot convert type `{:?}` to a closure kind", self),
2339 /// Fast path helper for testing if a type is `Sized`.
2341 /// Returning true means the type is known to be sized. Returning
2342 /// `false` means nothing -- could be sized, might not be.
2344 /// Note that we could never rely on the fact that a type such as `[_]` is
2345 /// trivially `!Sized` because we could be in a type environment with a
2346 /// bound such as `[_]: Copy`. A function with such a bound obviously never
2347 /// can be called, but that doesn't mean it shouldn't typecheck. This is why
2348 /// this method doesn't return `Option<bool>`.
2349 pub fn is_trivially_sized(self, tcx: TyCtxt<'tcx>) -> bool {
2351 ty::Infer(ty::IntVar(_) | ty::FloatVar(_))
2362 | ty::GeneratorWitness(..)
2366 | ty::Error(_) => true,
2368 ty::Str | ty::Slice(_) | ty::Dynamic(..) | ty::Foreign(..) => false,
2370 ty::Tuple(tys) => tys.iter().all(|ty| ty.expect_ty().is_trivially_sized(tcx)),
2372 ty::Adt(def, _substs) => def.sized_constraint(tcx).is_empty(),
2374 ty::Projection(_) | ty::Param(_) | ty::Opaque(..) => false,
2376 ty::Infer(ty::TyVar(_)) => false,
2379 | ty::Placeholder(..)
2380 | ty::Infer(ty::FreshTy(_) | ty::FreshIntTy(_) | ty::FreshFloatTy(_)) => {
2381 bug!("`is_trivially_sized` applied to unexpected type: {:?}", self)
2387 /// Extra information about why we ended up with a particular variance.
2388 /// This is only used to add more information to error messages, and
2389 /// has no effect on soundness. While choosing the 'wrong' `VarianceDiagInfo`
2390 /// may lead to confusing notes in error messages, it will never cause
2391 /// a miscompilation or unsoundness.
2393 /// When in doubt, use `VarianceDiagInfo::default()`
2394 #[derive(Copy, Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord)]
2395 pub enum VarianceDiagInfo<'tcx> {
2396 /// No additional information - this is the default.
2397 /// We will not add any additional information to error messages.
2400 /// We switched our variance because a generic argument occurs inside
2401 /// the invariant generic argument of another type.
2403 /// The generic type containing the generic parameter
2404 /// that changes the variance (e.g. `*mut T`, `MyStruct<T>`)
2406 /// The index of the generic parameter being used
2407 /// (e.g. `0` for `*mut T`, `1` for `MyStruct<'CovariantParam, 'InvariantParam>`)
2412 impl<'tcx> VarianceDiagInfo<'tcx> {
2413 /// Mirrors `Variance::xform` - used to 'combine' the existing
2414 /// and new `VarianceDiagInfo`s when our variance changes.
2415 pub fn xform(self, other: VarianceDiagInfo<'tcx>) -> VarianceDiagInfo<'tcx> {
2416 // For now, just use the first `VarianceDiagInfo::Invariant` that we see
2418 VarianceDiagInfo::None => other,
2419 VarianceDiagInfo::Invariant { .. } => self,