rustc_middle/ty/
typeck_results.rs

1use std::collections::hash_map::Entry;
2use std::hash::Hash;
3use std::iter;
4
5use rustc_abi::{FieldIdx, VariantIdx};
6use rustc_data_structures::fx::{FxIndexMap, FxIndexSet};
7use rustc_data_structures::unord::{ExtendUnord, UnordItems, UnordSet};
8use rustc_errors::ErrorGuaranteed;
9use rustc_hir::def::{DefKind, Res};
10use rustc_hir::def_id::{DefId, LocalDefId, LocalDefIdMap};
11use rustc_hir::hir_id::OwnerId;
12use rustc_hir::{
13    self as hir, BindingMode, ByRef, HirId, ItemLocalId, ItemLocalMap, ItemLocalSet, Mutability,
14    Pinnedness,
15};
16use rustc_index::IndexVec;
17use rustc_macros::{HashStable, TyDecodable, TyEncodable, TypeFoldable, TypeVisitable};
18use rustc_session::Session;
19use rustc_span::Span;
20
21use crate::hir::place::Place as HirPlace;
22use crate::infer::canonical::Canonical;
23use crate::mir::FakeReadCause;
24use crate::traits::ObligationCause;
25use crate::ty::{
26    self, BoundVar, CanonicalPolyFnSig, ClosureSizeProfileData, GenericArgKind, GenericArgs,
27    GenericArgsRef, Ty, UserArgs, tls,
28};
29
30#[derive(TyEncodable, TyDecodable, Debug, HashStable)]
31pub struct TypeckResults<'tcx> {
32    /// The `HirId::owner` all `ItemLocalId`s in this table are relative to.
33    pub hir_owner: OwnerId,
34
35    /// Resolved definitions for `<T>::X` associated paths and
36    /// method calls, including those of overloaded operators.
37    type_dependent_defs: ItemLocalMap<Result<(DefKind, DefId), ErrorGuaranteed>>,
38
39    /// Resolved field indices for field accesses in expressions (`S { field }`, `obj.field`)
40    /// or patterns (`S { field }`). The index is often useful by itself, but to learn more
41    /// about the field you also need definition of the variant to which the field
42    /// belongs, but it may not exist if it's a tuple field (`tuple.0`).
43    field_indices: ItemLocalMap<FieldIdx>,
44
45    /// Stores the types for various nodes in the AST. Note that this table
46    /// is not guaranteed to be populated outside inference. See
47    /// typeck::check::fn_ctxt for details.
48    node_types: ItemLocalMap<Ty<'tcx>>,
49
50    /// Stores the type parameters which were instantiated to obtain the type
51    /// of this node. This only applies to nodes that refer to entities
52    /// parameterized by type parameters, such as generic fns, types, or
53    /// other items.
54    node_args: ItemLocalMap<GenericArgsRef<'tcx>>,
55
56    /// This will either store the canonicalized types provided by the user
57    /// or the generic parameters that the user explicitly gave (if any) attached
58    /// to `id`. These will not include any inferred values. The canonical form
59    /// is used to capture things like `_` or other unspecified values.
60    ///
61    /// For example, if the user wrote `foo.collect::<Vec<_>>()`, then the
62    /// canonical generic parameters would include only `for<X> { Vec<X> }`.
63    ///
64    /// See also `AscribeUserType` statement in MIR.
65    user_provided_types: ItemLocalMap<CanonicalUserType<'tcx>>,
66
67    /// Stores the canonicalized types provided by the user. See also
68    /// `AscribeUserType` statement in MIR.
69    pub user_provided_sigs: LocalDefIdMap<CanonicalPolyFnSig<'tcx>>,
70
71    adjustments: ItemLocalMap<Vec<ty::adjustment::Adjustment<'tcx>>>,
72
73    /// Stores the actual binding mode for all instances of [`BindingMode`].
74    pat_binding_modes: ItemLocalMap<BindingMode>,
75
76    /// Top-level patterns incompatible with Rust 2024's match ergonomics. These will be translated
77    /// to a form valid in all Editions, either as a lint diagnostic or hard error.
78    rust_2024_migration_desugared_pats: ItemLocalMap<Rust2024IncompatiblePatInfo>,
79
80    /// Stores the types which were implicitly dereferenced in pattern binding modes or deref
81    /// patterns for later usage in THIR lowering. For example,
82    ///
83    /// ```
84    /// match &&Some(5i32) {
85    ///     Some(n) => {},
86    ///     _ => {},
87    /// }
88    /// ```
89    /// leads to a `vec![&&Option<i32>, &Option<i32>]` and
90    ///
91    /// ```
92    /// #![feature(deref_patterns)]
93    /// match &Box::new(Some(5i32)) {
94    ///     Some(n) => {},
95    ///     _ => {},
96    /// }
97    /// ```
98    /// leads to a `vec![&Box<Option<i32>>, Box<Option<i32>>]`. Empty vectors are not stored.
99    ///
100    /// See:
101    /// <https://github.com/rust-lang/rfcs/blob/master/text/2005-match-ergonomics.md#definitions>
102    pat_adjustments: ItemLocalMap<Vec<ty::adjustment::PatAdjustment<'tcx>>>,
103
104    /// Set of reference patterns that match against a match-ergonomics inserted reference
105    /// (as opposed to against a reference in the scrutinee type).
106    skipped_ref_pats: ItemLocalSet,
107
108    /// Records the reasons that we picked the kind of each closure;
109    /// not all closures are present in the map.
110    closure_kind_origins: ItemLocalMap<(Span, HirPlace<'tcx>)>,
111
112    /// For each fn, records the "liberated" types of its arguments
113    /// and return type. Liberated means that all bound regions
114    /// (including late-bound regions) are replaced with free
115    /// equivalents. This table is not used in codegen (since regions
116    /// are erased there) and hence is not serialized to metadata.
117    ///
118    /// This table also contains the "revealed" values for any `impl Trait`
119    /// that appear in the signature and whose values are being inferred
120    /// by this function.
121    ///
122    /// # Example
123    ///
124    /// ```rust
125    /// # use std::fmt::Debug;
126    /// fn foo(x: &u32) -> impl Debug { *x }
127    /// ```
128    ///
129    /// The function signature here would be:
130    ///
131    /// ```ignore (illustrative)
132    /// for<'a> fn(&'a u32) -> Foo
133    /// ```
134    ///
135    /// where `Foo` is an opaque type created for this function.
136    ///
137    ///
138    /// The *liberated* form of this would be
139    ///
140    /// ```ignore (illustrative)
141    /// fn(&'a u32) -> u32
142    /// ```
143    ///
144    /// Note that `'a` is not bound (it would be an `ReLateParam`) and
145    /// that the `Foo` opaque type is replaced by its hidden type.
146    liberated_fn_sigs: ItemLocalMap<ty::FnSig<'tcx>>,
147
148    /// For each FRU expression, record the normalized types of the fields
149    /// of the struct - this is needed because it is non-trivial to
150    /// normalize while preserving regions. This table is used only in
151    /// MIR construction and hence is not serialized to metadata.
152    fru_field_types: ItemLocalMap<Vec<Ty<'tcx>>>,
153
154    /// For every coercion cast we add the HIR node ID of the cast
155    /// expression to this set.
156    coercion_casts: ItemLocalSet,
157
158    /// Set of trait imports actually used in the method resolution.
159    /// This is used for warning unused imports.
160    pub used_trait_imports: UnordSet<LocalDefId>,
161
162    /// If any errors occurred while type-checking this body,
163    /// this field will be set to `Some(ErrorGuaranteed)`.
164    pub tainted_by_errors: Option<ErrorGuaranteed>,
165
166    /// All the opaque types that have hidden types set by this function.
167    /// We also store the type here, so that the compiler can use it as a hint
168    /// for figuring out hidden types, even if they are only set in dead code
169    /// (which doesn't show up in MIR).
170    pub hidden_types: FxIndexMap<LocalDefId, ty::DefinitionSiteHiddenType<'tcx>>,
171
172    /// Tracks the minimum captures required for a closure;
173    /// see `MinCaptureInformationMap` for more details.
174    pub closure_min_captures: ty::MinCaptureInformationMap<'tcx>,
175
176    /// Tracks the fake reads required for a closure and the reason for the fake read.
177    /// When performing pattern matching for closures, there are times we don't end up
178    /// reading places that are mentioned in a closure (because of _ patterns). However,
179    /// to ensure the places are initialized, we introduce fake reads.
180    /// Consider these two examples:
181    /// ```ignore (discriminant matching with only wildcard arm)
182    /// let x: u8;
183    /// let c = || match x { _ => () };
184    /// ```
185    /// In this example, we don't need to actually read/borrow `x` in `c`, and so we don't
186    /// want to capture it. However, we do still want an error here, because `x` should have
187    /// to be initialized at the point where c is created. Therefore, we add a "fake read"
188    /// instead.
189    /// ```ignore (destructured assignments)
190    /// let c = || {
191    ///     let (t1, t2) = t;
192    /// }
193    /// ```
194    /// In the second example, we capture the disjoint fields of `t` (`t.0` & `t.1`), but
195    /// we never capture `t`. This becomes an issue when we build MIR as we require
196    /// information on `t` in order to create place `t.0` and `t.1`. We can solve this
197    /// issue by fake reading `t`.
198    pub closure_fake_reads: LocalDefIdMap<Vec<(HirPlace<'tcx>, FakeReadCause, HirId)>>,
199
200    /// Stores the predicates that apply on coroutine witness types.
201    /// formatting modified file tests/ui/coroutine/retain-resume-ref.rs
202    pub coroutine_stalled_predicates: FxIndexSet<(ty::Predicate<'tcx>, ObligationCause<'tcx>)>,
203
204    /// Goals proven during HIR typeck which may be potentially region dependent.
205    ///
206    /// Borrowck *uniquifies* regions which may cause these goal to be ambiguous in MIR
207    /// type check. We ICE if goals fail in borrowck to detect bugs during MIR building or
208    /// missed checks in HIR typeck. To avoid ICE due to region dependence we store all
209    /// goals which may be region dependent and reprove them in case borrowck encounters
210    /// an error.
211    pub potentially_region_dependent_goals:
212        FxIndexSet<(ty::Predicate<'tcx>, ObligationCause<'tcx>)>,
213
214    /// Contains the data for evaluating the effect of feature `capture_disjoint_fields`
215    /// on closure size.
216    pub closure_size_eval: LocalDefIdMap<ClosureSizeProfileData<'tcx>>,
217
218    /// Stores the types involved in calls to `transmute` intrinsic. These are meant to be checked
219    /// outside of typeck and borrowck to avoid cycles with opaque types and coroutine layout
220    /// computation.
221    pub transmutes_to_check: Vec<(Ty<'tcx>, Ty<'tcx>, HirId)>,
222
223    /// Container types and field indices of `offset_of!` expressions
224    offset_of_data: ItemLocalMap<Vec<(Ty<'tcx>, VariantIdx, FieldIdx)>>,
225}
226
227impl<'tcx> TypeckResults<'tcx> {
228    pub fn new(hir_owner: OwnerId) -> TypeckResults<'tcx> {
229        TypeckResults {
230            hir_owner,
231            type_dependent_defs: Default::default(),
232            field_indices: Default::default(),
233            user_provided_types: Default::default(),
234            user_provided_sigs: Default::default(),
235            node_types: Default::default(),
236            node_args: Default::default(),
237            adjustments: Default::default(),
238            pat_binding_modes: Default::default(),
239            pat_adjustments: Default::default(),
240            rust_2024_migration_desugared_pats: Default::default(),
241            skipped_ref_pats: Default::default(),
242            closure_kind_origins: Default::default(),
243            liberated_fn_sigs: Default::default(),
244            fru_field_types: Default::default(),
245            coercion_casts: Default::default(),
246            used_trait_imports: Default::default(),
247            tainted_by_errors: None,
248            hidden_types: Default::default(),
249            closure_min_captures: Default::default(),
250            closure_fake_reads: Default::default(),
251            coroutine_stalled_predicates: Default::default(),
252            potentially_region_dependent_goals: Default::default(),
253            closure_size_eval: Default::default(),
254            transmutes_to_check: Default::default(),
255            offset_of_data: Default::default(),
256        }
257    }
258
259    /// Returns the final resolution of a `QPath` in an `Expr` or `Pat` node.
260    pub fn qpath_res(&self, qpath: &hir::QPath<'_>, id: HirId) -> Res {
261        match *qpath {
262            hir::QPath::Resolved(_, path) => path.res,
263            hir::QPath::TypeRelative(..) => self
264                .type_dependent_def(id)
265                .map_or(Res::Err, |(kind, def_id)| Res::Def(kind, def_id)),
266        }
267    }
268
269    pub fn type_dependent_defs(
270        &self,
271    ) -> LocalTableInContext<'_, Result<(DefKind, DefId), ErrorGuaranteed>> {
272        LocalTableInContext { hir_owner: self.hir_owner, data: &self.type_dependent_defs }
273    }
274
275    pub fn type_dependent_def(&self, id: HirId) -> Option<(DefKind, DefId)> {
276        validate_hir_id_for_typeck_results(self.hir_owner, id);
277        self.type_dependent_defs.get(&id.local_id).cloned().and_then(|r| r.ok())
278    }
279
280    pub fn type_dependent_def_id(&self, id: HirId) -> Option<DefId> {
281        self.type_dependent_def(id).map(|(_, def_id)| def_id)
282    }
283
284    pub fn type_dependent_defs_mut(
285        &mut self,
286    ) -> LocalTableInContextMut<'_, Result<(DefKind, DefId), ErrorGuaranteed>> {
287        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.type_dependent_defs }
288    }
289
290    pub fn field_indices(&self) -> LocalTableInContext<'_, FieldIdx> {
291        LocalTableInContext { hir_owner: self.hir_owner, data: &self.field_indices }
292    }
293
294    pub fn field_indices_mut(&mut self) -> LocalTableInContextMut<'_, FieldIdx> {
295        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.field_indices }
296    }
297
298    pub fn field_index(&self, id: HirId) -> FieldIdx {
299        self.field_indices().get(id).cloned().expect("no index for a field")
300    }
301
302    pub fn opt_field_index(&self, id: HirId) -> Option<FieldIdx> {
303        self.field_indices().get(id).cloned()
304    }
305
306    pub fn user_provided_types(&self) -> LocalTableInContext<'_, CanonicalUserType<'tcx>> {
307        LocalTableInContext { hir_owner: self.hir_owner, data: &self.user_provided_types }
308    }
309
310    pub fn user_provided_types_mut(
311        &mut self,
312    ) -> LocalTableInContextMut<'_, CanonicalUserType<'tcx>> {
313        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.user_provided_types }
314    }
315
316    pub fn node_types(&self) -> LocalTableInContext<'_, Ty<'tcx>> {
317        LocalTableInContext { hir_owner: self.hir_owner, data: &self.node_types }
318    }
319
320    pub fn node_types_mut(&mut self) -> LocalTableInContextMut<'_, Ty<'tcx>> {
321        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.node_types }
322    }
323
324    pub fn node_type(&self, id: HirId) -> Ty<'tcx> {
325        self.node_type_opt(id).unwrap_or_else(|| {
326            bug!("node_type: no type for node {}", tls::with(|tcx| tcx.hir_id_to_string(id)))
327        })
328    }
329
330    pub fn node_type_opt(&self, id: HirId) -> Option<Ty<'tcx>> {
331        validate_hir_id_for_typeck_results(self.hir_owner, id);
332        self.node_types.get(&id.local_id).cloned()
333    }
334
335    pub fn node_args_mut(&mut self) -> LocalTableInContextMut<'_, GenericArgsRef<'tcx>> {
336        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.node_args }
337    }
338
339    pub fn node_args(&self, id: HirId) -> GenericArgsRef<'tcx> {
340        validate_hir_id_for_typeck_results(self.hir_owner, id);
341        self.node_args.get(&id.local_id).cloned().unwrap_or_else(|| GenericArgs::empty())
342    }
343
344    pub fn node_args_opt(&self, id: HirId) -> Option<GenericArgsRef<'tcx>> {
345        validate_hir_id_for_typeck_results(self.hir_owner, id);
346        self.node_args.get(&id.local_id).cloned()
347    }
348
349    /// Returns the type of a pattern as a monotype. Like [`expr_ty`], this function
350    /// doesn't provide type parameter args.
351    ///
352    /// [`expr_ty`]: TypeckResults::expr_ty
353    pub fn pat_ty(&self, pat: &hir::Pat<'_>) -> Ty<'tcx> {
354        self.node_type(pat.hir_id)
355    }
356
357    /// Returns the type of an expression as a monotype.
358    ///
359    /// NB (1): This is the PRE-ADJUSTMENT TYPE for the expression. That is, in
360    /// some cases, we insert `Adjustment` annotations such as auto-deref or
361    /// auto-ref. The type returned by this function does not consider such
362    /// adjustments. See [`Self::expr_ty_adjusted`] instead.
363    ///
364    /// NB (2): This type doesn't provide type parameter args; e.g., if you
365    /// ask for the type of `id` in `id(3)`, it will return `fn(&isize) -> isize`
366    /// instead of `fn(ty) -> T with T = isize`.
367    pub fn expr_ty(&self, expr: &hir::Expr<'_>) -> Ty<'tcx> {
368        self.node_type(expr.hir_id)
369    }
370
371    pub fn expr_ty_opt(&self, expr: &hir::Expr<'_>) -> Option<Ty<'tcx>> {
372        self.node_type_opt(expr.hir_id)
373    }
374
375    pub fn adjustments(&self) -> LocalTableInContext<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
376        LocalTableInContext { hir_owner: self.hir_owner, data: &self.adjustments }
377    }
378
379    pub fn adjustments_mut(
380        &mut self,
381    ) -> LocalTableInContextMut<'_, Vec<ty::adjustment::Adjustment<'tcx>>> {
382        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.adjustments }
383    }
384
385    pub fn expr_adjustments(&self, expr: &hir::Expr<'_>) -> &[ty::adjustment::Adjustment<'tcx>] {
386        validate_hir_id_for_typeck_results(self.hir_owner, expr.hir_id);
387        self.adjustments.get(&expr.hir_id.local_id).map_or(&[], |a| &a[..])
388    }
389
390    /// Returns the type of `expr`, considering any `Adjustment`
391    /// entry recorded for that expression.
392    pub fn expr_ty_adjusted(&self, expr: &hir::Expr<'_>) -> Ty<'tcx> {
393        self.expr_adjustments(expr).last().map_or_else(|| self.expr_ty(expr), |adj| adj.target)
394    }
395
396    pub fn expr_ty_adjusted_opt(&self, expr: &hir::Expr<'_>) -> Option<Ty<'tcx>> {
397        self.expr_adjustments(expr).last().map(|adj| adj.target).or_else(|| self.expr_ty_opt(expr))
398    }
399
400    pub fn is_method_call(&self, expr: &hir::Expr<'_>) -> bool {
401        // Only paths and method calls/overloaded operators have
402        // entries in type_dependent_defs, ignore the former here.
403        if let hir::ExprKind::Path(_) = expr.kind {
404            return false;
405        }
406
407        matches!(self.type_dependent_defs().get(expr.hir_id), Some(Ok((DefKind::AssocFn, _))))
408    }
409
410    /// Returns the computed binding mode for a `PatKind::Binding` pattern
411    /// (after match ergonomics adjustments).
412    pub fn extract_binding_mode(&self, s: &Session, id: HirId, sp: Span) -> BindingMode {
413        self.pat_binding_modes().get(id).copied().unwrap_or_else(|| {
414            s.dcx().span_bug(sp, "missing binding mode");
415        })
416    }
417
418    pub fn pat_binding_modes(&self) -> LocalTableInContext<'_, BindingMode> {
419        LocalTableInContext { hir_owner: self.hir_owner, data: &self.pat_binding_modes }
420    }
421
422    pub fn pat_binding_modes_mut(&mut self) -> LocalTableInContextMut<'_, BindingMode> {
423        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.pat_binding_modes }
424    }
425
426    pub fn pat_adjustments(
427        &self,
428    ) -> LocalTableInContext<'_, Vec<ty::adjustment::PatAdjustment<'tcx>>> {
429        LocalTableInContext { hir_owner: self.hir_owner, data: &self.pat_adjustments }
430    }
431
432    pub fn pat_adjustments_mut(
433        &mut self,
434    ) -> LocalTableInContextMut<'_, Vec<ty::adjustment::PatAdjustment<'tcx>>> {
435        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.pat_adjustments }
436    }
437
438    pub fn rust_2024_migration_desugared_pats(
439        &self,
440    ) -> LocalTableInContext<'_, Rust2024IncompatiblePatInfo> {
441        LocalTableInContext {
442            hir_owner: self.hir_owner,
443            data: &self.rust_2024_migration_desugared_pats,
444        }
445    }
446
447    pub fn rust_2024_migration_desugared_pats_mut(
448        &mut self,
449    ) -> LocalTableInContextMut<'_, Rust2024IncompatiblePatInfo> {
450        LocalTableInContextMut {
451            hir_owner: self.hir_owner,
452            data: &mut self.rust_2024_migration_desugared_pats,
453        }
454    }
455
456    pub fn skipped_ref_pats(&self) -> LocalSetInContext<'_> {
457        LocalSetInContext { hir_owner: self.hir_owner, data: &self.skipped_ref_pats }
458    }
459
460    pub fn skipped_ref_pats_mut(&mut self) -> LocalSetInContextMut<'_> {
461        LocalSetInContextMut { hir_owner: self.hir_owner, data: &mut self.skipped_ref_pats }
462    }
463
464    /// Does the pattern recursively contain a `ref mut` binding in it?
465    ///
466    /// This is used to determined whether a `deref` pattern should emit a `Deref`
467    /// or `DerefMut` call for its pattern scrutinee.
468    ///
469    /// This is computed from the typeck results since we want to make
470    /// sure to apply any match-ergonomics adjustments, which we cannot
471    /// determine from the HIR alone.
472    pub fn pat_has_ref_mut_binding(&self, pat: &hir::Pat<'_>) -> bool {
473        let mut has_ref_mut = false;
474        pat.walk(|pat| {
475            if let hir::PatKind::Binding(_, id, _, _) = pat.kind
476                && let Some(BindingMode(ByRef::Yes(_, Mutability::Mut), _)) =
477                    self.pat_binding_modes().get(id)
478            {
479                has_ref_mut = true;
480                // No need to continue recursing
481                false
482            } else {
483                true
484            }
485        });
486        has_ref_mut
487    }
488
489    /// How should a deref pattern find the place for its inner pattern to match on?
490    ///
491    /// In most cases, if the pattern recursively contains a `ref mut` binding, we find the inner
492    /// pattern's scrutinee by calling `DerefMut::deref_mut`, and otherwise we call `Deref::deref`.
493    /// However, for boxes we can use a built-in deref instead, which doesn't borrow the scrutinee;
494    /// in this case, we return `ByRef::No`.
495    pub fn deref_pat_borrow_mode(&self, pointer_ty: Ty<'_>, inner: &hir::Pat<'_>) -> ByRef {
496        if pointer_ty.is_box() {
497            ByRef::No
498        } else {
499            let mutable = self.pat_has_ref_mut_binding(inner);
500            ByRef::Yes(Pinnedness::Not, if mutable { Mutability::Mut } else { Mutability::Not })
501        }
502    }
503
504    /// For a given closure, returns the iterator of `ty::CapturedPlace`s that are captured
505    /// by the closure.
506    pub fn closure_min_captures_flattened(
507        &self,
508        closure_def_id: LocalDefId,
509    ) -> impl Iterator<Item = &ty::CapturedPlace<'tcx>> {
510        self.closure_min_captures
511            .get(&closure_def_id)
512            .map(|closure_min_captures| closure_min_captures.values().flat_map(|v| v.iter()))
513            .into_iter()
514            .flatten()
515    }
516
517    pub fn closure_kind_origins(&self) -> LocalTableInContext<'_, (Span, HirPlace<'tcx>)> {
518        LocalTableInContext { hir_owner: self.hir_owner, data: &self.closure_kind_origins }
519    }
520
521    pub fn closure_kind_origins_mut(
522        &mut self,
523    ) -> LocalTableInContextMut<'_, (Span, HirPlace<'tcx>)> {
524        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.closure_kind_origins }
525    }
526
527    pub fn liberated_fn_sigs(&self) -> LocalTableInContext<'_, ty::FnSig<'tcx>> {
528        LocalTableInContext { hir_owner: self.hir_owner, data: &self.liberated_fn_sigs }
529    }
530
531    pub fn liberated_fn_sigs_mut(&mut self) -> LocalTableInContextMut<'_, ty::FnSig<'tcx>> {
532        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.liberated_fn_sigs }
533    }
534
535    pub fn fru_field_types(&self) -> LocalTableInContext<'_, Vec<Ty<'tcx>>> {
536        LocalTableInContext { hir_owner: self.hir_owner, data: &self.fru_field_types }
537    }
538
539    pub fn fru_field_types_mut(&mut self) -> LocalTableInContextMut<'_, Vec<Ty<'tcx>>> {
540        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.fru_field_types }
541    }
542
543    pub fn is_coercion_cast(&self, hir_id: HirId) -> bool {
544        validate_hir_id_for_typeck_results(self.hir_owner, hir_id);
545        self.coercion_casts.contains(&hir_id.local_id)
546    }
547
548    pub fn set_coercion_cast(&mut self, id: ItemLocalId) {
549        self.coercion_casts.insert(id);
550    }
551
552    pub fn coercion_casts(&self) -> &ItemLocalSet {
553        &self.coercion_casts
554    }
555
556    pub fn offset_of_data(&self) -> LocalTableInContext<'_, Vec<(Ty<'tcx>, VariantIdx, FieldIdx)>> {
557        LocalTableInContext { hir_owner: self.hir_owner, data: &self.offset_of_data }
558    }
559
560    pub fn offset_of_data_mut(
561        &mut self,
562    ) -> LocalTableInContextMut<'_, Vec<(Ty<'tcx>, VariantIdx, FieldIdx)>> {
563        LocalTableInContextMut { hir_owner: self.hir_owner, data: &mut self.offset_of_data }
564    }
565}
566
567/// Validate that the given HirId (respectively its `local_id` part) can be
568/// safely used as a key in the maps of a TypeckResults. For that to be
569/// the case, the HirId must have the same `owner` as all the other IDs in
570/// this table (signified by `hir_owner`). Otherwise the HirId
571/// would be in a different frame of reference and using its `local_id`
572/// would result in lookup errors, or worse, in silently wrong data being
573/// stored/returned.
574#[inline]
575fn validate_hir_id_for_typeck_results(hir_owner: OwnerId, hir_id: HirId) {
576    if hir_id.owner != hir_owner {
577        invalid_hir_id_for_typeck_results(hir_owner, hir_id);
578    }
579}
580
581#[cold]
582#[inline(never)]
583fn invalid_hir_id_for_typeck_results(hir_owner: OwnerId, hir_id: HirId) {
584    ty::tls::with(|tcx| {
585        bug!(
586            "node {} cannot be placed in TypeckResults with hir_owner {:?}",
587            tcx.hir_id_to_string(hir_id),
588            hir_owner
589        )
590    });
591}
592
593pub struct LocalTableInContext<'a, V> {
594    hir_owner: OwnerId,
595    data: &'a ItemLocalMap<V>,
596}
597
598impl<'a, V> LocalTableInContext<'a, V> {
599    pub fn contains_key(&self, id: HirId) -> bool {
600        validate_hir_id_for_typeck_results(self.hir_owner, id);
601        self.data.contains_key(&id.local_id)
602    }
603
604    pub fn get(&self, id: HirId) -> Option<&'a V> {
605        validate_hir_id_for_typeck_results(self.hir_owner, id);
606        self.data.get(&id.local_id)
607    }
608
609    pub fn items(
610        &self,
611    ) -> UnordItems<(hir::ItemLocalId, &'a V), impl Iterator<Item = (hir::ItemLocalId, &'a V)>>
612    {
613        self.data.items().map(|(id, value)| (*id, value))
614    }
615
616    pub fn items_in_stable_order(&self) -> Vec<(ItemLocalId, &'a V)> {
617        self.data.items().map(|(&k, v)| (k, v)).into_sorted_stable_ord_by_key(|(k, _)| k)
618    }
619}
620
621impl<'a, V> ::std::ops::Index<HirId> for LocalTableInContext<'a, V> {
622    type Output = V;
623
624    fn index(&self, key: HirId) -> &V {
625        self.get(key).unwrap_or_else(|| {
626            bug!("LocalTableInContext({:?}): key {:?} not found", self.hir_owner, key)
627        })
628    }
629}
630
631pub struct LocalTableInContextMut<'a, V> {
632    hir_owner: OwnerId,
633    data: &'a mut ItemLocalMap<V>,
634}
635
636impl<'a, V> LocalTableInContextMut<'a, V> {
637    pub fn get_mut(&mut self, id: HirId) -> Option<&mut V> {
638        validate_hir_id_for_typeck_results(self.hir_owner, id);
639        self.data.get_mut(&id.local_id)
640    }
641
642    pub fn get(&mut self, id: HirId) -> Option<&V> {
643        validate_hir_id_for_typeck_results(self.hir_owner, id);
644        self.data.get(&id.local_id)
645    }
646
647    pub fn entry(&mut self, id: HirId) -> Entry<'_, hir::ItemLocalId, V> {
648        validate_hir_id_for_typeck_results(self.hir_owner, id);
649        self.data.entry(id.local_id)
650    }
651
652    pub fn insert(&mut self, id: HirId, val: V) -> Option<V> {
653        validate_hir_id_for_typeck_results(self.hir_owner, id);
654        self.data.insert(id.local_id, val)
655    }
656
657    pub fn remove(&mut self, id: HirId) -> Option<V> {
658        validate_hir_id_for_typeck_results(self.hir_owner, id);
659        self.data.remove(&id.local_id)
660    }
661
662    pub fn extend(&mut self, items: UnordItems<(HirId, V), impl Iterator<Item = (HirId, V)>>) {
663        self.data.extend_unord(items.map(|(id, value)| {
664            validate_hir_id_for_typeck_results(self.hir_owner, id);
665            (id.local_id, value)
666        }))
667    }
668}
669
670#[derive(Clone, Copy, Debug)]
671pub struct LocalSetInContext<'a> {
672    hir_owner: OwnerId,
673    data: &'a ItemLocalSet,
674}
675
676impl<'a> LocalSetInContext<'a> {
677    pub fn is_empty(&self) -> bool {
678        self.data.is_empty()
679    }
680
681    pub fn contains(&self, id: hir::HirId) -> bool {
682        validate_hir_id_for_typeck_results(self.hir_owner, id);
683        self.data.contains(&id.local_id)
684    }
685}
686
687#[derive(Debug)]
688pub struct LocalSetInContextMut<'a> {
689    hir_owner: OwnerId,
690    data: &'a mut ItemLocalSet,
691}
692
693impl<'a> LocalSetInContextMut<'a> {
694    pub fn is_empty(&self) -> bool {
695        self.data.is_empty()
696    }
697
698    pub fn contains(&self, id: hir::HirId) -> bool {
699        validate_hir_id_for_typeck_results(self.hir_owner, id);
700        self.data.contains(&id.local_id)
701    }
702    pub fn insert(&mut self, id: hir::HirId) -> bool {
703        validate_hir_id_for_typeck_results(self.hir_owner, id);
704        self.data.insert(id.local_id)
705    }
706
707    pub fn remove(&mut self, id: hir::HirId) -> bool {
708        validate_hir_id_for_typeck_results(self.hir_owner, id);
709        self.data.remove(&id.local_id)
710    }
711}
712
713rustc_index::newtype_index! {
714    #[derive(HashStable)]
715    #[encodable]
716    #[debug_format = "UserType({})"]
717    pub struct UserTypeAnnotationIndex {
718        const START_INDEX = 0;
719    }
720}
721
722/// Mapping of type annotation indices to canonical user type annotations.
723pub type CanonicalUserTypeAnnotations<'tcx> =
724    IndexVec<UserTypeAnnotationIndex, CanonicalUserTypeAnnotation<'tcx>>;
725
726#[derive(Clone, Debug, TyEncodable, TyDecodable, HashStable, TypeFoldable, TypeVisitable)]
727pub struct CanonicalUserTypeAnnotation<'tcx> {
728    #[type_foldable(identity)]
729    #[type_visitable(ignore)]
730    pub user_ty: Box<CanonicalUserType<'tcx>>,
731    pub span: Span,
732    pub inferred_ty: Ty<'tcx>,
733}
734
735/// Canonical user type annotation.
736pub type CanonicalUserType<'tcx> = Canonical<'tcx, UserType<'tcx>>;
737
738#[derive(Copy, Clone, Debug, PartialEq, TyEncodable, TyDecodable)]
739#[derive(Eq, Hash, HashStable, TypeFoldable, TypeVisitable)]
740pub struct UserType<'tcx> {
741    pub kind: UserTypeKind<'tcx>,
742    pub bounds: ty::Clauses<'tcx>,
743}
744
745impl<'tcx> UserType<'tcx> {
746    pub fn new(kind: UserTypeKind<'tcx>) -> UserType<'tcx> {
747        UserType { kind, bounds: ty::ListWithCachedTypeInfo::empty() }
748    }
749
750    /// A user type annotation with additional bounds that need to be enforced.
751    /// These bounds are lowered from `impl Trait` in bindings.
752    pub fn new_with_bounds(kind: UserTypeKind<'tcx>, bounds: ty::Clauses<'tcx>) -> UserType<'tcx> {
753        UserType { kind, bounds }
754    }
755}
756
757/// A user-given type annotation attached to a constant. These arise
758/// from constants that are named via paths, like `Foo::<A>::new` and
759/// so forth.
760#[derive(Copy, Clone, Debug, PartialEq, TyEncodable, TyDecodable)]
761#[derive(Eq, Hash, HashStable, TypeFoldable, TypeVisitable)]
762pub enum UserTypeKind<'tcx> {
763    Ty(Ty<'tcx>),
764
765    /// The canonical type is the result of `type_of(def_id)` with the
766    /// given generic parameters applied.
767    TypeOf(DefId, UserArgs<'tcx>),
768}
769
770pub trait IsIdentity {
771    fn is_identity(&self) -> bool;
772}
773
774impl<'tcx> IsIdentity for CanonicalUserType<'tcx> {
775    /// Returns `true` if this represents the generic parameters of the form `[?0, ?1, ?2]`,
776    /// i.e., each thing is mapped to a canonical variable with the same index.
777    fn is_identity(&self) -> bool {
778        if !self.value.bounds.is_empty() {
779            return false;
780        }
781
782        match self.value.kind {
783            UserTypeKind::Ty(_) => false,
784            UserTypeKind::TypeOf(_, user_args) => {
785                if user_args.user_self_ty.is_some() {
786                    return false;
787                }
788
789                iter::zip(user_args.args, BoundVar::ZERO..).all(|(arg, cvar)| {
790                    match arg.kind() {
791                        GenericArgKind::Type(ty) => match ty.kind() {
792                            ty::Bound(debruijn, b) => {
793                                // We only allow a `ty::BoundVarIndexKind::Canonical` index in generic parameters.
794                                assert_eq!(*debruijn, ty::BoundVarIndexKind::Canonical);
795                                cvar == b.var
796                            }
797                            _ => false,
798                        },
799
800                        GenericArgKind::Lifetime(r) => match r.kind() {
801                            ty::ReBound(debruijn, b) => {
802                                // We only allow a `ty::BoundVarIndexKind::Canonical` index in generic parameters.
803                                assert_eq!(debruijn, ty::BoundVarIndexKind::Canonical);
804                                cvar == b.var
805                            }
806                            _ => false,
807                        },
808
809                        GenericArgKind::Const(ct) => match ct.kind() {
810                            ty::ConstKind::Bound(debruijn, b) => {
811                                // We only allow a `ty::BoundVarIndexKind::Canonical` index in generic parameters.
812                                assert_eq!(debruijn, ty::BoundVarIndexKind::Canonical);
813                                cvar == b.var
814                            }
815                            _ => false,
816                        },
817                    }
818                })
819            }
820        }
821    }
822}
823
824impl<'tcx> std::fmt::Display for UserType<'tcx> {
825    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
826        if self.bounds.is_empty() {
827            self.kind.fmt(f)
828        } else {
829            self.kind.fmt(f)?;
830            write!(f, " + ")?;
831            std::fmt::Debug::fmt(&self.bounds, f)
832        }
833    }
834}
835
836impl<'tcx> std::fmt::Display for UserTypeKind<'tcx> {
837    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
838        match self {
839            Self::Ty(arg0) => {
840                ty::print::with_no_trimmed_paths!(write!(f, "Ty({})", arg0))
841            }
842            Self::TypeOf(arg0, arg1) => write!(f, "TypeOf({:?}, {:?})", arg0, arg1),
843        }
844    }
845}
846
847/// Information on a pattern incompatible with Rust 2024, for use by the error/migration diagnostic
848/// emitted during THIR construction.
849#[derive(TyEncodable, TyDecodable, Debug, HashStable)]
850pub struct Rust2024IncompatiblePatInfo {
851    /// Labeled spans for `&`s, `&mut`s, and binding modifiers incompatible with Rust 2024.
852    pub primary_labels: Vec<(Span, String)>,
853    /// Whether any `mut` binding modifiers occur under a non-`move` default binding mode.
854    pub bad_mut_modifiers: bool,
855    /// Whether any `ref`/`ref mut` binding modifiers occur under a non-`move` default binding mode.
856    pub bad_ref_modifiers: bool,
857    /// Whether any `&` or `&mut` patterns occur under a non-`move` default binding mode.
858    pub bad_ref_pats: bool,
859    /// If `true`, we can give a simpler suggestion solely by eliding explicit binding modifiers.
860    pub suggest_eliding_modes: bool,
861}
rustc_middle/ty/typeck_results.rs

rustc_middle/ty/
typeck_results.rs
