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