]> git.lizzy.rs Git - rust.git/blob - compiler/rustc_hir_typeck/src/pat.rs
Rollup merge of #104435 - scottmcm:iter-repeat-n, r=thomcc
[rust.git] / compiler / rustc_hir_typeck / src / pat.rs
1 use crate::FnCtxt;
2 use rustc_ast as ast;
3 use rustc_data_structures::fx::FxHashMap;
4 use rustc_errors::{
5     pluralize, struct_span_err, Applicability, Diagnostic, DiagnosticBuilder, ErrorGuaranteed,
6     MultiSpan,
7 };
8 use rustc_hir as hir;
9 use rustc_hir::def::{CtorKind, DefKind, Res};
10 use rustc_hir::pat_util::EnumerateAndAdjustIterator;
11 use rustc_hir::{HirId, Pat, PatKind};
12 use rustc_infer::infer;
13 use rustc_infer::infer::type_variable::{TypeVariableOrigin, TypeVariableOriginKind};
14 use rustc_middle::middle::stability::EvalResult;
15 use rustc_middle::ty::{self, Adt, BindingMode, Ty, TypeVisitable};
16 use rustc_session::lint::builtin::NON_EXHAUSTIVE_OMITTED_PATTERNS;
17 use rustc_span::hygiene::DesugaringKind;
18 use rustc_span::lev_distance::find_best_match_for_name;
19 use rustc_span::source_map::{Span, Spanned};
20 use rustc_span::symbol::{kw, sym, Ident};
21 use rustc_span::{BytePos, DUMMY_SP};
22 use rustc_trait_selection::traits::{ObligationCause, Pattern};
23 use ty::VariantDef;
24
25 use std::cmp;
26 use std::collections::hash_map::Entry::{Occupied, Vacant};
27
28 use super::report_unexpected_variant_res;
29
30 const CANNOT_IMPLICITLY_DEREF_POINTER_TRAIT_OBJ: &str = "\
31 This error indicates that a pointer to a trait type cannot be implicitly dereferenced by a \
32 pattern. Every trait defines a type, but because the size of trait implementors isn't fixed, \
33 this type has no compile-time size. Therefore, all accesses to trait types must be through \
34 pointers. If you encounter this error you should try to avoid dereferencing the pointer.
35
36 You can read more about trait objects in the Trait Objects section of the Reference: \
37 https://doc.rust-lang.org/reference/types.html#trait-objects";
38
39 /// Information about the expected type at the top level of type checking a pattern.
40 ///
41 /// **NOTE:** This is only for use by diagnostics. Do NOT use for type checking logic!
42 #[derive(Copy, Clone)]
43 struct TopInfo<'tcx> {
44     /// The `expected` type at the top level of type checking a pattern.
45     expected: Ty<'tcx>,
46     /// Was the origin of the `span` from a scrutinee expression?
47     ///
48     /// Otherwise there is no scrutinee and it could be e.g. from the type of a formal parameter.
49     origin_expr: bool,
50     /// The span giving rise to the `expected` type, if one could be provided.
51     ///
52     /// If `origin_expr` is `true`, then this is the span of the scrutinee as in:
53     ///
54     /// - `match scrutinee { ... }`
55     /// - `let _ = scrutinee;`
56     ///
57     /// This is used to point to add context in type errors.
58     /// In the following example, `span` corresponds to the `a + b` expression:
59     ///
60     /// ```text
61     /// error[E0308]: mismatched types
62     ///  --> src/main.rs:L:C
63     ///   |
64     /// L |    let temp: usize = match a + b {
65     ///   |                            ----- this expression has type `usize`
66     /// L |         Ok(num) => num,
67     ///   |         ^^^^^^^ expected `usize`, found enum `std::result::Result`
68     ///   |
69     ///   = note: expected type `usize`
70     ///              found type `std::result::Result<_, _>`
71     /// ```
72     span: Option<Span>,
73 }
74
75 impl<'tcx> FnCtxt<'_, 'tcx> {
76     fn pattern_cause(&self, ti: TopInfo<'tcx>, cause_span: Span) -> ObligationCause<'tcx> {
77         let code = Pattern { span: ti.span, root_ty: ti.expected, origin_expr: ti.origin_expr };
78         self.cause(cause_span, code)
79     }
80
81     fn demand_eqtype_pat_diag(
82         &self,
83         cause_span: Span,
84         expected: Ty<'tcx>,
85         actual: Ty<'tcx>,
86         ti: TopInfo<'tcx>,
87     ) -> Option<DiagnosticBuilder<'tcx, ErrorGuaranteed>> {
88         self.demand_eqtype_with_origin(&self.pattern_cause(ti, cause_span), expected, actual)
89     }
90
91     fn demand_eqtype_pat(
92         &self,
93         cause_span: Span,
94         expected: Ty<'tcx>,
95         actual: Ty<'tcx>,
96         ti: TopInfo<'tcx>,
97     ) {
98         if let Some(mut err) = self.demand_eqtype_pat_diag(cause_span, expected, actual, ti) {
99             err.emit();
100         }
101     }
102 }
103
104 const INITIAL_BM: BindingMode = BindingMode::BindByValue(hir::Mutability::Not);
105
106 /// Mode for adjusting the expected type and binding mode.
107 enum AdjustMode {
108     /// Peel off all immediate reference types.
109     Peel,
110     /// Reset binding mode to the initial mode.
111     Reset,
112     /// Pass on the input binding mode and expected type.
113     Pass,
114 }
115
116 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
117     /// Type check the given top level pattern against the `expected` type.
118     ///
119     /// If a `Some(span)` is provided and `origin_expr` holds,
120     /// then the `span` represents the scrutinee's span.
121     /// The scrutinee is found in e.g. `match scrutinee { ... }` and `let pat = scrutinee;`.
122     ///
123     /// Otherwise, `Some(span)` represents the span of a type expression
124     /// which originated the `expected` type.
125     pub fn check_pat_top(
126         &self,
127         pat: &'tcx Pat<'tcx>,
128         expected: Ty<'tcx>,
129         span: Option<Span>,
130         origin_expr: bool,
131     ) {
132         let info = TopInfo { expected, origin_expr, span };
133         self.check_pat(pat, expected, INITIAL_BM, info);
134     }
135
136     /// Type check the given `pat` against the `expected` type
137     /// with the provided `def_bm` (default binding mode).
138     ///
139     /// Outside of this module, `check_pat_top` should always be used.
140     /// Conversely, inside this module, `check_pat_top` should never be used.
141     #[instrument(level = "debug", skip(self, ti))]
142     fn check_pat(
143         &self,
144         pat: &'tcx Pat<'tcx>,
145         expected: Ty<'tcx>,
146         def_bm: BindingMode,
147         ti: TopInfo<'tcx>,
148     ) {
149         let path_res = match &pat.kind {
150             PatKind::Path(qpath) => {
151                 Some(self.resolve_ty_and_res_fully_qualified_call(qpath, pat.hir_id, pat.span))
152             }
153             _ => None,
154         };
155         let adjust_mode = self.calc_adjust_mode(pat, path_res.map(|(res, ..)| res));
156         let (expected, def_bm) = self.calc_default_binding_mode(pat, expected, def_bm, adjust_mode);
157
158         let ty = match pat.kind {
159             PatKind::Wild => expected,
160             PatKind::Lit(lt) => self.check_pat_lit(pat.span, lt, expected, ti),
161             PatKind::Range(lhs, rhs, _) => self.check_pat_range(pat.span, lhs, rhs, expected, ti),
162             PatKind::Binding(ba, var_id, _, sub) => {
163                 self.check_pat_ident(pat, ba, var_id, sub, expected, def_bm, ti)
164             }
165             PatKind::TupleStruct(ref qpath, subpats, ddpos) => {
166                 self.check_pat_tuple_struct(pat, qpath, subpats, ddpos, expected, def_bm, ti)
167             }
168             PatKind::Path(ref qpath) => {
169                 self.check_pat_path(pat, qpath, path_res.unwrap(), expected, ti)
170             }
171             PatKind::Struct(ref qpath, fields, has_rest_pat) => {
172                 self.check_pat_struct(pat, qpath, fields, has_rest_pat, expected, def_bm, ti)
173             }
174             PatKind::Or(pats) => {
175                 for pat in pats {
176                     self.check_pat(pat, expected, def_bm, ti);
177                 }
178                 expected
179             }
180             PatKind::Tuple(elements, ddpos) => {
181                 self.check_pat_tuple(pat.span, elements, ddpos, expected, def_bm, ti)
182             }
183             PatKind::Box(inner) => self.check_pat_box(pat.span, inner, expected, def_bm, ti),
184             PatKind::Ref(inner, mutbl) => {
185                 self.check_pat_ref(pat, inner, mutbl, expected, def_bm, ti)
186             }
187             PatKind::Slice(before, slice, after) => {
188                 self.check_pat_slice(pat.span, before, slice, after, expected, def_bm, ti)
189             }
190         };
191
192         self.write_ty(pat.hir_id, ty);
193
194         // (note_1): In most of the cases where (note_1) is referenced
195         // (literals and constants being the exception), we relate types
196         // using strict equality, even though subtyping would be sufficient.
197         // There are a few reasons for this, some of which are fairly subtle
198         // and which cost me (nmatsakis) an hour or two debugging to remember,
199         // so I thought I'd write them down this time.
200         //
201         // 1. There is no loss of expressiveness here, though it does
202         // cause some inconvenience. What we are saying is that the type
203         // of `x` becomes *exactly* what is expected. This can cause unnecessary
204         // errors in some cases, such as this one:
205         //
206         // ```
207         // fn foo<'x>(x: &'x i32) {
208         //    let a = 1;
209         //    let mut z = x;
210         //    z = &a;
211         // }
212         // ```
213         //
214         // The reason we might get an error is that `z` might be
215         // assigned a type like `&'x i32`, and then we would have
216         // a problem when we try to assign `&a` to `z`, because
217         // the lifetime of `&a` (i.e., the enclosing block) is
218         // shorter than `'x`.
219         //
220         // HOWEVER, this code works fine. The reason is that the
221         // expected type here is whatever type the user wrote, not
222         // the initializer's type. In this case the user wrote
223         // nothing, so we are going to create a type variable `Z`.
224         // Then we will assign the type of the initializer (`&'x i32`)
225         // as a subtype of `Z`: `&'x i32 <: Z`. And hence we
226         // will instantiate `Z` as a type `&'0 i32` where `'0` is
227         // a fresh region variable, with the constraint that `'x : '0`.
228         // So basically we're all set.
229         //
230         // Note that there are two tests to check that this remains true
231         // (`regions-reassign-{match,let}-bound-pointer.rs`).
232         //
233         // 2. Things go horribly wrong if we use subtype. The reason for
234         // THIS is a fairly subtle case involving bound regions. See the
235         // `givens` field in `region_constraints`, as well as the test
236         // `regions-relate-bound-regions-on-closures-to-inference-variables.rs`,
237         // for details. Short version is that we must sometimes detect
238         // relationships between specific region variables and regions
239         // bound in a closure signature, and that detection gets thrown
240         // off when we substitute fresh region variables here to enable
241         // subtyping.
242     }
243
244     /// Compute the new expected type and default binding mode from the old ones
245     /// as well as the pattern form we are currently checking.
246     fn calc_default_binding_mode(
247         &self,
248         pat: &'tcx Pat<'tcx>,
249         expected: Ty<'tcx>,
250         def_bm: BindingMode,
251         adjust_mode: AdjustMode,
252     ) -> (Ty<'tcx>, BindingMode) {
253         match adjust_mode {
254             AdjustMode::Pass => (expected, def_bm),
255             AdjustMode::Reset => (expected, INITIAL_BM),
256             AdjustMode::Peel => self.peel_off_references(pat, expected, def_bm),
257         }
258     }
259
260     /// How should the binding mode and expected type be adjusted?
261     ///
262     /// When the pattern is a path pattern, `opt_path_res` must be `Some(res)`.
263     fn calc_adjust_mode(&self, pat: &'tcx Pat<'tcx>, opt_path_res: Option<Res>) -> AdjustMode {
264         // When we perform destructuring assignment, we disable default match bindings, which are
265         // unintuitive in this context.
266         if !pat.default_binding_modes {
267             return AdjustMode::Reset;
268         }
269         match &pat.kind {
270             // Type checking these product-like types successfully always require
271             // that the expected type be of those types and not reference types.
272             PatKind::Struct(..)
273             | PatKind::TupleStruct(..)
274             | PatKind::Tuple(..)
275             | PatKind::Box(_)
276             | PatKind::Range(..)
277             | PatKind::Slice(..) => AdjustMode::Peel,
278             // String and byte-string literals result in types `&str` and `&[u8]` respectively.
279             // All other literals result in non-reference types.
280             // As a result, we allow `if let 0 = &&0 {}` but not `if let "foo" = &&"foo {}`.
281             //
282             // Call `resolve_vars_if_possible` here for inline const blocks.
283             PatKind::Lit(lt) => match self.resolve_vars_if_possible(self.check_expr(lt)).kind() {
284                 ty::Ref(..) => AdjustMode::Pass,
285                 _ => AdjustMode::Peel,
286             },
287             PatKind::Path(_) => match opt_path_res.unwrap() {
288                 // These constants can be of a reference type, e.g. `const X: &u8 = &0;`.
289                 // Peeling the reference types too early will cause type checking failures.
290                 // Although it would be possible to *also* peel the types of the constants too.
291                 Res::Def(DefKind::Const | DefKind::AssocConst, _) => AdjustMode::Pass,
292                 // In the `ValueNS`, we have `SelfCtor(..) | Ctor(_, Const), _)` remaining which
293                 // could successfully compile. The former being `Self` requires a unit struct.
294                 // In either case, and unlike constants, the pattern itself cannot be
295                 // a reference type wherefore peeling doesn't give up any expressiveness.
296                 _ => AdjustMode::Peel,
297             },
298             // When encountering a `& mut? pat` pattern, reset to "by value".
299             // This is so that `x` and `y` here are by value, as they appear to be:
300             //
301             // ```
302             // match &(&22, &44) {
303             //   (&x, &y) => ...
304             // }
305             // ```
306             //
307             // See issue #46688.
308             PatKind::Ref(..) => AdjustMode::Reset,
309             // A `_` pattern works with any expected type, so there's no need to do anything.
310             PatKind::Wild
311             // Bindings also work with whatever the expected type is,
312             // and moreover if we peel references off, that will give us the wrong binding type.
313             // Also, we can have a subpattern `binding @ pat`.
314             // Each side of the `@` should be treated independently (like with OR-patterns).
315             | PatKind::Binding(..)
316             // An OR-pattern just propagates to each individual alternative.
317             // This is maximally flexible, allowing e.g., `Some(mut x) | &Some(mut x)`.
318             // In that example, `Some(mut x)` results in `Peel` whereas `&Some(mut x)` in `Reset`.
319             | PatKind::Or(_) => AdjustMode::Pass,
320         }
321     }
322
323     /// Peel off as many immediately nested `& mut?` from the expected type as possible
324     /// and return the new expected type and binding default binding mode.
325     /// The adjustments vector, if non-empty is stored in a table.
326     fn peel_off_references(
327         &self,
328         pat: &'tcx Pat<'tcx>,
329         expected: Ty<'tcx>,
330         mut def_bm: BindingMode,
331     ) -> (Ty<'tcx>, BindingMode) {
332         let mut expected = self.resolve_vars_with_obligations(expected);
333
334         // Peel off as many `&` or `&mut` from the scrutinee type as possible. For example,
335         // for `match &&&mut Some(5)` the loop runs three times, aborting when it reaches
336         // the `Some(5)` which is not of type Ref.
337         //
338         // For each ampersand peeled off, update the binding mode and push the original
339         // type into the adjustments vector.
340         //
341         // See the examples in `ui/match-defbm*.rs`.
342         let mut pat_adjustments = vec![];
343         while let ty::Ref(_, inner_ty, inner_mutability) = *expected.kind() {
344             debug!("inspecting {:?}", expected);
345
346             debug!("current discriminant is Ref, inserting implicit deref");
347             // Preserve the reference type. We'll need it later during THIR lowering.
348             pat_adjustments.push(expected);
349
350             expected = inner_ty;
351             def_bm = ty::BindByReference(match def_bm {
352                 // If default binding mode is by value, make it `ref` or `ref mut`
353                 // (depending on whether we observe `&` or `&mut`).
354                 ty::BindByValue(_) |
355                 // When `ref mut`, stay a `ref mut` (on `&mut`) or downgrade to `ref` (on `&`).
356                 ty::BindByReference(hir::Mutability::Mut) => inner_mutability,
357                 // Once a `ref`, always a `ref`.
358                 // This is because a `& &mut` cannot mutate the underlying value.
359                 ty::BindByReference(m @ hir::Mutability::Not) => m,
360             });
361         }
362
363         if !pat_adjustments.is_empty() {
364             debug!("default binding mode is now {:?}", def_bm);
365             self.inh
366                 .typeck_results
367                 .borrow_mut()
368                 .pat_adjustments_mut()
369                 .insert(pat.hir_id, pat_adjustments);
370         }
371
372         (expected, def_bm)
373     }
374
375     fn check_pat_lit(
376         &self,
377         span: Span,
378         lt: &hir::Expr<'tcx>,
379         expected: Ty<'tcx>,
380         ti: TopInfo<'tcx>,
381     ) -> Ty<'tcx> {
382         // We've already computed the type above (when checking for a non-ref pat),
383         // so avoid computing it again.
384         let ty = self.node_ty(lt.hir_id);
385
386         // Byte string patterns behave the same way as array patterns
387         // They can denote both statically and dynamically-sized byte arrays.
388         let mut pat_ty = ty;
389         if let hir::ExprKind::Lit(Spanned { node: ast::LitKind::ByteStr(_), .. }) = lt.kind {
390             let expected = self.structurally_resolved_type(span, expected);
391             if let ty::Ref(_, inner_ty, _) = expected.kind()
392                 && matches!(inner_ty.kind(), ty::Slice(_))
393             {
394                 let tcx = self.tcx;
395                 trace!(?lt.hir_id.local_id, "polymorphic byte string lit");
396                 self.typeck_results
397                     .borrow_mut()
398                     .treat_byte_string_as_slice
399                     .insert(lt.hir_id.local_id);
400                 pat_ty = tcx.mk_imm_ref(tcx.lifetimes.re_static, tcx.mk_slice(tcx.types.u8));
401             }
402         }
403
404         // Somewhat surprising: in this case, the subtyping relation goes the
405         // opposite way as the other cases. Actually what we really want is not
406         // a subtyping relation at all but rather that there exists a LUB
407         // (so that they can be compared). However, in practice, constants are
408         // always scalars or strings. For scalars subtyping is irrelevant,
409         // and for strings `ty` is type is `&'static str`, so if we say that
410         //
411         //     &'static str <: expected
412         //
413         // then that's equivalent to there existing a LUB.
414         let cause = self.pattern_cause(ti, span);
415         if let Some(mut err) = self.demand_suptype_with_origin(&cause, expected, pat_ty) {
416             err.emit_unless(
417                 ti.span
418                     .filter(|&s| {
419                         // In the case of `if`- and `while`-expressions we've already checked
420                         // that `scrutinee: bool`. We know that the pattern is `true`,
421                         // so an error here would be a duplicate and from the wrong POV.
422                         s.is_desugaring(DesugaringKind::CondTemporary)
423                     })
424                     .is_some(),
425             );
426         }
427
428         pat_ty
429     }
430
431     fn check_pat_range(
432         &self,
433         span: Span,
434         lhs: Option<&'tcx hir::Expr<'tcx>>,
435         rhs: Option<&'tcx hir::Expr<'tcx>>,
436         expected: Ty<'tcx>,
437         ti: TopInfo<'tcx>,
438     ) -> Ty<'tcx> {
439         let calc_side = |opt_expr: Option<&'tcx hir::Expr<'tcx>>| match opt_expr {
440             None => None,
441             Some(expr) => {
442                 let ty = self.check_expr(expr);
443                 // Check that the end-point is possibly of numeric or char type.
444                 // The early check here is not for correctness, but rather better
445                 // diagnostics (e.g. when `&str` is being matched, `expected` will
446                 // be peeled to `str` while ty here is still `&str`, if we don't
447                 // err early here, a rather confusing unification error will be
448                 // emitted instead).
449                 let fail =
450                     !(ty.is_numeric() || ty.is_char() || ty.is_ty_var() || ty.references_error());
451                 Some((fail, ty, expr.span))
452             }
453         };
454         let mut lhs = calc_side(lhs);
455         let mut rhs = calc_side(rhs);
456
457         if let (Some((true, ..)), _) | (_, Some((true, ..))) = (lhs, rhs) {
458             // There exists a side that didn't meet our criteria that the end-point
459             // be of a numeric or char type, as checked in `calc_side` above.
460             self.emit_err_pat_range(span, lhs, rhs);
461             return self.tcx.ty_error();
462         }
463
464         // Unify each side with `expected`.
465         // Subtyping doesn't matter here, as the value is some kind of scalar.
466         let demand_eqtype = |x: &mut _, y| {
467             if let Some((ref mut fail, x_ty, x_span)) = *x
468                 && let Some(mut err) = self.demand_eqtype_pat_diag(x_span, expected, x_ty, ti)
469             {
470                 if let Some((_, y_ty, y_span)) = y {
471                     self.endpoint_has_type(&mut err, y_span, y_ty);
472                 }
473                 err.emit();
474                 *fail = true;
475             }
476         };
477         demand_eqtype(&mut lhs, rhs);
478         demand_eqtype(&mut rhs, lhs);
479
480         if let (Some((true, ..)), _) | (_, Some((true, ..))) = (lhs, rhs) {
481             return self.tcx.ty_error();
482         }
483
484         // Find the unified type and check if it's of numeric or char type again.
485         // This check is needed if both sides are inference variables.
486         // We require types to be resolved here so that we emit inference failure
487         // rather than "_ is not a char or numeric".
488         let ty = self.structurally_resolved_type(span, expected);
489         if !(ty.is_numeric() || ty.is_char() || ty.references_error()) {
490             if let Some((ref mut fail, _, _)) = lhs {
491                 *fail = true;
492             }
493             if let Some((ref mut fail, _, _)) = rhs {
494                 *fail = true;
495             }
496             self.emit_err_pat_range(span, lhs, rhs);
497             return self.tcx.ty_error();
498         }
499         ty
500     }
501
502     fn endpoint_has_type(&self, err: &mut Diagnostic, span: Span, ty: Ty<'_>) {
503         if !ty.references_error() {
504             err.span_label(span, &format!("this is of type `{}`", ty));
505         }
506     }
507
508     fn emit_err_pat_range(
509         &self,
510         span: Span,
511         lhs: Option<(bool, Ty<'tcx>, Span)>,
512         rhs: Option<(bool, Ty<'tcx>, Span)>,
513     ) {
514         let span = match (lhs, rhs) {
515             (Some((true, ..)), Some((true, ..))) => span,
516             (Some((true, _, sp)), _) => sp,
517             (_, Some((true, _, sp))) => sp,
518             _ => span_bug!(span, "emit_err_pat_range: no side failed or exists but still error?"),
519         };
520         let mut err = struct_span_err!(
521             self.tcx.sess,
522             span,
523             E0029,
524             "only `char` and numeric types are allowed in range patterns"
525         );
526         let msg = |ty| {
527             let ty = self.resolve_vars_if_possible(ty);
528             format!("this is of type `{}` but it should be `char` or numeric", ty)
529         };
530         let mut one_side_err = |first_span, first_ty, second: Option<(bool, Ty<'tcx>, Span)>| {
531             err.span_label(first_span, &msg(first_ty));
532             if let Some((_, ty, sp)) = second {
533                 let ty = self.resolve_vars_if_possible(ty);
534                 self.endpoint_has_type(&mut err, sp, ty);
535             }
536         };
537         match (lhs, rhs) {
538             (Some((true, lhs_ty, lhs_sp)), Some((true, rhs_ty, rhs_sp))) => {
539                 err.span_label(lhs_sp, &msg(lhs_ty));
540                 err.span_label(rhs_sp, &msg(rhs_ty));
541             }
542             (Some((true, lhs_ty, lhs_sp)), rhs) => one_side_err(lhs_sp, lhs_ty, rhs),
543             (lhs, Some((true, rhs_ty, rhs_sp))) => one_side_err(rhs_sp, rhs_ty, lhs),
544             _ => span_bug!(span, "Impossible, verified above."),
545         }
546         if self.tcx.sess.teach(&err.get_code().unwrap()) {
547             err.note(
548                 "In a match expression, only numbers and characters can be matched \
549                     against a range. This is because the compiler checks that the range \
550                     is non-empty at compile-time, and is unable to evaluate arbitrary \
551                     comparison functions. If you want to capture values of an orderable \
552                     type between two end-points, you can use a guard.",
553             );
554         }
555         err.emit();
556     }
557
558     fn check_pat_ident(
559         &self,
560         pat: &'tcx Pat<'tcx>,
561         ba: hir::BindingAnnotation,
562         var_id: HirId,
563         sub: Option<&'tcx Pat<'tcx>>,
564         expected: Ty<'tcx>,
565         def_bm: BindingMode,
566         ti: TopInfo<'tcx>,
567     ) -> Ty<'tcx> {
568         // Determine the binding mode...
569         let bm = match ba {
570             hir::BindingAnnotation::NONE => def_bm,
571             _ => BindingMode::convert(ba),
572         };
573         // ...and store it in a side table:
574         self.inh.typeck_results.borrow_mut().pat_binding_modes_mut().insert(pat.hir_id, bm);
575
576         debug!("check_pat_ident: pat.hir_id={:?} bm={:?}", pat.hir_id, bm);
577
578         let local_ty = self.local_ty(pat.span, pat.hir_id).decl_ty;
579         let eq_ty = match bm {
580             ty::BindByReference(mutbl) => {
581                 // If the binding is like `ref x | ref mut x`,
582                 // then `x` is assigned a value of type `&M T` where M is the
583                 // mutability and T is the expected type.
584                 //
585                 // `x` is assigned a value of type `&M T`, hence `&M T <: typeof(x)`
586                 // is required. However, we use equality, which is stronger.
587                 // See (note_1) for an explanation.
588                 self.new_ref_ty(pat.span, mutbl, expected)
589             }
590             // Otherwise, the type of x is the expected type `T`.
591             ty::BindByValue(_) => {
592                 // As above, `T <: typeof(x)` is required, but we use equality, see (note_1).
593                 expected
594             }
595         };
596         self.demand_eqtype_pat(pat.span, eq_ty, local_ty, ti);
597
598         // If there are multiple arms, make sure they all agree on
599         // what the type of the binding `x` ought to be.
600         if var_id != pat.hir_id {
601             self.check_binding_alt_eq_ty(ba, pat.span, var_id, local_ty, ti);
602         }
603
604         if let Some(p) = sub {
605             self.check_pat(p, expected, def_bm, ti);
606         }
607
608         local_ty
609     }
610
611     fn check_binding_alt_eq_ty(
612         &self,
613         ba: hir::BindingAnnotation,
614         span: Span,
615         var_id: HirId,
616         ty: Ty<'tcx>,
617         ti: TopInfo<'tcx>,
618     ) {
619         let var_ty = self.local_ty(span, var_id).decl_ty;
620         if let Some(mut err) = self.demand_eqtype_pat_diag(span, var_ty, ty, ti) {
621             let hir = self.tcx.hir();
622             let var_ty = self.resolve_vars_with_obligations(var_ty);
623             let msg = format!("first introduced with type `{var_ty}` here");
624             err.span_label(hir.span(var_id), msg);
625             let in_match = hir.parent_iter(var_id).any(|(_, n)| {
626                 matches!(
627                     n,
628                     hir::Node::Expr(hir::Expr {
629                         kind: hir::ExprKind::Match(.., hir::MatchSource::Normal),
630                         ..
631                     })
632                 )
633             });
634             let pre = if in_match { "in the same arm, " } else { "" };
635             err.note(&format!("{}a binding must have the same type in all alternatives", pre));
636             self.suggest_adding_missing_ref_or_removing_ref(
637                 &mut err,
638                 span,
639                 var_ty,
640                 self.resolve_vars_with_obligations(ty),
641                 ba,
642             );
643             err.emit();
644         }
645     }
646
647     fn suggest_adding_missing_ref_or_removing_ref(
648         &self,
649         err: &mut Diagnostic,
650         span: Span,
651         expected: Ty<'tcx>,
652         actual: Ty<'tcx>,
653         ba: hir::BindingAnnotation,
654     ) {
655         match (expected.kind(), actual.kind(), ba) {
656             (ty::Ref(_, inner_ty, _), _, hir::BindingAnnotation::NONE)
657                 if self.can_eq(self.param_env, *inner_ty, actual).is_ok() =>
658             {
659                 err.span_suggestion_verbose(
660                     span.shrink_to_lo(),
661                     "consider adding `ref`",
662                     "ref ",
663                     Applicability::MaybeIncorrect,
664                 );
665             }
666             (_, ty::Ref(_, inner_ty, _), hir::BindingAnnotation::REF)
667                 if self.can_eq(self.param_env, expected, *inner_ty).is_ok() =>
668             {
669                 err.span_suggestion_verbose(
670                     span.with_hi(span.lo() + BytePos(4)),
671                     "consider removing `ref`",
672                     "",
673                     Applicability::MaybeIncorrect,
674                 );
675             }
676             _ => (),
677         }
678     }
679
680     // Precondition: pat is a Ref(_) pattern
681     fn borrow_pat_suggestion(&self, err: &mut Diagnostic, pat: &Pat<'_>) {
682         let tcx = self.tcx;
683         if let PatKind::Ref(inner, mutbl) = pat.kind
684         && let PatKind::Binding(_, _, binding, ..) = inner.kind {
685             let binding_parent_id = tcx.hir().get_parent_node(pat.hir_id);
686             let binding_parent = tcx.hir().get(binding_parent_id);
687             debug!(?inner, ?pat, ?binding_parent);
688
689             let mutability = match mutbl {
690                 ast::Mutability::Mut => "mut",
691                 ast::Mutability::Not => "",
692             };
693
694             let mut_var_suggestion = 'block: {
695                 if !matches!(mutbl, ast::Mutability::Mut) {
696                     break 'block None;
697                 }
698
699                 let ident_kind = match binding_parent {
700                     hir::Node::Param(_) => "parameter",
701                     hir::Node::Local(_) => "variable",
702                     hir::Node::Arm(_) => "binding",
703
704                     // Provide diagnostics only if the parent pattern is struct-like,
705                     // i.e. where `mut binding` makes sense
706                     hir::Node::Pat(Pat { kind, .. }) => match kind {
707                         PatKind::Struct(..)
708                         | PatKind::TupleStruct(..)
709                         | PatKind::Or(..)
710                         | PatKind::Tuple(..)
711                         | PatKind::Slice(..) => "binding",
712
713                         PatKind::Wild
714                         | PatKind::Binding(..)
715                         | PatKind::Path(..)
716                         | PatKind::Box(..)
717                         | PatKind::Ref(..)
718                         | PatKind::Lit(..)
719                         | PatKind::Range(..) => break 'block None,
720                     },
721
722                     // Don't provide suggestions in other cases
723                     _ => break 'block None,
724                 };
725
726                 Some((
727                     pat.span,
728                     format!("to declare a mutable {ident_kind} use"),
729                     format!("mut {binding}"),
730                 ))
731
732             };
733
734             match binding_parent {
735                 // Check that there is explicit type (ie this is not a closure param with inferred type)
736                 // so we don't suggest moving something to the type that does not exist
737                 hir::Node::Param(hir::Param { ty_span, .. }) if binding.span != *ty_span => {
738                     err.multipart_suggestion_verbose(
739                         format!("to take parameter `{binding}` by reference, move `&{mutability}` to the type"),
740                         vec![
741                             (pat.span.until(inner.span), "".to_owned()),
742                             (ty_span.shrink_to_lo(), format!("&{}", mutbl.prefix_str())),
743                         ],
744                         Applicability::MachineApplicable
745                     );
746
747                     if let Some((sp, msg, sugg)) = mut_var_suggestion {
748                         err.span_note(sp, format!("{msg}: `{sugg}`"));
749                     }
750                 }
751                 hir::Node::Param(_) | hir::Node::Arm(_) | hir::Node::Pat(_) => {
752                     // rely on match ergonomics or it might be nested `&&pat`
753                     err.span_suggestion_verbose(
754                         pat.span.until(inner.span),
755                         format!("consider removing `&{mutability}` from the pattern"),
756                         "",
757                         Applicability::MaybeIncorrect,
758                     );
759
760                     if let Some((sp, msg, sugg)) = mut_var_suggestion {
761                         err.span_note(sp, format!("{msg}: `{sugg}`"));
762                     }
763                 }
764                 _ if let Some((sp, msg, sugg)) = mut_var_suggestion => {
765                     err.span_suggestion(sp, msg, sugg, Applicability::MachineApplicable);
766                 }
767                 _ => {} // don't provide suggestions in other cases #55175
768             }
769         }
770     }
771
772     pub fn check_dereferenceable(&self, span: Span, expected: Ty<'tcx>, inner: &Pat<'_>) -> bool {
773         if let PatKind::Binding(..) = inner.kind
774             && let Some(mt) = self.shallow_resolve(expected).builtin_deref(true)
775             && let ty::Dynamic(..) = mt.ty.kind()
776         {
777                     // This is "x = SomeTrait" being reduced from
778                     // "let &x = &SomeTrait" or "let box x = Box<SomeTrait>", an error.
779                     let type_str = self.ty_to_string(expected);
780                     let mut err = struct_span_err!(
781                         self.tcx.sess,
782                         span,
783                         E0033,
784                         "type `{}` cannot be dereferenced",
785                         type_str
786                     );
787                     err.span_label(span, format!("type `{type_str}` cannot be dereferenced"));
788                     if self.tcx.sess.teach(&err.get_code().unwrap()) {
789                         err.note(CANNOT_IMPLICITLY_DEREF_POINTER_TRAIT_OBJ);
790                     }
791                     err.emit();
792                     return false;
793                 }
794         true
795     }
796
797     fn check_pat_struct(
798         &self,
799         pat: &'tcx Pat<'tcx>,
800         qpath: &hir::QPath<'_>,
801         fields: &'tcx [hir::PatField<'tcx>],
802         has_rest_pat: bool,
803         expected: Ty<'tcx>,
804         def_bm: BindingMode,
805         ti: TopInfo<'tcx>,
806     ) -> Ty<'tcx> {
807         // Resolve the path and check the definition for errors.
808         let Some((variant, pat_ty)) = self.check_struct_path(qpath, pat.hir_id) else {
809             let err = self.tcx.ty_error();
810             for field in fields {
811                 let ti = ti;
812                 self.check_pat(field.pat, err, def_bm, ti);
813             }
814             return err;
815         };
816
817         // Type-check the path.
818         self.demand_eqtype_pat(pat.span, expected, pat_ty, ti);
819
820         // Type-check subpatterns.
821         if self.check_struct_pat_fields(pat_ty, &pat, variant, fields, has_rest_pat, def_bm, ti) {
822             pat_ty
823         } else {
824             self.tcx.ty_error()
825         }
826     }
827
828     fn check_pat_path(
829         &self,
830         pat: &Pat<'tcx>,
831         qpath: &hir::QPath<'_>,
832         path_resolution: (Res, Option<Ty<'tcx>>, &'tcx [hir::PathSegment<'tcx>]),
833         expected: Ty<'tcx>,
834         ti: TopInfo<'tcx>,
835     ) -> Ty<'tcx> {
836         let tcx = self.tcx;
837
838         // We have already resolved the path.
839         let (res, opt_ty, segments) = path_resolution;
840         match res {
841             Res::Err => {
842                 let e = tcx.sess.delay_span_bug(qpath.span(), "`Res::Err` but no error emitted");
843                 self.set_tainted_by_errors(e);
844                 return tcx.ty_error_with_guaranteed(e);
845             }
846             Res::Def(DefKind::AssocFn | DefKind::Ctor(_, CtorKind::Fictive | CtorKind::Fn), _) => {
847                 let e = report_unexpected_variant_res(tcx, res, qpath, pat.span);
848                 return tcx.ty_error_with_guaranteed(e);
849             }
850             Res::SelfCtor(..)
851             | Res::Def(
852                 DefKind::Ctor(_, CtorKind::Const)
853                 | DefKind::Const
854                 | DefKind::AssocConst
855                 | DefKind::ConstParam,
856                 _,
857             ) => {} // OK
858             _ => bug!("unexpected pattern resolution: {:?}", res),
859         }
860
861         // Type-check the path.
862         let (pat_ty, pat_res) =
863             self.instantiate_value_path(segments, opt_ty, res, pat.span, pat.hir_id);
864         if let Some(err) =
865             self.demand_suptype_with_origin(&self.pattern_cause(ti, pat.span), expected, pat_ty)
866         {
867             self.emit_bad_pat_path(err, pat, res, pat_res, pat_ty, segments);
868         }
869         pat_ty
870     }
871
872     fn maybe_suggest_range_literal(
873         &self,
874         e: &mut Diagnostic,
875         opt_def_id: Option<hir::def_id::DefId>,
876         ident: Ident,
877     ) -> bool {
878         match opt_def_id {
879             Some(def_id) => match self.tcx.hir().get_if_local(def_id) {
880                 Some(hir::Node::Item(hir::Item {
881                     kind: hir::ItemKind::Const(_, body_id), ..
882                 })) => match self.tcx.hir().get(body_id.hir_id) {
883                     hir::Node::Expr(expr) => {
884                         if hir::is_range_literal(expr) {
885                             let span = self.tcx.hir().span(body_id.hir_id);
886                             if let Ok(snip) = self.tcx.sess.source_map().span_to_snippet(span) {
887                                 e.span_suggestion_verbose(
888                                     ident.span,
889                                     "you may want to move the range into the match block",
890                                     snip,
891                                     Applicability::MachineApplicable,
892                                 );
893                                 return true;
894                             }
895                         }
896                     }
897                     _ => (),
898                 },
899                 _ => (),
900             },
901             _ => (),
902         }
903         false
904     }
905
906     fn emit_bad_pat_path(
907         &self,
908         mut e: DiagnosticBuilder<'_, ErrorGuaranteed>,
909         pat: &hir::Pat<'tcx>,
910         res: Res,
911         pat_res: Res,
912         pat_ty: Ty<'tcx>,
913         segments: &'tcx [hir::PathSegment<'tcx>],
914     ) {
915         let pat_span = pat.span;
916         if let Some(span) = self.tcx.hir().res_span(pat_res) {
917             e.span_label(span, &format!("{} defined here", res.descr()));
918             if let [hir::PathSegment { ident, .. }] = &*segments {
919                 e.span_label(
920                     pat_span,
921                     &format!(
922                         "`{}` is interpreted as {} {}, not a new binding",
923                         ident,
924                         res.article(),
925                         res.descr(),
926                     ),
927                 );
928                 match self.tcx.hir().get(self.tcx.hir().get_parent_node(pat.hir_id)) {
929                     hir::Node::PatField(..) => {
930                         e.span_suggestion_verbose(
931                             ident.span.shrink_to_hi(),
932                             "bind the struct field to a different name instead",
933                             format!(": other_{}", ident.as_str().to_lowercase()),
934                             Applicability::HasPlaceholders,
935                         );
936                     }
937                     _ => {
938                         let (type_def_id, item_def_id) = match pat_ty.kind() {
939                             Adt(def, _) => match res {
940                                 Res::Def(DefKind::Const, def_id) => (Some(def.did()), Some(def_id)),
941                                 _ => (None, None),
942                             },
943                             _ => (None, None),
944                         };
945
946                         let ranges = &[
947                             self.tcx.lang_items().range_struct(),
948                             self.tcx.lang_items().range_from_struct(),
949                             self.tcx.lang_items().range_to_struct(),
950                             self.tcx.lang_items().range_full_struct(),
951                             self.tcx.lang_items().range_inclusive_struct(),
952                             self.tcx.lang_items().range_to_inclusive_struct(),
953                         ];
954                         if type_def_id != None && ranges.contains(&type_def_id) {
955                             if !self.maybe_suggest_range_literal(&mut e, item_def_id, *ident) {
956                                 let msg = "constants only support matching by type, \
957                                     if you meant to match against a range of values, \
958                                     consider using a range pattern like `min ..= max` in the match block";
959                                 e.note(msg);
960                             }
961                         } else {
962                             let msg = "introduce a new binding instead";
963                             let sugg = format!("other_{}", ident.as_str().to_lowercase());
964                             e.span_suggestion(
965                                 ident.span,
966                                 msg,
967                                 sugg,
968                                 Applicability::HasPlaceholders,
969                             );
970                         }
971                     }
972                 };
973             }
974         }
975         e.emit();
976     }
977
978     fn check_pat_tuple_struct(
979         &self,
980         pat: &'tcx Pat<'tcx>,
981         qpath: &'tcx hir::QPath<'tcx>,
982         subpats: &'tcx [Pat<'tcx>],
983         ddpos: hir::DotDotPos,
984         expected: Ty<'tcx>,
985         def_bm: BindingMode,
986         ti: TopInfo<'tcx>,
987     ) -> Ty<'tcx> {
988         let tcx = self.tcx;
989         let on_error = |e| {
990             for pat in subpats {
991                 self.check_pat(pat, tcx.ty_error_with_guaranteed(e), def_bm, ti);
992             }
993         };
994         let report_unexpected_res = |res: Res| {
995             let sm = tcx.sess.source_map();
996             let path_str = sm
997                 .span_to_snippet(sm.span_until_char(pat.span, '('))
998                 .map_or_else(|_| String::new(), |s| format!(" `{}`", s.trim_end()));
999             let msg = format!(
1000                 "expected tuple struct or tuple variant, found {}{}",
1001                 res.descr(),
1002                 path_str
1003             );
1004
1005             let mut err = struct_span_err!(tcx.sess, pat.span, E0164, "{msg}");
1006             match res {
1007                 Res::Def(DefKind::Fn | DefKind::AssocFn, _) => {
1008                     err.span_label(pat.span, "`fn` calls are not allowed in patterns");
1009                     err.help(
1010                         "for more information, visit \
1011                               https://doc.rust-lang.org/book/ch18-00-patterns.html",
1012                     );
1013                 }
1014                 _ => {
1015                     err.span_label(pat.span, "not a tuple variant or struct");
1016                 }
1017             }
1018             let e = err.emit();
1019             on_error(e);
1020             e
1021         };
1022
1023         // Resolve the path and check the definition for errors.
1024         let (res, opt_ty, segments) =
1025             self.resolve_ty_and_res_fully_qualified_call(qpath, pat.hir_id, pat.span);
1026         if res == Res::Err {
1027             let e = tcx.sess.delay_span_bug(pat.span, "`Res:Err` but no error emitted");
1028             self.set_tainted_by_errors(e);
1029             on_error(e);
1030             return tcx.ty_error_with_guaranteed(e);
1031         }
1032
1033         // Type-check the path.
1034         let (pat_ty, res) =
1035             self.instantiate_value_path(segments, opt_ty, res, pat.span, pat.hir_id);
1036         if !pat_ty.is_fn() {
1037             let e = report_unexpected_res(res);
1038             return tcx.ty_error_with_guaranteed(e);
1039         }
1040
1041         let variant = match res {
1042             Res::Err => {
1043                 let e = tcx.sess.delay_span_bug(pat.span, "`Res::Err` but no error emitted");
1044                 self.set_tainted_by_errors(e);
1045                 on_error(e);
1046                 return tcx.ty_error_with_guaranteed(e);
1047             }
1048             Res::Def(DefKind::AssocConst | DefKind::AssocFn, _) => {
1049                 let e = report_unexpected_res(res);
1050                 return tcx.ty_error_with_guaranteed(e);
1051             }
1052             Res::Def(DefKind::Ctor(_, CtorKind::Fn), _) => tcx.expect_variant_res(res),
1053             _ => bug!("unexpected pattern resolution: {:?}", res),
1054         };
1055
1056         // Replace constructor type with constructed type for tuple struct patterns.
1057         let pat_ty = pat_ty.fn_sig(tcx).output();
1058         let pat_ty = pat_ty.no_bound_vars().expect("expected fn type");
1059
1060         // Type-check the tuple struct pattern against the expected type.
1061         let diag = self.demand_eqtype_pat_diag(pat.span, expected, pat_ty, ti);
1062         let had_err = if let Some(mut err) = diag {
1063             err.emit();
1064             true
1065         } else {
1066             false
1067         };
1068
1069         // Type-check subpatterns.
1070         if subpats.len() == variant.fields.len()
1071             || subpats.len() < variant.fields.len() && ddpos.as_opt_usize().is_some()
1072         {
1073             let ty::Adt(_, substs) = pat_ty.kind() else {
1074                 bug!("unexpected pattern type {:?}", pat_ty);
1075             };
1076             for (i, subpat) in subpats.iter().enumerate_and_adjust(variant.fields.len(), ddpos) {
1077                 let field_ty = self.field_ty(subpat.span, &variant.fields[i], substs);
1078                 self.check_pat(subpat, field_ty, def_bm, ti);
1079
1080                 self.tcx.check_stability(
1081                     variant.fields[i].did,
1082                     Some(pat.hir_id),
1083                     subpat.span,
1084                     None,
1085                 );
1086             }
1087         } else {
1088             // Pattern has wrong number of fields.
1089             let e = self.e0023(pat.span, res, qpath, subpats, &variant.fields, expected, had_err);
1090             on_error(e);
1091             return tcx.ty_error_with_guaranteed(e);
1092         }
1093         pat_ty
1094     }
1095
1096     fn e0023(
1097         &self,
1098         pat_span: Span,
1099         res: Res,
1100         qpath: &hir::QPath<'_>,
1101         subpats: &'tcx [Pat<'tcx>],
1102         fields: &'tcx [ty::FieldDef],
1103         expected: Ty<'tcx>,
1104         had_err: bool,
1105     ) -> ErrorGuaranteed {
1106         let subpats_ending = pluralize!(subpats.len());
1107         let fields_ending = pluralize!(fields.len());
1108
1109         let subpat_spans = if subpats.is_empty() {
1110             vec![pat_span]
1111         } else {
1112             subpats.iter().map(|p| p.span).collect()
1113         };
1114         let last_subpat_span = *subpat_spans.last().unwrap();
1115         let res_span = self.tcx.def_span(res.def_id());
1116         let def_ident_span = self.tcx.def_ident_span(res.def_id()).unwrap_or(res_span);
1117         let field_def_spans = if fields.is_empty() {
1118             vec![res_span]
1119         } else {
1120             fields.iter().map(|f| f.ident(self.tcx).span).collect()
1121         };
1122         let last_field_def_span = *field_def_spans.last().unwrap();
1123
1124         let mut err = struct_span_err!(
1125             self.tcx.sess,
1126             MultiSpan::from_spans(subpat_spans),
1127             E0023,
1128             "this pattern has {} field{}, but the corresponding {} has {} field{}",
1129             subpats.len(),
1130             subpats_ending,
1131             res.descr(),
1132             fields.len(),
1133             fields_ending,
1134         );
1135         err.span_label(
1136             last_subpat_span,
1137             &format!("expected {} field{}, found {}", fields.len(), fields_ending, subpats.len()),
1138         );
1139         if self.tcx.sess.source_map().is_multiline(qpath.span().between(last_subpat_span)) {
1140             err.span_label(qpath.span(), "");
1141         }
1142         if self.tcx.sess.source_map().is_multiline(def_ident_span.between(last_field_def_span)) {
1143             err.span_label(def_ident_span, format!("{} defined here", res.descr()));
1144         }
1145         for span in &field_def_spans[..field_def_spans.len() - 1] {
1146             err.span_label(*span, "");
1147         }
1148         err.span_label(
1149             last_field_def_span,
1150             &format!("{} has {} field{}", res.descr(), fields.len(), fields_ending),
1151         );
1152
1153         // Identify the case `Some(x, y)` where the expected type is e.g. `Option<(T, U)>`.
1154         // More generally, the expected type wants a tuple variant with one field of an
1155         // N-arity-tuple, e.g., `V_i((p_0, .., p_N))`. Meanwhile, the user supplied a pattern
1156         // with the subpatterns directly in the tuple variant pattern, e.g., `V_i(p_0, .., p_N)`.
1157         let missing_parentheses = match (&expected.kind(), fields, had_err) {
1158             // #67037: only do this if we could successfully type-check the expected type against
1159             // the tuple struct pattern. Otherwise the substs could get out of range on e.g.,
1160             // `let P() = U;` where `P != U` with `struct P<T>(T);`.
1161             (ty::Adt(_, substs), [field], false) => {
1162                 let field_ty = self.field_ty(pat_span, field, substs);
1163                 match field_ty.kind() {
1164                     ty::Tuple(fields) => fields.len() == subpats.len(),
1165                     _ => false,
1166                 }
1167             }
1168             _ => false,
1169         };
1170         if missing_parentheses {
1171             let (left, right) = match subpats {
1172                 // This is the zero case; we aim to get the "hi" part of the `QPath`'s
1173                 // span as the "lo" and then the "hi" part of the pattern's span as the "hi".
1174                 // This looks like:
1175                 //
1176                 // help: missing parentheses
1177                 //   |
1178                 // L |     let A(()) = A(());
1179                 //   |          ^  ^
1180                 [] => (qpath.span().shrink_to_hi(), pat_span),
1181                 // Easy case. Just take the "lo" of the first sub-pattern and the "hi" of the
1182                 // last sub-pattern. In the case of `A(x)` the first and last may coincide.
1183                 // This looks like:
1184                 //
1185                 // help: missing parentheses
1186                 //   |
1187                 // L |     let A((x, y)) = A((1, 2));
1188                 //   |           ^    ^
1189                 [first, ..] => (first.span.shrink_to_lo(), subpats.last().unwrap().span),
1190             };
1191             err.multipart_suggestion(
1192                 "missing parentheses",
1193                 vec![(left, "(".to_string()), (right.shrink_to_hi(), ")".to_string())],
1194                 Applicability::MachineApplicable,
1195             );
1196         } else if fields.len() > subpats.len() && pat_span != DUMMY_SP {
1197             let after_fields_span = pat_span.with_hi(pat_span.hi() - BytePos(1)).shrink_to_hi();
1198             let all_fields_span = match subpats {
1199                 [] => after_fields_span,
1200                 [field] => field.span,
1201                 [first, .., last] => first.span.to(last.span),
1202             };
1203
1204             // Check if all the fields in the pattern are wildcards.
1205             let all_wildcards = subpats.iter().all(|pat| matches!(pat.kind, PatKind::Wild));
1206             let first_tail_wildcard =
1207                 subpats.iter().enumerate().fold(None, |acc, (pos, pat)| match (acc, &pat.kind) {
1208                     (None, PatKind::Wild) => Some(pos),
1209                     (Some(_), PatKind::Wild) => acc,
1210                     _ => None,
1211                 });
1212             let tail_span = match first_tail_wildcard {
1213                 None => after_fields_span,
1214                 Some(0) => subpats[0].span.to(after_fields_span),
1215                 Some(pos) => subpats[pos - 1].span.shrink_to_hi().to(after_fields_span),
1216             };
1217
1218             // FIXME: heuristic-based suggestion to check current types for where to add `_`.
1219             let mut wildcard_sugg = vec!["_"; fields.len() - subpats.len()].join(", ");
1220             if !subpats.is_empty() {
1221                 wildcard_sugg = String::from(", ") + &wildcard_sugg;
1222             }
1223
1224             err.span_suggestion_verbose(
1225                 after_fields_span,
1226                 "use `_` to explicitly ignore each field",
1227                 wildcard_sugg,
1228                 Applicability::MaybeIncorrect,
1229             );
1230
1231             // Only suggest `..` if more than one field is missing
1232             // or the pattern consists of all wildcards.
1233             if fields.len() - subpats.len() > 1 || all_wildcards {
1234                 if subpats.is_empty() || all_wildcards {
1235                     err.span_suggestion_verbose(
1236                         all_fields_span,
1237                         "use `..` to ignore all fields",
1238                         "..",
1239                         Applicability::MaybeIncorrect,
1240                     );
1241                 } else {
1242                     err.span_suggestion_verbose(
1243                         tail_span,
1244                         "use `..` to ignore the rest of the fields",
1245                         ", ..",
1246                         Applicability::MaybeIncorrect,
1247                     );
1248                 }
1249             }
1250         }
1251
1252         err.emit()
1253     }
1254
1255     fn check_pat_tuple(
1256         &self,
1257         span: Span,
1258         elements: &'tcx [Pat<'tcx>],
1259         ddpos: hir::DotDotPos,
1260         expected: Ty<'tcx>,
1261         def_bm: BindingMode,
1262         ti: TopInfo<'tcx>,
1263     ) -> Ty<'tcx> {
1264         let tcx = self.tcx;
1265         let mut expected_len = elements.len();
1266         if ddpos.as_opt_usize().is_some() {
1267             // Require known type only when `..` is present.
1268             if let ty::Tuple(tys) = self.structurally_resolved_type(span, expected).kind() {
1269                 expected_len = tys.len();
1270             }
1271         }
1272         let max_len = cmp::max(expected_len, elements.len());
1273
1274         let element_tys_iter = (0..max_len).map(|_| {
1275             self.next_ty_var(
1276                 // FIXME: `MiscVariable` for now -- obtaining the span and name information
1277                 // from all tuple elements isn't trivial.
1278                 TypeVariableOrigin { kind: TypeVariableOriginKind::TypeInference, span },
1279             )
1280         });
1281         let element_tys = tcx.mk_type_list(element_tys_iter);
1282         let pat_ty = tcx.mk_ty(ty::Tuple(element_tys));
1283         if let Some(mut err) = self.demand_eqtype_pat_diag(span, expected, pat_ty, ti) {
1284             let reported = err.emit();
1285             // Walk subpatterns with an expected type of `err` in this case to silence
1286             // further errors being emitted when using the bindings. #50333
1287             let element_tys_iter = (0..max_len).map(|_| tcx.ty_error_with_guaranteed(reported));
1288             for (_, elem) in elements.iter().enumerate_and_adjust(max_len, ddpos) {
1289                 self.check_pat(elem, tcx.ty_error_with_guaranteed(reported), def_bm, ti);
1290             }
1291             tcx.mk_tup(element_tys_iter)
1292         } else {
1293             for (i, elem) in elements.iter().enumerate_and_adjust(max_len, ddpos) {
1294                 self.check_pat(elem, element_tys[i], def_bm, ti);
1295             }
1296             pat_ty
1297         }
1298     }
1299
1300     fn check_struct_pat_fields(
1301         &self,
1302         adt_ty: Ty<'tcx>,
1303         pat: &'tcx Pat<'tcx>,
1304         variant: &'tcx ty::VariantDef,
1305         fields: &'tcx [hir::PatField<'tcx>],
1306         has_rest_pat: bool,
1307         def_bm: BindingMode,
1308         ti: TopInfo<'tcx>,
1309     ) -> bool {
1310         let tcx = self.tcx;
1311
1312         let ty::Adt(adt, substs) = adt_ty.kind() else {
1313             span_bug!(pat.span, "struct pattern is not an ADT");
1314         };
1315
1316         // Index the struct fields' types.
1317         let field_map = variant
1318             .fields
1319             .iter()
1320             .enumerate()
1321             .map(|(i, field)| (field.ident(self.tcx).normalize_to_macros_2_0(), (i, field)))
1322             .collect::<FxHashMap<_, _>>();
1323
1324         // Keep track of which fields have already appeared in the pattern.
1325         let mut used_fields = FxHashMap::default();
1326         let mut no_field_errors = true;
1327
1328         let mut inexistent_fields = vec![];
1329         // Typecheck each field.
1330         for field in fields {
1331             let span = field.span;
1332             let ident = tcx.adjust_ident(field.ident, variant.def_id);
1333             let field_ty = match used_fields.entry(ident) {
1334                 Occupied(occupied) => {
1335                     self.error_field_already_bound(span, field.ident, *occupied.get());
1336                     no_field_errors = false;
1337                     tcx.ty_error()
1338                 }
1339                 Vacant(vacant) => {
1340                     vacant.insert(span);
1341                     field_map
1342                         .get(&ident)
1343                         .map(|(i, f)| {
1344                             self.write_field_index(field.hir_id, *i);
1345                             self.tcx.check_stability(f.did, Some(pat.hir_id), span, None);
1346                             self.field_ty(span, f, substs)
1347                         })
1348                         .unwrap_or_else(|| {
1349                             inexistent_fields.push(field);
1350                             no_field_errors = false;
1351                             tcx.ty_error()
1352                         })
1353                 }
1354             };
1355
1356             self.check_pat(field.pat, field_ty, def_bm, ti);
1357         }
1358
1359         let mut unmentioned_fields = variant
1360             .fields
1361             .iter()
1362             .map(|field| (field, field.ident(self.tcx).normalize_to_macros_2_0()))
1363             .filter(|(_, ident)| !used_fields.contains_key(ident))
1364             .collect::<Vec<_>>();
1365
1366         let inexistent_fields_err = if !(inexistent_fields.is_empty() || variant.is_recovered())
1367             && !inexistent_fields.iter().any(|field| field.ident.name == kw::Underscore)
1368         {
1369             Some(self.error_inexistent_fields(
1370                 adt.variant_descr(),
1371                 &inexistent_fields,
1372                 &mut unmentioned_fields,
1373                 variant,
1374                 substs,
1375             ))
1376         } else {
1377             None
1378         };
1379
1380         // Require `..` if struct has non_exhaustive attribute.
1381         let non_exhaustive = variant.is_field_list_non_exhaustive() && !adt.did().is_local();
1382         if non_exhaustive && !has_rest_pat {
1383             self.error_foreign_non_exhaustive_spat(pat, adt.variant_descr(), fields.is_empty());
1384         }
1385
1386         let mut unmentioned_err = None;
1387         // Report an error if an incorrect number of fields was specified.
1388         if adt.is_union() {
1389             if fields.len() != 1 {
1390                 tcx.sess
1391                     .struct_span_err(pat.span, "union patterns should have exactly one field")
1392                     .emit();
1393             }
1394             if has_rest_pat {
1395                 tcx.sess.struct_span_err(pat.span, "`..` cannot be used in union patterns").emit();
1396             }
1397         } else if !unmentioned_fields.is_empty() {
1398             let accessible_unmentioned_fields: Vec<_> = unmentioned_fields
1399                 .iter()
1400                 .copied()
1401                 .filter(|(field, _)| {
1402                     field.vis.is_accessible_from(tcx.parent_module(pat.hir_id), tcx)
1403                         && !matches!(
1404                             tcx.eval_stability(field.did, None, DUMMY_SP, None),
1405                             EvalResult::Deny { .. }
1406                         )
1407                         // We only want to report the error if it is hidden and not local
1408                         && !(tcx.is_doc_hidden(field.did) && !field.did.is_local())
1409                 })
1410                 .collect();
1411
1412             if !has_rest_pat {
1413                 if accessible_unmentioned_fields.is_empty() {
1414                     unmentioned_err = Some(self.error_no_accessible_fields(pat, fields));
1415                 } else {
1416                     unmentioned_err = Some(self.error_unmentioned_fields(
1417                         pat,
1418                         &accessible_unmentioned_fields,
1419                         accessible_unmentioned_fields.len() != unmentioned_fields.len(),
1420                         fields,
1421                     ));
1422                 }
1423             } else if non_exhaustive && !accessible_unmentioned_fields.is_empty() {
1424                 self.lint_non_exhaustive_omitted_patterns(
1425                     pat,
1426                     &accessible_unmentioned_fields,
1427                     adt_ty,
1428                 )
1429             }
1430         }
1431         match (inexistent_fields_err, unmentioned_err) {
1432             (Some(mut i), Some(mut u)) => {
1433                 if let Some(mut e) = self.error_tuple_variant_as_struct_pat(pat, fields, variant) {
1434                     // We don't want to show the nonexistent fields error when this was
1435                     // `Foo { a, b }` when it should have been `Foo(a, b)`.
1436                     i.delay_as_bug();
1437                     u.delay_as_bug();
1438                     e.emit();
1439                 } else {
1440                     i.emit();
1441                     u.emit();
1442                 }
1443             }
1444             (None, Some(mut u)) => {
1445                 if let Some(mut e) = self.error_tuple_variant_as_struct_pat(pat, fields, variant) {
1446                     u.delay_as_bug();
1447                     e.emit();
1448                 } else {
1449                     u.emit();
1450                 }
1451             }
1452             (Some(mut err), None) => {
1453                 err.emit();
1454             }
1455             (None, None) if let Some(mut err) =
1456                     self.error_tuple_variant_index_shorthand(variant, pat, fields) =>
1457             {
1458                 err.emit();
1459             }
1460             (None, None) => {}
1461         }
1462         no_field_errors
1463     }
1464
1465     fn error_tuple_variant_index_shorthand(
1466         &self,
1467         variant: &VariantDef,
1468         pat: &'_ Pat<'_>,
1469         fields: &[hir::PatField<'_>],
1470     ) -> Option<DiagnosticBuilder<'_, ErrorGuaranteed>> {
1471         // if this is a tuple struct, then all field names will be numbers
1472         // so if any fields in a struct pattern use shorthand syntax, they will
1473         // be invalid identifiers (for example, Foo { 0, 1 }).
1474         if let (CtorKind::Fn, PatKind::Struct(qpath, field_patterns, ..)) =
1475             (variant.ctor_kind, &pat.kind)
1476         {
1477             let has_shorthand_field_name = field_patterns.iter().any(|field| field.is_shorthand);
1478             if has_shorthand_field_name {
1479                 let path = rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| {
1480                     s.print_qpath(qpath, false)
1481                 });
1482                 let mut err = struct_span_err!(
1483                     self.tcx.sess,
1484                     pat.span,
1485                     E0769,
1486                     "tuple variant `{path}` written as struct variant",
1487                 );
1488                 err.span_suggestion_verbose(
1489                     qpath.span().shrink_to_hi().to(pat.span.shrink_to_hi()),
1490                     "use the tuple variant pattern syntax instead",
1491                     format!("({})", self.get_suggested_tuple_struct_pattern(fields, variant)),
1492                     Applicability::MaybeIncorrect,
1493                 );
1494                 return Some(err);
1495             }
1496         }
1497         None
1498     }
1499
1500     fn error_foreign_non_exhaustive_spat(&self, pat: &Pat<'_>, descr: &str, no_fields: bool) {
1501         let sess = self.tcx.sess;
1502         let sm = sess.source_map();
1503         let sp_brace = sm.end_point(pat.span);
1504         let sp_comma = sm.end_point(pat.span.with_hi(sp_brace.hi()));
1505         let sugg = if no_fields || sp_brace != sp_comma { ".. }" } else { ", .. }" };
1506
1507         let mut err = struct_span_err!(
1508             sess,
1509             pat.span,
1510             E0638,
1511             "`..` required with {descr} marked as non-exhaustive",
1512         );
1513         err.span_suggestion_verbose(
1514             sp_comma,
1515             "add `..` at the end of the field list to ignore all other fields",
1516             sugg,
1517             Applicability::MachineApplicable,
1518         );
1519         err.emit();
1520     }
1521
1522     fn error_field_already_bound(&self, span: Span, ident: Ident, other_field: Span) {
1523         struct_span_err!(
1524             self.tcx.sess,
1525             span,
1526             E0025,
1527             "field `{}` bound multiple times in the pattern",
1528             ident
1529         )
1530         .span_label(span, format!("multiple uses of `{ident}` in pattern"))
1531         .span_label(other_field, format!("first use of `{ident}`"))
1532         .emit();
1533     }
1534
1535     fn error_inexistent_fields(
1536         &self,
1537         kind_name: &str,
1538         inexistent_fields: &[&hir::PatField<'tcx>],
1539         unmentioned_fields: &mut Vec<(&'tcx ty::FieldDef, Ident)>,
1540         variant: &ty::VariantDef,
1541         substs: &'tcx ty::List<ty::subst::GenericArg<'tcx>>,
1542     ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
1543         let tcx = self.tcx;
1544         let (field_names, t, plural) = if inexistent_fields.len() == 1 {
1545             (format!("a field named `{}`", inexistent_fields[0].ident), "this", "")
1546         } else {
1547             (
1548                 format!(
1549                     "fields named {}",
1550                     inexistent_fields
1551                         .iter()
1552                         .map(|field| format!("`{}`", field.ident))
1553                         .collect::<Vec<String>>()
1554                         .join(", ")
1555                 ),
1556                 "these",
1557                 "s",
1558             )
1559         };
1560         let spans = inexistent_fields.iter().map(|field| field.ident.span).collect::<Vec<_>>();
1561         let mut err = struct_span_err!(
1562             tcx.sess,
1563             spans,
1564             E0026,
1565             "{} `{}` does not have {}",
1566             kind_name,
1567             tcx.def_path_str(variant.def_id),
1568             field_names
1569         );
1570         if let Some(pat_field) = inexistent_fields.last() {
1571             err.span_label(
1572                 pat_field.ident.span,
1573                 format!(
1574                     "{} `{}` does not have {} field{}",
1575                     kind_name,
1576                     tcx.def_path_str(variant.def_id),
1577                     t,
1578                     plural
1579                 ),
1580             );
1581
1582             if unmentioned_fields.len() == 1 {
1583                 let input =
1584                     unmentioned_fields.iter().map(|(_, field)| field.name).collect::<Vec<_>>();
1585                 let suggested_name = find_best_match_for_name(&input, pat_field.ident.name, None);
1586                 if let Some(suggested_name) = suggested_name {
1587                     err.span_suggestion(
1588                         pat_field.ident.span,
1589                         "a field with a similar name exists",
1590                         suggested_name,
1591                         Applicability::MaybeIncorrect,
1592                     );
1593
1594                     // When we have a tuple struct used with struct we don't want to suggest using
1595                     // the (valid) struct syntax with numeric field names. Instead we want to
1596                     // suggest the expected syntax. We infer that this is the case by parsing the
1597                     // `Ident` into an unsized integer. The suggestion will be emitted elsewhere in
1598                     // `smart_resolve_context_dependent_help`.
1599                     if suggested_name.to_ident_string().parse::<usize>().is_err() {
1600                         // We don't want to throw `E0027` in case we have thrown `E0026` for them.
1601                         unmentioned_fields.retain(|&(_, x)| x.name != suggested_name);
1602                     }
1603                 } else if inexistent_fields.len() == 1 {
1604                     match pat_field.pat.kind {
1605                         PatKind::Lit(expr)
1606                             if !self.can_coerce(
1607                                 self.typeck_results.borrow().expr_ty(expr),
1608                                 self.field_ty(
1609                                     unmentioned_fields[0].1.span,
1610                                     unmentioned_fields[0].0,
1611                                     substs,
1612                                 ),
1613                             ) => {}
1614                         _ => {
1615                             let unmentioned_field = unmentioned_fields[0].1.name;
1616                             err.span_suggestion_short(
1617                                 pat_field.ident.span,
1618                                 &format!(
1619                                     "`{}` has a field named `{}`",
1620                                     tcx.def_path_str(variant.def_id),
1621                                     unmentioned_field
1622                                 ),
1623                                 unmentioned_field.to_string(),
1624                                 Applicability::MaybeIncorrect,
1625                             );
1626                         }
1627                     }
1628                 }
1629             }
1630         }
1631         if tcx.sess.teach(&err.get_code().unwrap()) {
1632             err.note(
1633                 "This error indicates that a struct pattern attempted to \
1634                  extract a non-existent field from a struct. Struct fields \
1635                  are identified by the name used before the colon : so struct \
1636                  patterns should resemble the declaration of the struct type \
1637                  being matched.\n\n\
1638                  If you are using shorthand field patterns but want to refer \
1639                  to the struct field by a different name, you should rename \
1640                  it explicitly.",
1641             );
1642         }
1643         err
1644     }
1645
1646     fn error_tuple_variant_as_struct_pat(
1647         &self,
1648         pat: &Pat<'_>,
1649         fields: &'tcx [hir::PatField<'tcx>],
1650         variant: &ty::VariantDef,
1651     ) -> Option<DiagnosticBuilder<'tcx, ErrorGuaranteed>> {
1652         if let (CtorKind::Fn, PatKind::Struct(qpath, ..)) = (variant.ctor_kind, &pat.kind) {
1653             let path = rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| {
1654                 s.print_qpath(qpath, false)
1655             });
1656             let mut err = struct_span_err!(
1657                 self.tcx.sess,
1658                 pat.span,
1659                 E0769,
1660                 "tuple variant `{}` written as struct variant",
1661                 path
1662             );
1663             let (sugg, appl) = if fields.len() == variant.fields.len() {
1664                 (
1665                     self.get_suggested_tuple_struct_pattern(fields, variant),
1666                     Applicability::MachineApplicable,
1667                 )
1668             } else {
1669                 (
1670                     variant.fields.iter().map(|_| "_").collect::<Vec<&str>>().join(", "),
1671                     Applicability::MaybeIncorrect,
1672                 )
1673             };
1674             err.span_suggestion_verbose(
1675                 qpath.span().shrink_to_hi().to(pat.span.shrink_to_hi()),
1676                 "use the tuple variant pattern syntax instead",
1677                 format!("({})", sugg),
1678                 appl,
1679             );
1680             return Some(err);
1681         }
1682         None
1683     }
1684
1685     fn get_suggested_tuple_struct_pattern(
1686         &self,
1687         fields: &[hir::PatField<'_>],
1688         variant: &VariantDef,
1689     ) -> String {
1690         let variant_field_idents =
1691             variant.fields.iter().map(|f| f.ident(self.tcx)).collect::<Vec<Ident>>();
1692         fields
1693             .iter()
1694             .map(|field| {
1695                 match self.tcx.sess.source_map().span_to_snippet(field.pat.span) {
1696                     Ok(f) => {
1697                         // Field names are numbers, but numbers
1698                         // are not valid identifiers
1699                         if variant_field_idents.contains(&field.ident) {
1700                             String::from("_")
1701                         } else {
1702                             f
1703                         }
1704                     }
1705                     Err(_) => rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| {
1706                         s.print_pat(field.pat)
1707                     }),
1708                 }
1709             })
1710             .collect::<Vec<String>>()
1711             .join(", ")
1712     }
1713
1714     /// Returns a diagnostic reporting a struct pattern which is missing an `..` due to
1715     /// inaccessible fields.
1716     ///
1717     /// ```text
1718     /// error: pattern requires `..` due to inaccessible fields
1719     ///   --> src/main.rs:10:9
1720     ///    |
1721     /// LL |     let foo::Foo {} = foo::Foo::default();
1722     ///    |         ^^^^^^^^^^^
1723     ///    |
1724     /// help: add a `..`
1725     ///    |
1726     /// LL |     let foo::Foo { .. } = foo::Foo::default();
1727     ///    |                  ^^^^^^
1728     /// ```
1729     fn error_no_accessible_fields(
1730         &self,
1731         pat: &Pat<'_>,
1732         fields: &'tcx [hir::PatField<'tcx>],
1733     ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
1734         let mut err = self
1735             .tcx
1736             .sess
1737             .struct_span_err(pat.span, "pattern requires `..` due to inaccessible fields");
1738
1739         if let Some(field) = fields.last() {
1740             err.span_suggestion_verbose(
1741                 field.span.shrink_to_hi(),
1742                 "ignore the inaccessible and unused fields",
1743                 ", ..",
1744                 Applicability::MachineApplicable,
1745             );
1746         } else {
1747             let qpath_span = if let PatKind::Struct(qpath, ..) = &pat.kind {
1748                 qpath.span()
1749             } else {
1750                 bug!("`error_no_accessible_fields` called on non-struct pattern");
1751             };
1752
1753             // Shrink the span to exclude the `foo:Foo` in `foo::Foo { }`.
1754             let span = pat.span.with_lo(qpath_span.shrink_to_hi().hi());
1755             err.span_suggestion_verbose(
1756                 span,
1757                 "ignore the inaccessible and unused fields",
1758                 " { .. }",
1759                 Applicability::MachineApplicable,
1760             );
1761         }
1762         err
1763     }
1764
1765     /// Report that a pattern for a `#[non_exhaustive]` struct marked with `non_exhaustive_omitted_patterns`
1766     /// is not exhaustive enough.
1767     ///
1768     /// Nb: the partner lint for enums lives in `compiler/rustc_mir_build/src/thir/pattern/usefulness.rs`.
1769     fn lint_non_exhaustive_omitted_patterns(
1770         &self,
1771         pat: &Pat<'_>,
1772         unmentioned_fields: &[(&ty::FieldDef, Ident)],
1773         ty: Ty<'tcx>,
1774     ) {
1775         fn joined_uncovered_patterns(witnesses: &[&Ident]) -> String {
1776             const LIMIT: usize = 3;
1777             match witnesses {
1778                 [] => bug!(),
1779                 [witness] => format!("`{}`", witness),
1780                 [head @ .., tail] if head.len() < LIMIT => {
1781                     let head: Vec<_> = head.iter().map(<_>::to_string).collect();
1782                     format!("`{}` and `{}`", head.join("`, `"), tail)
1783                 }
1784                 _ => {
1785                     let (head, tail) = witnesses.split_at(LIMIT);
1786                     let head: Vec<_> = head.iter().map(<_>::to_string).collect();
1787                     format!("`{}` and {} more", head.join("`, `"), tail.len())
1788                 }
1789             }
1790         }
1791         let joined_patterns = joined_uncovered_patterns(
1792             &unmentioned_fields.iter().map(|(_, i)| i).collect::<Vec<_>>(),
1793         );
1794
1795         self.tcx.struct_span_lint_hir(NON_EXHAUSTIVE_OMITTED_PATTERNS, pat.hir_id, pat.span, "some fields are not explicitly listed", |lint| {
1796         lint.span_label(pat.span, format!("field{} {} not listed", rustc_errors::pluralize!(unmentioned_fields.len()), joined_patterns));
1797         lint.help(
1798             "ensure that all fields are mentioned explicitly by adding the suggested fields",
1799         );
1800         lint.note(&format!(
1801             "the pattern is of type `{}` and the `non_exhaustive_omitted_patterns` attribute was found",
1802             ty,
1803         ));
1804
1805         lint
1806     });
1807     }
1808
1809     /// Returns a diagnostic reporting a struct pattern which does not mention some fields.
1810     ///
1811     /// ```text
1812     /// error[E0027]: pattern does not mention field `bar`
1813     ///   --> src/main.rs:15:9
1814     ///    |
1815     /// LL |     let foo::Foo {} = foo::Foo::new();
1816     ///    |         ^^^^^^^^^^^ missing field `bar`
1817     /// ```
1818     fn error_unmentioned_fields(
1819         &self,
1820         pat: &Pat<'_>,
1821         unmentioned_fields: &[(&ty::FieldDef, Ident)],
1822         have_inaccessible_fields: bool,
1823         fields: &'tcx [hir::PatField<'tcx>],
1824     ) -> DiagnosticBuilder<'tcx, ErrorGuaranteed> {
1825         let inaccessible = if have_inaccessible_fields { " and inaccessible fields" } else { "" };
1826         let field_names = if unmentioned_fields.len() == 1 {
1827             format!("field `{}`{}", unmentioned_fields[0].1, inaccessible)
1828         } else {
1829             let fields = unmentioned_fields
1830                 .iter()
1831                 .map(|(_, name)| format!("`{}`", name))
1832                 .collect::<Vec<String>>()
1833                 .join(", ");
1834             format!("fields {}{}", fields, inaccessible)
1835         };
1836         let mut err = struct_span_err!(
1837             self.tcx.sess,
1838             pat.span,
1839             E0027,
1840             "pattern does not mention {}",
1841             field_names
1842         );
1843         err.span_label(pat.span, format!("missing {}", field_names));
1844         let len = unmentioned_fields.len();
1845         let (prefix, postfix, sp) = match fields {
1846             [] => match &pat.kind {
1847                 PatKind::Struct(path, [], false) => {
1848                     (" { ", " }", path.span().shrink_to_hi().until(pat.span.shrink_to_hi()))
1849                 }
1850                 _ => return err,
1851             },
1852             [.., field] => {
1853                 // Account for last field having a trailing comma or parse recovery at the tail of
1854                 // the pattern to avoid invalid suggestion (#78511).
1855                 let tail = field.span.shrink_to_hi().with_hi(pat.span.hi());
1856                 match &pat.kind {
1857                     PatKind::Struct(..) => (", ", " }", tail),
1858                     _ => return err,
1859                 }
1860             }
1861         };
1862         err.span_suggestion(
1863             sp,
1864             &format!(
1865                 "include the missing field{} in the pattern{}",
1866                 pluralize!(len),
1867                 if have_inaccessible_fields { " and ignore the inaccessible fields" } else { "" }
1868             ),
1869             format!(
1870                 "{}{}{}{}",
1871                 prefix,
1872                 unmentioned_fields
1873                     .iter()
1874                     .map(|(_, name)| name.to_string())
1875                     .collect::<Vec<_>>()
1876                     .join(", "),
1877                 if have_inaccessible_fields { ", .." } else { "" },
1878                 postfix,
1879             ),
1880             Applicability::MachineApplicable,
1881         );
1882         err.span_suggestion(
1883             sp,
1884             &format!(
1885                 "if you don't care about {these} missing field{s}, you can explicitly ignore {them}",
1886                 these = pluralize!("this", len),
1887                 s = pluralize!(len),
1888                 them = if len == 1 { "it" } else { "them" },
1889             ),
1890             format!("{}..{}", prefix, postfix),
1891             Applicability::MachineApplicable,
1892         );
1893         err
1894     }
1895
1896     fn check_pat_box(
1897         &self,
1898         span: Span,
1899         inner: &'tcx Pat<'tcx>,
1900         expected: Ty<'tcx>,
1901         def_bm: BindingMode,
1902         ti: TopInfo<'tcx>,
1903     ) -> Ty<'tcx> {
1904         let tcx = self.tcx;
1905         let (box_ty, inner_ty) = if self.check_dereferenceable(span, expected, inner) {
1906             // Here, `demand::subtype` is good enough, but I don't
1907             // think any errors can be introduced by using `demand::eqtype`.
1908             let inner_ty = self.next_ty_var(TypeVariableOrigin {
1909                 kind: TypeVariableOriginKind::TypeInference,
1910                 span: inner.span,
1911             });
1912             let box_ty = tcx.mk_box(inner_ty);
1913             self.demand_eqtype_pat(span, expected, box_ty, ti);
1914             (box_ty, inner_ty)
1915         } else {
1916             let err = tcx.ty_error();
1917             (err, err)
1918         };
1919         self.check_pat(inner, inner_ty, def_bm, ti);
1920         box_ty
1921     }
1922
1923     // Precondition: Pat is Ref(inner)
1924     fn check_pat_ref(
1925         &self,
1926         pat: &'tcx Pat<'tcx>,
1927         inner: &'tcx Pat<'tcx>,
1928         mutbl: hir::Mutability,
1929         expected: Ty<'tcx>,
1930         def_bm: BindingMode,
1931         ti: TopInfo<'tcx>,
1932     ) -> Ty<'tcx> {
1933         let tcx = self.tcx;
1934         let expected = self.shallow_resolve(expected);
1935         let (rptr_ty, inner_ty) = if self.check_dereferenceable(pat.span, expected, inner) {
1936             // `demand::subtype` would be good enough, but using `eqtype` turns
1937             // out to be equally general. See (note_1) for details.
1938
1939             // Take region, inner-type from expected type if we can,
1940             // to avoid creating needless variables. This also helps with
1941             // the bad interactions of the given hack detailed in (note_1).
1942             debug!("check_pat_ref: expected={:?}", expected);
1943             match *expected.kind() {
1944                 ty::Ref(_, r_ty, r_mutbl) if r_mutbl == mutbl => (expected, r_ty),
1945                 _ => {
1946                     let inner_ty = self.next_ty_var(TypeVariableOrigin {
1947                         kind: TypeVariableOriginKind::TypeInference,
1948                         span: inner.span,
1949                     });
1950                     let rptr_ty = self.new_ref_ty(pat.span, mutbl, inner_ty);
1951                     debug!("check_pat_ref: demanding {:?} = {:?}", expected, rptr_ty);
1952                     let err = self.demand_eqtype_pat_diag(pat.span, expected, rptr_ty, ti);
1953
1954                     // Look for a case like `fn foo(&foo: u32)` and suggest
1955                     // `fn foo(foo: &u32)`
1956                     if let Some(mut err) = err {
1957                         self.borrow_pat_suggestion(&mut err, pat);
1958                         err.emit();
1959                     }
1960                     (rptr_ty, inner_ty)
1961                 }
1962             }
1963         } else {
1964             let err = tcx.ty_error();
1965             (err, err)
1966         };
1967         self.check_pat(inner, inner_ty, def_bm, ti);
1968         rptr_ty
1969     }
1970
1971     /// Create a reference type with a fresh region variable.
1972     fn new_ref_ty(&self, span: Span, mutbl: hir::Mutability, ty: Ty<'tcx>) -> Ty<'tcx> {
1973         let region = self.next_region_var(infer::PatternRegion(span));
1974         let mt = ty::TypeAndMut { ty, mutbl };
1975         self.tcx.mk_ref(region, mt)
1976     }
1977
1978     /// Type check a slice pattern.
1979     ///
1980     /// Syntactically, these look like `[pat_0, ..., pat_n]`.
1981     /// Semantically, we are type checking a pattern with structure:
1982     /// ```ignore (not-rust)
1983     /// [before_0, ..., before_n, (slice, after_0, ... after_n)?]
1984     /// ```
1985     /// The type of `slice`, if it is present, depends on the `expected` type.
1986     /// If `slice` is missing, then so is `after_i`.
1987     /// If `slice` is present, it can still represent 0 elements.
1988     fn check_pat_slice(
1989         &self,
1990         span: Span,
1991         before: &'tcx [Pat<'tcx>],
1992         slice: Option<&'tcx Pat<'tcx>>,
1993         after: &'tcx [Pat<'tcx>],
1994         expected: Ty<'tcx>,
1995         def_bm: BindingMode,
1996         ti: TopInfo<'tcx>,
1997     ) -> Ty<'tcx> {
1998         let expected = self.structurally_resolved_type(span, expected);
1999         let (element_ty, opt_slice_ty, inferred) = match *expected.kind() {
2000             // An array, so we might have something like `let [a, b, c] = [0, 1, 2];`.
2001             ty::Array(element_ty, len) => {
2002                 let min = before.len() as u64 + after.len() as u64;
2003                 let (opt_slice_ty, expected) =
2004                     self.check_array_pat_len(span, element_ty, expected, slice, len, min);
2005                 // `opt_slice_ty.is_none()` => `slice.is_none()`.
2006                 // Note, though, that opt_slice_ty could be `Some(error_ty)`.
2007                 assert!(opt_slice_ty.is_some() || slice.is_none());
2008                 (element_ty, opt_slice_ty, expected)
2009             }
2010             ty::Slice(element_ty) => (element_ty, Some(expected), expected),
2011             // The expected type must be an array or slice, but was neither, so error.
2012             _ => {
2013                 if !expected.references_error() {
2014                     self.error_expected_array_or_slice(span, expected, ti);
2015                 }
2016                 let err = self.tcx.ty_error();
2017                 (err, Some(err), err)
2018             }
2019         };
2020
2021         // Type check all the patterns before `slice`.
2022         for elt in before {
2023             self.check_pat(elt, element_ty, def_bm, ti);
2024         }
2025         // Type check the `slice`, if present, against its expected type.
2026         if let Some(slice) = slice {
2027             self.check_pat(slice, opt_slice_ty.unwrap(), def_bm, ti);
2028         }
2029         // Type check the elements after `slice`, if present.
2030         for elt in after {
2031             self.check_pat(elt, element_ty, def_bm, ti);
2032         }
2033         inferred
2034     }
2035
2036     /// Type check the length of an array pattern.
2037     ///
2038     /// Returns both the type of the variable length pattern (or `None`), and the potentially
2039     /// inferred array type. We only return `None` for the slice type if `slice.is_none()`.
2040     fn check_array_pat_len(
2041         &self,
2042         span: Span,
2043         element_ty: Ty<'tcx>,
2044         arr_ty: Ty<'tcx>,
2045         slice: Option<&'tcx Pat<'tcx>>,
2046         len: ty::Const<'tcx>,
2047         min_len: u64,
2048     ) -> (Option<Ty<'tcx>>, Ty<'tcx>) {
2049         if let Some(len) = len.try_eval_usize(self.tcx, self.param_env) {
2050             // Now we know the length...
2051             if slice.is_none() {
2052                 // ...and since there is no variable-length pattern,
2053                 // we require an exact match between the number of elements
2054                 // in the array pattern and as provided by the matched type.
2055                 if min_len == len {
2056                     return (None, arr_ty);
2057                 }
2058
2059                 self.error_scrutinee_inconsistent_length(span, min_len, len);
2060             } else if let Some(pat_len) = len.checked_sub(min_len) {
2061                 // The variable-length pattern was there,
2062                 // so it has an array type with the remaining elements left as its size...
2063                 return (Some(self.tcx.mk_array(element_ty, pat_len)), arr_ty);
2064             } else {
2065                 // ...however, in this case, there were no remaining elements.
2066                 // That is, the slice pattern requires more than the array type offers.
2067                 self.error_scrutinee_with_rest_inconsistent_length(span, min_len, len);
2068             }
2069         } else if slice.is_none() {
2070             // We have a pattern with a fixed length,
2071             // which we can use to infer the length of the array.
2072             let updated_arr_ty = self.tcx.mk_array(element_ty, min_len);
2073             self.demand_eqtype(span, updated_arr_ty, arr_ty);
2074             return (None, updated_arr_ty);
2075         } else {
2076             // We have a variable-length pattern and don't know the array length.
2077             // This happens if we have e.g.,
2078             // `let [a, b, ..] = arr` where `arr: [T; N]` where `const N: usize`.
2079             self.error_scrutinee_unfixed_length(span);
2080         }
2081
2082         // If we get here, we must have emitted an error.
2083         (Some(self.tcx.ty_error()), arr_ty)
2084     }
2085
2086     fn error_scrutinee_inconsistent_length(&self, span: Span, min_len: u64, size: u64) {
2087         struct_span_err!(
2088             self.tcx.sess,
2089             span,
2090             E0527,
2091             "pattern requires {} element{} but array has {}",
2092             min_len,
2093             pluralize!(min_len),
2094             size,
2095         )
2096         .span_label(span, format!("expected {} element{}", size, pluralize!(size)))
2097         .emit();
2098     }
2099
2100     fn error_scrutinee_with_rest_inconsistent_length(&self, span: Span, min_len: u64, size: u64) {
2101         struct_span_err!(
2102             self.tcx.sess,
2103             span,
2104             E0528,
2105             "pattern requires at least {} element{} but array has {}",
2106             min_len,
2107             pluralize!(min_len),
2108             size,
2109         )
2110         .span_label(
2111             span,
2112             format!("pattern cannot match array of {} element{}", size, pluralize!(size),),
2113         )
2114         .emit();
2115     }
2116
2117     fn error_scrutinee_unfixed_length(&self, span: Span) {
2118         struct_span_err!(
2119             self.tcx.sess,
2120             span,
2121             E0730,
2122             "cannot pattern-match on an array without a fixed length",
2123         )
2124         .emit();
2125     }
2126
2127     fn error_expected_array_or_slice(&self, span: Span, expected_ty: Ty<'tcx>, ti: TopInfo<'tcx>) {
2128         let mut err = struct_span_err!(
2129             self.tcx.sess,
2130             span,
2131             E0529,
2132             "expected an array or slice, found `{expected_ty}`"
2133         );
2134         if let ty::Ref(_, ty, _) = expected_ty.kind()
2135             && let ty::Array(..) | ty::Slice(..) = ty.kind()
2136         {
2137             err.help("the semantics of slice patterns changed recently; see issue #62254");
2138         } else if self.autoderef(span, expected_ty)
2139             .any(|(ty, _)| matches!(ty.kind(), ty::Slice(..) | ty::Array(..)))
2140             && let (Some(span), true) = (ti.span, ti.origin_expr)
2141             && let Ok(snippet) = self.tcx.sess.source_map().span_to_snippet(span)
2142         {
2143             let ty = self.resolve_vars_if_possible(ti.expected);
2144             let is_slice_or_array_or_vector = self.is_slice_or_array_or_vector(&mut err, snippet.clone(), ty);
2145             match is_slice_or_array_or_vector.1.kind() {
2146                 ty::Adt(adt_def, _)
2147                     if self.tcx.is_diagnostic_item(sym::Option, adt_def.did())
2148                         || self.tcx.is_diagnostic_item(sym::Result, adt_def.did()) =>
2149                 {
2150                     // Slicing won't work here, but `.as_deref()` might (issue #91328).
2151                     err.span_suggestion(
2152                         span,
2153                         "consider using `as_deref` here",
2154                         format!("{snippet}.as_deref()"),
2155                         Applicability::MaybeIncorrect,
2156                     );
2157                 }
2158                 _ => ()
2159             }
2160             if is_slice_or_array_or_vector.0 {
2161                 err.span_suggestion(
2162                     span,
2163                     "consider slicing here",
2164                     format!("{snippet}[..]"),
2165                     Applicability::MachineApplicable,
2166                 );
2167             }
2168         }
2169         err.span_label(span, format!("pattern cannot match with input type `{expected_ty}`"));
2170         err.emit();
2171     }
2172
2173     fn is_slice_or_array_or_vector(
2174         &self,
2175         err: &mut Diagnostic,
2176         snippet: String,
2177         ty: Ty<'tcx>,
2178     ) -> (bool, Ty<'tcx>) {
2179         match ty.kind() {
2180             ty::Adt(adt_def, _) if self.tcx.is_diagnostic_item(sym::Vec, adt_def.did()) => {
2181                 (true, ty)
2182             }
2183             ty::Ref(_, ty, _) => self.is_slice_or_array_or_vector(err, snippet, *ty),
2184             ty::Slice(..) | ty::Array(..) => (true, ty),
2185             _ => (false, ty),
2186         }
2187     }
2188 }