]> git.lizzy.rs Git - rust.git/blob - src/librustc_typeck/check/pat.rs
Rollup merge of #69311 - GuillaumeGomez:clean-up-e0321-e0322, r=Dylan-DPC
[rust.git] / src / librustc_typeck / check / pat.rs
1 use crate::check::FnCtxt;
2 use rustc::ty::subst::GenericArg;
3 use rustc::ty::{self, BindingMode, Ty, TypeFoldable};
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_infer::traits::Pattern;
13 use rustc_span::hygiene::DesugaringKind;
14 use rustc_span::Span;
15 use syntax::ast;
16 use syntax::util::lev_distance::find_best_match_for_name;
17
18 use std::cmp;
19 use std::collections::hash_map::Entry::{Occupied, Vacant};
20
21 use super::report_unexpected_variant_res;
22
23 const CANNOT_IMPLICITLY_DEREF_POINTER_TRAIT_OBJ: &str = "\
24 This error indicates that a pointer to a trait type cannot be implicitly dereferenced by a \
25 pattern. Every trait defines a type, but because the size of trait implementors isn't fixed, \
26 this type has no compile-time size. Therefore, all accesses to trait types must be through \
27 pointers. If you encounter this error you should try to avoid dereferencing the pointer.
28
29 You can read more about trait objects in the Trait Objects section of the Reference: \
30 https://doc.rust-lang.org/reference/types.html#trait-objects";
31
32 /// Information about the expected type at the top level of type checking a pattern.
33 ///
34 /// **NOTE:** This is only for use by diagnostics. Do NOT use for type checking logic!
35 #[derive(Copy, Clone)]
36 struct TopInfo<'tcx> {
37     /// The `expected` type at the top level of type checking a pattern.
38     expected: Ty<'tcx>,
39     /// Was the origin of the `span` from a scrutinee expression?
40     ///
41     /// Otherwise there is no scrutinee and it could be e.g. from the type of a formal parameter.
42     origin_expr: bool,
43     /// The span giving rise to the `expected` type, if one could be provided.
44     ///
45     /// If `origin_expr` is `true`, then this is the span of the scrutinee as in:
46     ///
47     /// - `match scrutinee { ... }`
48     /// - `let _ = scrutinee;`
49     ///
50     /// This is used to point to add context in type errors.
51     /// In the following example, `span` corresponds to the `a + b` expression:
52     ///
53     /// ```text
54     /// error[E0308]: mismatched types
55     ///  --> src/main.rs:L:C
56     ///   |
57     /// L |    let temp: usize = match a + b {
58     ///   |                            ----- this expression has type `usize`
59     /// L |         Ok(num) => num,
60     ///   |         ^^^^^^^ expected `usize`, found enum `std::result::Result`
61     ///   |
62     ///   = note: expected type `usize`
63     ///              found type `std::result::Result<_, _>`
64     /// ```
65     span: Option<Span>,
66 }
67
68 impl<'tcx> FnCtxt<'_, 'tcx> {
69     fn demand_eqtype_pat_diag(
70         &self,
71         cause_span: Span,
72         expected: Ty<'tcx>,
73         actual: Ty<'tcx>,
74         ti: TopInfo<'tcx>,
75     ) -> Option<DiagnosticBuilder<'tcx>> {
76         let code = Pattern { span: ti.span, root_ty: ti.expected, origin_expr: ti.origin_expr };
77         let cause = self.cause(cause_span, code);
78         self.demand_eqtype_with_origin(&cause, expected, actual)
79     }
80
81     fn demand_eqtype_pat(
82         &self,
83         cause_span: Span,
84         expected: Ty<'tcx>,
85         actual: Ty<'tcx>,
86         ti: TopInfo<'tcx>,
87     ) {
88         self.demand_eqtype_pat_diag(cause_span, expected, actual, ti).map(|mut err| err.emit());
89     }
90 }
91
92 const INITIAL_BM: BindingMode = BindingMode::BindByValue(hir::Mutability::Not);
93
94 /// Mode for adjusting the expected type and binding mode.
95 enum AdjustMode {
96     /// Peel off all immediate reference types.
97     Peel,
98     /// Reset binding mode to the inital mode.
99     Reset,
100     /// Pass on the input binding mode and expected type.
101     Pass,
102 }
103
104 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
105     /// Type check the given top level pattern against the `expected` type.
106     ///
107     /// If a `Some(span)` is provided and `origin_expr` holds,
108     /// then the `span` represents the scrutinee's span.
109     /// The scrutinee is found in e.g. `match scrutinee { ... }` and `let pat = scrutinee;`.
110     ///
111     /// Otherwise, `Some(span)` represents the span of a type expression
112     /// which originated the `expected` type.
113     pub fn check_pat_top(
114         &self,
115         pat: &'tcx Pat<'tcx>,
116         expected: Ty<'tcx>,
117         span: Option<Span>,
118         origin_expr: bool,
119     ) {
120         self.check_pat(pat, expected, INITIAL_BM, TopInfo { expected, origin_expr, span });
121     }
122
123     /// Type check the given `pat` against the `expected` type
124     /// with the provided `def_bm` (default binding mode).
125     ///
126     /// Outside of this module, `check_pat_top` should always be used.
127     /// Conversely, inside this module, `check_pat_top` should never be used.
128     fn check_pat(
129         &self,
130         pat: &'tcx Pat<'tcx>,
131         expected: Ty<'tcx>,
132         def_bm: BindingMode,
133         ti: TopInfo<'tcx>,
134     ) {
135         debug!("check_pat(pat={:?},expected={:?},def_bm={:?})", pat, expected, def_bm);
136
137         let path_res = match &pat.kind {
138             PatKind::Path(qpath) => Some(self.resolve_ty_and_res_ufcs(qpath, pat.hir_id, pat.span)),
139             _ => None,
140         };
141         let adjust_mode = self.calc_adjust_mode(pat, path_res.map(|(res, ..)| res));
142         let (expected, def_bm) = self.calc_default_binding_mode(pat, expected, def_bm, adjust_mode);
143
144         let ty = match pat.kind {
145             PatKind::Wild => expected,
146             PatKind::Lit(lt) => self.check_pat_lit(pat.span, lt, expected, ti),
147             PatKind::Range(lhs, rhs, _) => self.check_pat_range(pat.span, lhs, rhs, expected, ti),
148             PatKind::Binding(ba, var_id, _, sub) => {
149                 self.check_pat_ident(pat, ba, var_id, sub, expected, def_bm, ti)
150             }
151             PatKind::TupleStruct(ref qpath, subpats, ddpos) => {
152                 self.check_pat_tuple_struct(pat, qpath, subpats, ddpos, expected, def_bm, ti)
153             }
154             PatKind::Path(ref qpath) => {
155                 self.check_pat_path(pat, path_res.unwrap(), qpath, expected)
156             }
157             PatKind::Struct(ref qpath, fields, etc) => {
158                 self.check_pat_struct(pat, qpath, fields, etc, expected, def_bm, ti)
159             }
160             PatKind::Or(pats) => {
161                 for pat in pats {
162                     self.check_pat(pat, expected, def_bm, ti);
163                 }
164                 expected
165             }
166             PatKind::Tuple(elements, ddpos) => {
167                 self.check_pat_tuple(pat.span, elements, ddpos, expected, def_bm, ti)
168             }
169             PatKind::Box(inner) => self.check_pat_box(pat.span, inner, expected, def_bm, ti),
170             PatKind::Ref(inner, mutbl) => {
171                 self.check_pat_ref(pat, inner, mutbl, expected, def_bm, ti)
172             }
173             PatKind::Slice(before, slice, after) => {
174                 self.check_pat_slice(pat.span, before, slice, after, expected, def_bm, ti)
175             }
176         };
177
178         self.write_ty(pat.hir_id, ty);
179
180         // (note_1): In most of the cases where (note_1) is referenced
181         // (literals and constants being the exception), we relate types
182         // using strict equality, even though subtyping would be sufficient.
183         // There are a few reasons for this, some of which are fairly subtle
184         // and which cost me (nmatsakis) an hour or two debugging to remember,
185         // so I thought I'd write them down this time.
186         //
187         // 1. There is no loss of expressiveness here, though it does
188         // cause some inconvenience. What we are saying is that the type
189         // of `x` becomes *exactly* what is expected. This can cause unnecessary
190         // errors in some cases, such as this one:
191         //
192         // ```
193         // fn foo<'x>(x: &'x int) {
194         //    let a = 1;
195         //    let mut z = x;
196         //    z = &a;
197         // }
198         // ```
199         //
200         // The reason we might get an error is that `z` might be
201         // assigned a type like `&'x int`, and then we would have
202         // a problem when we try to assign `&a` to `z`, because
203         // the lifetime of `&a` (i.e., the enclosing block) is
204         // shorter than `'x`.
205         //
206         // HOWEVER, this code works fine. The reason is that the
207         // expected type here is whatever type the user wrote, not
208         // the initializer's type. In this case the user wrote
209         // nothing, so we are going to create a type variable `Z`.
210         // Then we will assign the type of the initializer (`&'x
211         // int`) as a subtype of `Z`: `&'x int <: Z`. And hence we
212         // will instantiate `Z` as a type `&'0 int` where `'0` is
213         // a fresh region variable, with the constraint that `'x :
214         // '0`.  So basically we're all set.
215         //
216         // Note that there are two tests to check that this remains true
217         // (`regions-reassign-{match,let}-bound-pointer.rs`).
218         //
219         // 2. Things go horribly wrong if we use subtype. The reason for
220         // THIS is a fairly subtle case involving bound regions. See the
221         // `givens` field in `region_constraints`, as well as the test
222         // `regions-relate-bound-regions-on-closures-to-inference-variables.rs`,
223         // for details. Short version is that we must sometimes detect
224         // relationships between specific region variables and regions
225         // bound in a closure signature, and that detection gets thrown
226         // off when we substitute fresh region variables here to enable
227         // subtyping.
228     }
229
230     /// Compute the new expected type and default binding mode from the old ones
231     /// as well as the pattern form we are currently checking.
232     fn calc_default_binding_mode(
233         &self,
234         pat: &'tcx Pat<'tcx>,
235         expected: Ty<'tcx>,
236         def_bm: BindingMode,
237         adjust_mode: AdjustMode,
238     ) -> (Ty<'tcx>, BindingMode) {
239         match adjust_mode {
240             AdjustMode::Pass => (expected, def_bm),
241             AdjustMode::Reset => (expected, INITIAL_BM),
242             AdjustMode::Peel => self.peel_off_references(pat, expected, def_bm),
243         }
244     }
245
246     /// How should the binding mode and expected type be adjusted?
247     ///
248     /// When the pattern is a path pattern, `opt_path_res` must be `Some(res)`.
249     fn calc_adjust_mode(&self, pat: &'tcx Pat<'tcx>, opt_path_res: Option<Res>) -> AdjustMode {
250         match &pat.kind {
251             // Type checking these product-like types successfully always require
252             // that the expected type be of those types and not reference types.
253             PatKind::Struct(..)
254             | PatKind::TupleStruct(..)
255             | PatKind::Tuple(..)
256             | PatKind::Box(_)
257             | PatKind::Range(..)
258             | PatKind::Slice(..) => AdjustMode::Peel,
259             // String and byte-string literals result in types `&str` and `&[u8]` respectively.
260             // All other literals result in non-reference types.
261             // As a result, we allow `if let 0 = &&0 {}` but not `if let "foo" = &&"foo {}`.
262             PatKind::Lit(lt) => match self.check_expr(lt).kind {
263                 ty::Ref(..) => AdjustMode::Pass,
264                 _ => AdjustMode::Peel,
265             },
266             PatKind::Path(_) => match opt_path_res.unwrap() {
267                 // These constants can be of a reference type, e.g. `const X: &u8 = &0;`.
268                 // Peeling the reference types too early will cause type checking failures.
269                 // Although it would be possible to *also* peel the types of the constants too.
270                 Res::Def(DefKind::Const, _) | Res::Def(DefKind::AssocConst, _) => AdjustMode::Pass,
271                 // In the `ValueNS`, we have `SelfCtor(..) | Ctor(_, Const), _)` remaining which
272                 // could successfully compile. The former being `Self` requires a unit struct.
273                 // In either case, and unlike constants, the pattern itself cannot be
274                 // a reference type wherefore peeling doesn't give up any expressivity.
275                 _ => AdjustMode::Peel,
276             },
277             // When encountering a `& mut? pat` pattern, reset to "by value".
278             // This is so that `x` and `y` here are by value, as they appear to be:
279             //
280             // ```
281             // match &(&22, &44) {
282             //   (&x, &y) => ...
283             // }
284             // ```
285             //
286             // See issue #46688.
287             PatKind::Ref(..) => AdjustMode::Reset,
288             // A `_` pattern works with any expected type, so there's no need to do anything.
289             PatKind::Wild
290             // Bindings also work with whatever the expected type is,
291             // and moreover if we peel references off, that will give us the wrong binding type.
292             // Also, we can have a subpattern `binding @ pat`.
293             // Each side of the `@` should be treated independently (like with OR-patterns).
294             | PatKind::Binding(..)
295             // An OR-pattern just propagates to each individual alternative.
296             // This is maximally flexible, allowing e.g., `Some(mut x) | &Some(mut x)`.
297             // In that example, `Some(mut x)` results in `Peel` whereas `&Some(mut x)` in `Reset`.
298             | PatKind::Or(_) => AdjustMode::Pass,
299         }
300     }
301
302     /// Peel off as many immediately nested `& mut?` from the expected type as possible
303     /// and return the new expected type and binding default binding mode.
304     /// The adjustments vector, if non-empty is stored in a table.
305     fn peel_off_references(
306         &self,
307         pat: &'tcx Pat<'tcx>,
308         expected: Ty<'tcx>,
309         mut def_bm: BindingMode,
310     ) -> (Ty<'tcx>, BindingMode) {
311         let mut expected = self.resolve_vars_with_obligations(&expected);
312
313         // Peel off as many `&` or `&mut` from the scrutinee type as possible. For example,
314         // for `match &&&mut Some(5)` the loop runs three times, aborting when it reaches
315         // the `Some(5)` which is not of type Ref.
316         //
317         // For each ampersand peeled off, update the binding mode and push the original
318         // type into the adjustments vector.
319         //
320         // See the examples in `ui/match-defbm*.rs`.
321         let mut pat_adjustments = vec![];
322         while let ty::Ref(_, inner_ty, inner_mutability) = expected.kind {
323             debug!("inspecting {:?}", expected);
324
325             debug!("current discriminant is Ref, inserting implicit deref");
326             // Preserve the reference type. We'll need it later during HAIR lowering.
327             pat_adjustments.push(expected);
328
329             expected = inner_ty;
330             def_bm = ty::BindByReference(match def_bm {
331                 // If default binding mode is by value, make it `ref` or `ref mut`
332                 // (depending on whether we observe `&` or `&mut`).
333                 ty::BindByValue(_) |
334                 // When `ref mut`, stay a `ref mut` (on `&mut`) or downgrade to `ref` (on `&`).
335                 ty::BindByReference(hir::Mutability::Mut) => inner_mutability,
336                 // Once a `ref`, always a `ref`.
337                 // This is because a `& &mut` cannot mutate the underlying value.
338                 ty::BindByReference(m @ hir::Mutability::Not) => m,
339             });
340         }
341
342         if pat_adjustments.len() > 0 {
343             debug!("default binding mode is now {:?}", def_bm);
344             self.inh.tables.borrow_mut().pat_adjustments_mut().insert(pat.hir_id, pat_adjustments);
345         }
346
347         (expected, def_bm)
348     }
349
350     fn check_pat_lit(
351         &self,
352         span: Span,
353         lt: &hir::Expr<'tcx>,
354         expected: Ty<'tcx>,
355         ti: TopInfo<'tcx>,
356     ) -> Ty<'tcx> {
357         // We've already computed the type above (when checking for a non-ref pat),
358         // so avoid computing it again.
359         let ty = self.node_ty(lt.hir_id);
360
361         // Byte string patterns behave the same way as array patterns
362         // They can denote both statically and dynamically-sized byte arrays.
363         let mut pat_ty = ty;
364         if let hir::ExprKind::Lit(ref lt) = lt.kind {
365             if let ast::LitKind::ByteStr(_) = lt.node {
366                 let expected_ty = self.structurally_resolved_type(span, expected);
367                 if let ty::Ref(_, r_ty, _) = expected_ty.kind {
368                     if let ty::Slice(_) = r_ty.kind {
369                         let tcx = self.tcx;
370                         pat_ty =
371                             tcx.mk_imm_ref(tcx.lifetimes.re_static, tcx.mk_slice(tcx.types.u8));
372                     }
373                 }
374             }
375         }
376
377         // Somewhat surprising: in this case, the subtyping relation goes the
378         // opposite way as the other cases. Actually what we really want is not
379         // a subtyping relation at all but rather that there exists a LUB
380         // (so that they can be compared). However, in practice, constants are
381         // always scalars or strings. For scalars subtyping is irrelevant,
382         // and for strings `ty` is type is `&'static str`, so if we say that
383         //
384         //     &'static str <: expected
385         //
386         // then that's equivalent to there existing a LUB.
387         if let Some(mut err) = self.demand_suptype_diag(span, expected, pat_ty) {
388             err.emit_unless(
389                 ti.span
390                     .filter(|&s| {
391                         // In the case of `if`- and `while`-expressions we've already checked
392                         // that `scrutinee: bool`. We know that the pattern is `true`,
393                         // so an error here would be a duplicate and from the wrong POV.
394                         s.is_desugaring(DesugaringKind::CondTemporary)
395                     })
396                     .is_some(),
397             );
398         }
399
400         pat_ty
401     }
402
403     fn check_pat_range(
404         &self,
405         span: Span,
406         lhs: Option<&'tcx hir::Expr<'tcx>>,
407         rhs: Option<&'tcx hir::Expr<'tcx>>,
408         expected: Ty<'tcx>,
409         ti: TopInfo<'tcx>,
410     ) -> Ty<'tcx> {
411         let calc_side = |opt_expr: Option<&'tcx hir::Expr<'tcx>>| match opt_expr {
412             None => (None, None),
413             Some(expr) => {
414                 let ty = self.check_expr(expr);
415                 // Check that the end-point is of numeric or char type.
416                 let fail = !(ty.is_numeric() || ty.is_char() || ty.references_error());
417                 (Some(ty), Some((fail, ty, expr.span)))
418             }
419         };
420         let (lhs_ty, lhs) = calc_side(lhs);
421         let (rhs_ty, rhs) = calc_side(rhs);
422
423         if let (Some((true, ..)), _) | (_, Some((true, ..))) = (lhs, rhs) {
424             // There exists a side that didn't meet our criteria that the end-point
425             // be of a numeric or char type, as checked in `calc_side` above.
426             self.emit_err_pat_range(span, lhs, rhs);
427             return self.tcx.types.err;
428         }
429
430         // Now that we know the types can be unified we find the unified type
431         // and use it to type the entire expression.
432         let common_type = self.resolve_vars_if_possible(&lhs_ty.or(rhs_ty).unwrap_or(expected));
433
434         // Subtyping doesn't matter here, as the value is some kind of scalar.
435         let demand_eqtype = |x, y| {
436             if let Some((_, x_ty, x_span)) = x {
437                 self.demand_eqtype_pat_diag(x_span, expected, x_ty, ti).map(|mut err| {
438                     if let Some((_, y_ty, y_span)) = y {
439                         self.endpoint_has_type(&mut err, y_span, y_ty);
440                     }
441                     err.emit();
442                 });
443             }
444         };
445         demand_eqtype(lhs, rhs);
446         demand_eqtype(rhs, lhs);
447
448         common_type
449     }
450
451     fn endpoint_has_type(&self, err: &mut DiagnosticBuilder<'_>, span: Span, ty: Ty<'_>) {
452         if !ty.references_error() {
453             err.span_label(span, &format!("this is of type `{}`", ty));
454         }
455     }
456
457     fn emit_err_pat_range(
458         &self,
459         span: Span,
460         lhs: Option<(bool, Ty<'tcx>, Span)>,
461         rhs: Option<(bool, Ty<'tcx>, Span)>,
462     ) {
463         let span = match (lhs, rhs) {
464             (Some((true, ..)), Some((true, ..))) => span,
465             (Some((true, _, sp)), _) => sp,
466             (_, Some((true, _, sp))) => sp,
467             _ => span_bug!(span, "emit_err_pat_range: no side failed or exists but still error?"),
468         };
469         let mut err = struct_span_err!(
470             self.tcx.sess,
471             span,
472             E0029,
473             "only char and numeric types are allowed in range patterns"
474         );
475         let msg = |ty| format!("this is of type `{}` but it should be `char` or numeric", ty);
476         let mut one_side_err = |first_span, first_ty, second: Option<(bool, Ty<'tcx>, Span)>| {
477             err.span_label(first_span, &msg(first_ty));
478             if let Some((_, ty, sp)) = second {
479                 self.endpoint_has_type(&mut err, sp, ty);
480             }
481         };
482         match (lhs, rhs) {
483             (Some((true, lhs_ty, lhs_sp)), Some((true, rhs_ty, rhs_sp))) => {
484                 err.span_label(lhs_sp, &msg(lhs_ty));
485                 err.span_label(rhs_sp, &msg(rhs_ty));
486             }
487             (Some((true, lhs_ty, lhs_sp)), rhs) => one_side_err(lhs_sp, lhs_ty, rhs),
488             (lhs, Some((true, rhs_ty, rhs_sp))) => one_side_err(rhs_sp, rhs_ty, lhs),
489             _ => span_bug!(span, "Impossible, verified above."),
490         }
491         if self.tcx.sess.teach(&err.get_code().unwrap()) {
492             err.note(
493                 "In a match expression, only numbers and characters can be matched \
494                     against a range. This is because the compiler checks that the range \
495                     is non-empty at compile-time, and is unable to evaluate arbitrary \
496                     comparison functions. If you want to capture values of an orderable \
497                     type between two end-points, you can use a guard.",
498             );
499         }
500         err.emit();
501     }
502
503     fn check_pat_ident(
504         &self,
505         pat: &Pat<'_>,
506         ba: hir::BindingAnnotation,
507         var_id: HirId,
508         sub: Option<&'tcx Pat<'tcx>>,
509         expected: Ty<'tcx>,
510         def_bm: BindingMode,
511         ti: TopInfo<'tcx>,
512     ) -> Ty<'tcx> {
513         // Determine the binding mode...
514         let bm = match ba {
515             hir::BindingAnnotation::Unannotated => def_bm,
516             _ => BindingMode::convert(ba),
517         };
518         // ...and store it in a side table:
519         self.inh.tables.borrow_mut().pat_binding_modes_mut().insert(pat.hir_id, bm);
520
521         debug!("check_pat_ident: pat.hir_id={:?} bm={:?}", pat.hir_id, bm);
522
523         let local_ty = self.local_ty(pat.span, pat.hir_id).decl_ty;
524         let eq_ty = match bm {
525             ty::BindByReference(mutbl) => {
526                 // If the binding is like `ref x | ref mut x`,
527                 // then `x` is assigned a value of type `&M T` where M is the
528                 // mutability and T is the expected type.
529                 //
530                 // `x` is assigned a value of type `&M T`, hence `&M T <: typeof(x)`
531                 // is required. However, we use equality, which is stronger.
532                 // See (note_1) for an explanation.
533                 self.new_ref_ty(pat.span, mutbl, expected)
534             }
535             // Otherwise, the type of x is the expected type `T`.
536             ty::BindByValue(_) => {
537                 // As above, `T <: typeof(x)` is required, but we use equality, see (note_1).
538                 expected
539             }
540         };
541         self.demand_eqtype_pat(pat.span, eq_ty, local_ty, ti);
542
543         // If there are multiple arms, make sure they all agree on
544         // what the type of the binding `x` ought to be.
545         if var_id != pat.hir_id {
546             let vt = self.local_ty(pat.span, var_id).decl_ty;
547             self.demand_eqtype_pat(pat.span, vt, local_ty, ti);
548         }
549
550         if let Some(p) = sub {
551             self.check_pat(&p, expected, def_bm, ti);
552         }
553
554         local_ty
555     }
556
557     fn borrow_pat_suggestion(
558         &self,
559         err: &mut DiagnosticBuilder<'_>,
560         pat: &Pat<'_>,
561         inner: &Pat<'_>,
562         expected: Ty<'tcx>,
563     ) {
564         let tcx = self.tcx;
565         if let PatKind::Binding(..) = inner.kind {
566             let binding_parent_id = tcx.hir().get_parent_node(pat.hir_id);
567             let binding_parent = tcx.hir().get(binding_parent_id);
568             debug!("inner {:?} pat {:?} parent {:?}", inner, pat, binding_parent);
569             match binding_parent {
570                 hir::Node::Param(hir::Param { span, .. }) => {
571                     if let Ok(snippet) = tcx.sess.source_map().span_to_snippet(inner.span) {
572                         err.span_suggestion(
573                             *span,
574                             &format!("did you mean `{}`", snippet),
575                             format!(" &{}", expected),
576                             Applicability::MachineApplicable,
577                         );
578                     }
579                 }
580                 hir::Node::Arm(_) | hir::Node::Pat(_) => {
581                     // rely on match ergonomics or it might be nested `&&pat`
582                     if let Ok(snippet) = tcx.sess.source_map().span_to_snippet(inner.span) {
583                         err.span_suggestion(
584                             pat.span,
585                             "you can probably remove the explicit borrow",
586                             snippet,
587                             Applicability::MaybeIncorrect,
588                         );
589                     }
590                 }
591                 _ => {} // don't provide suggestions in other cases #55175
592             }
593         }
594     }
595
596     pub fn check_dereferenceable(&self, span: Span, expected: Ty<'tcx>, inner: &Pat<'_>) -> bool {
597         if let PatKind::Binding(..) = inner.kind {
598             if let Some(mt) = self.shallow_resolve(expected).builtin_deref(true) {
599                 if let ty::Dynamic(..) = mt.ty.kind {
600                     // This is "x = SomeTrait" being reduced from
601                     // "let &x = &SomeTrait" or "let box x = Box<SomeTrait>", an error.
602                     let type_str = self.ty_to_string(expected);
603                     let mut err = struct_span_err!(
604                         self.tcx.sess,
605                         span,
606                         E0033,
607                         "type `{}` cannot be dereferenced",
608                         type_str
609                     );
610                     err.span_label(span, format!("type `{}` cannot be dereferenced", type_str));
611                     if self.tcx.sess.teach(&err.get_code().unwrap()) {
612                         err.note(CANNOT_IMPLICITLY_DEREF_POINTER_TRAIT_OBJ);
613                     }
614                     err.emit();
615                     return false;
616                 }
617             }
618         }
619         true
620     }
621
622     fn check_pat_struct(
623         &self,
624         pat: &'tcx Pat<'tcx>,
625         qpath: &hir::QPath<'_>,
626         fields: &'tcx [hir::FieldPat<'tcx>],
627         etc: bool,
628         expected: Ty<'tcx>,
629         def_bm: BindingMode,
630         ti: TopInfo<'tcx>,
631     ) -> Ty<'tcx> {
632         // Resolve the path and check the definition for errors.
633         let (variant, pat_ty) = if let Some(variant_ty) = self.check_struct_path(qpath, pat.hir_id)
634         {
635             variant_ty
636         } else {
637             for field in fields {
638                 self.check_pat(&field.pat, self.tcx.types.err, def_bm, ti);
639             }
640             return self.tcx.types.err;
641         };
642
643         // Type-check the path.
644         self.demand_eqtype_pat(pat.span, expected, pat_ty, ti);
645
646         // Type-check subpatterns.
647         if self
648             .check_struct_pat_fields(pat_ty, pat.hir_id, pat.span, variant, fields, etc, def_bm, ti)
649         {
650             pat_ty
651         } else {
652             self.tcx.types.err
653         }
654     }
655
656     fn check_pat_path(
657         &self,
658         pat: &Pat<'_>,
659         path_resolution: (Res, Option<Ty<'tcx>>, &'b [hir::PathSegment<'b>]),
660         qpath: &hir::QPath<'_>,
661         expected: Ty<'tcx>,
662     ) -> Ty<'tcx> {
663         let tcx = self.tcx;
664
665         // We have already resolved the path.
666         let (res, opt_ty, segments) = path_resolution;
667         match res {
668             Res::Err => {
669                 self.set_tainted_by_errors();
670                 return tcx.types.err;
671             }
672             Res::Def(DefKind::Method, _)
673             | Res::Def(DefKind::Ctor(_, CtorKind::Fictive), _)
674             | Res::Def(DefKind::Ctor(_, CtorKind::Fn), _) => {
675                 report_unexpected_variant_res(tcx, res, pat.span, qpath);
676                 return tcx.types.err;
677             }
678             Res::Def(DefKind::Ctor(_, CtorKind::Const), _)
679             | Res::SelfCtor(..)
680             | Res::Def(DefKind::Const, _)
681             | Res::Def(DefKind::AssocConst, _) => {} // OK
682             _ => bug!("unexpected pattern resolution: {:?}", res),
683         }
684
685         // Type-check the path.
686         let pat_ty = self.instantiate_value_path(segments, opt_ty, res, pat.span, pat.hir_id).0;
687         self.demand_suptype(pat.span, expected, pat_ty);
688         pat_ty
689     }
690
691     fn check_pat_tuple_struct(
692         &self,
693         pat: &Pat<'_>,
694         qpath: &hir::QPath<'_>,
695         subpats: &'tcx [&'tcx Pat<'tcx>],
696         ddpos: Option<usize>,
697         expected: Ty<'tcx>,
698         def_bm: BindingMode,
699         ti: TopInfo<'tcx>,
700     ) -> Ty<'tcx> {
701         let tcx = self.tcx;
702         let on_error = || {
703             for pat in subpats {
704                 self.check_pat(&pat, tcx.types.err, def_bm, ti);
705             }
706         };
707         let report_unexpected_res = |res: Res| {
708             let msg = format!(
709                 "expected tuple struct or tuple variant, found {} `{}`",
710                 res.descr(),
711                 hir::print::to_string(&tcx.hir(), |s| s.print_qpath(qpath, false)),
712             );
713             let mut err = struct_span_err!(tcx.sess, pat.span, E0164, "{}", msg);
714             match (res, &pat.kind) {
715                 (Res::Def(DefKind::Fn, _), _) | (Res::Def(DefKind::Method, _), _) => {
716                     err.span_label(pat.span, "`fn` calls are not allowed in patterns");
717                     err.help(
718                         "for more information, visit \
719                               https://doc.rust-lang.org/book/ch18-00-patterns.html",
720                     );
721                 }
722                 _ => {
723                     err.span_label(pat.span, "not a tuple variant or struct");
724                 }
725             }
726             err.emit();
727             on_error();
728         };
729
730         // Resolve the path and check the definition for errors.
731         let (res, opt_ty, segments) = self.resolve_ty_and_res_ufcs(qpath, pat.hir_id, pat.span);
732         if res == Res::Err {
733             self.set_tainted_by_errors();
734             on_error();
735             return self.tcx.types.err;
736         }
737
738         // Type-check the path.
739         let (pat_ty, res) =
740             self.instantiate_value_path(segments, opt_ty, res, pat.span, pat.hir_id);
741         if !pat_ty.is_fn() {
742             report_unexpected_res(res);
743             return tcx.types.err;
744         }
745
746         let variant = match res {
747             Res::Err => {
748                 self.set_tainted_by_errors();
749                 on_error();
750                 return tcx.types.err;
751             }
752             Res::Def(DefKind::AssocConst, _) | Res::Def(DefKind::Method, _) => {
753                 report_unexpected_res(res);
754                 return tcx.types.err;
755             }
756             Res::Def(DefKind::Ctor(_, CtorKind::Fn), _) => tcx.expect_variant_res(res),
757             _ => bug!("unexpected pattern resolution: {:?}", res),
758         };
759
760         // Replace constructor type with constructed type for tuple struct patterns.
761         let pat_ty = pat_ty.fn_sig(tcx).output();
762         let pat_ty = pat_ty.no_bound_vars().expect("expected fn type");
763
764         // Type-check the tuple struct pattern against the expected type.
765         let diag = self.demand_eqtype_pat_diag(pat.span, expected, pat_ty, ti);
766         let had_err = diag.is_some();
767         diag.map(|mut err| err.emit());
768
769         // Type-check subpatterns.
770         if subpats.len() == variant.fields.len()
771             || subpats.len() < variant.fields.len() && ddpos.is_some()
772         {
773             let substs = match pat_ty.kind {
774                 ty::Adt(_, substs) => substs,
775                 _ => bug!("unexpected pattern type {:?}", pat_ty),
776             };
777             for (i, subpat) in subpats.iter().enumerate_and_adjust(variant.fields.len(), ddpos) {
778                 let field_ty = self.field_ty(subpat.span, &variant.fields[i], substs);
779                 self.check_pat(&subpat, field_ty, def_bm, ti);
780
781                 self.tcx.check_stability(variant.fields[i].did, Some(pat.hir_id), subpat.span);
782             }
783         } else {
784             // Pattern has wrong number of fields.
785             self.e0023(pat.span, res, qpath, subpats, &variant.fields, expected, had_err);
786             on_error();
787             return tcx.types.err;
788         }
789         pat_ty
790     }
791
792     fn e0023(
793         &self,
794         pat_span: Span,
795         res: Res,
796         qpath: &hir::QPath<'_>,
797         subpats: &'tcx [&'tcx Pat<'tcx>],
798         fields: &'tcx [ty::FieldDef],
799         expected: Ty<'tcx>,
800         had_err: bool,
801     ) {
802         let subpats_ending = pluralize!(subpats.len());
803         let fields_ending = pluralize!(fields.len());
804         let res_span = self.tcx.def_span(res.def_id());
805         let mut err = struct_span_err!(
806             self.tcx.sess,
807             pat_span,
808             E0023,
809             "this pattern has {} field{}, but the corresponding {} has {} field{}",
810             subpats.len(),
811             subpats_ending,
812             res.descr(),
813             fields.len(),
814             fields_ending,
815         );
816         err.span_label(
817             pat_span,
818             format!("expected {} field{}, found {}", fields.len(), fields_ending, subpats.len(),),
819         )
820         .span_label(res_span, format!("{} defined here", res.descr()));
821
822         // Identify the case `Some(x, y)` where the expected type is e.g. `Option<(T, U)>`.
823         // More generally, the expected type wants a tuple variant with one field of an
824         // N-arity-tuple, e.g., `V_i((p_0, .., p_N))`. Meanwhile, the user supplied a pattern
825         // with the subpatterns directly in the tuple variant pattern, e.g., `V_i(p_0, .., p_N)`.
826         let missing_parenthesis = match (&expected.kind, fields, had_err) {
827             // #67037: only do this if we could sucessfully type-check the expected type against
828             // the tuple struct pattern. Otherwise the substs could get out of range on e.g.,
829             // `let P() = U;` where `P != U` with `struct P<T>(T);`.
830             (ty::Adt(_, substs), [field], false) => {
831                 let field_ty = self.field_ty(pat_span, field, substs);
832                 match field_ty.kind {
833                     ty::Tuple(_) => field_ty.tuple_fields().count() == subpats.len(),
834                     _ => false,
835                 }
836             }
837             _ => false,
838         };
839         if missing_parenthesis {
840             let (left, right) = match subpats {
841                 // This is the zero case; we aim to get the "hi" part of the `QPath`'s
842                 // span as the "lo" and then the "hi" part of the pattern's span as the "hi".
843                 // This looks like:
844                 //
845                 // help: missing parenthesis
846                 //   |
847                 // L |     let A(()) = A(());
848                 //   |          ^  ^
849                 [] => {
850                     let qpath_span = match qpath {
851                         hir::QPath::Resolved(_, path) => path.span,
852                         hir::QPath::TypeRelative(_, ps) => ps.ident.span,
853                     };
854                     (qpath_span.shrink_to_hi(), pat_span)
855                 }
856                 // Easy case. Just take the "lo" of the first sub-pattern and the "hi" of the
857                 // last sub-pattern. In the case of `A(x)` the first and last may coincide.
858                 // This looks like:
859                 //
860                 // help: missing parenthesis
861                 //   |
862                 // L |     let A((x, y)) = A((1, 2));
863                 //   |           ^    ^
864                 [first, ..] => (first.span.shrink_to_lo(), subpats.last().unwrap().span),
865             };
866             err.multipart_suggestion(
867                 "missing parenthesis",
868                 vec![(left, "(".to_string()), (right.shrink_to_hi(), ")".to_string())],
869                 Applicability::MachineApplicable,
870             );
871         }
872
873         err.emit();
874     }
875
876     fn check_pat_tuple(
877         &self,
878         span: Span,
879         elements: &'tcx [&'tcx Pat<'tcx>],
880         ddpos: Option<usize>,
881         expected: Ty<'tcx>,
882         def_bm: BindingMode,
883         ti: TopInfo<'tcx>,
884     ) -> Ty<'tcx> {
885         let tcx = self.tcx;
886         let mut expected_len = elements.len();
887         if ddpos.is_some() {
888             // Require known type only when `..` is present.
889             if let ty::Tuple(ref tys) = self.structurally_resolved_type(span, expected).kind {
890                 expected_len = tys.len();
891             }
892         }
893         let max_len = cmp::max(expected_len, elements.len());
894
895         let element_tys_iter = (0..max_len).map(|_| {
896             GenericArg::from(self.next_ty_var(
897                 // FIXME: `MiscVariable` for now -- obtaining the span and name information
898                 // from all tuple elements isn't trivial.
899                 TypeVariableOrigin { kind: TypeVariableOriginKind::TypeInference, span },
900             ))
901         });
902         let element_tys = tcx.mk_substs(element_tys_iter);
903         let pat_ty = tcx.mk_ty(ty::Tuple(element_tys));
904         if let Some(mut err) = self.demand_eqtype_diag(span, expected, pat_ty) {
905             err.emit();
906             // Walk subpatterns with an expected type of `err` in this case to silence
907             // further errors being emitted when using the bindings. #50333
908             let element_tys_iter = (0..max_len).map(|_| tcx.types.err);
909             for (_, elem) in elements.iter().enumerate_and_adjust(max_len, ddpos) {
910                 self.check_pat(elem, &tcx.types.err, def_bm, ti);
911             }
912             tcx.mk_tup(element_tys_iter)
913         } else {
914             for (i, elem) in elements.iter().enumerate_and_adjust(max_len, ddpos) {
915                 self.check_pat(elem, &element_tys[i].expect_ty(), def_bm, ti);
916             }
917             pat_ty
918         }
919     }
920
921     fn check_struct_pat_fields(
922         &self,
923         adt_ty: Ty<'tcx>,
924         pat_id: HirId,
925         span: Span,
926         variant: &'tcx ty::VariantDef,
927         fields: &'tcx [hir::FieldPat<'tcx>],
928         etc: bool,
929         def_bm: BindingMode,
930         ti: TopInfo<'tcx>,
931     ) -> bool {
932         let tcx = self.tcx;
933
934         let (substs, adt) = match adt_ty.kind {
935             ty::Adt(adt, substs) => (substs, adt),
936             _ => span_bug!(span, "struct pattern is not an ADT"),
937         };
938         let kind_name = adt.variant_descr();
939
940         // Index the struct fields' types.
941         let field_map = variant
942             .fields
943             .iter()
944             .enumerate()
945             .map(|(i, field)| (field.ident.modern(), (i, field)))
946             .collect::<FxHashMap<_, _>>();
947
948         // Keep track of which fields have already appeared in the pattern.
949         let mut used_fields = FxHashMap::default();
950         let mut no_field_errors = true;
951
952         let mut inexistent_fields = vec![];
953         // Typecheck each field.
954         for field in fields {
955             let span = field.span;
956             let ident = tcx.adjust_ident(field.ident, variant.def_id);
957             let field_ty = match used_fields.entry(ident) {
958                 Occupied(occupied) => {
959                     self.error_field_already_bound(span, field.ident, *occupied.get());
960                     no_field_errors = false;
961                     tcx.types.err
962                 }
963                 Vacant(vacant) => {
964                     vacant.insert(span);
965                     field_map
966                         .get(&ident)
967                         .map(|(i, f)| {
968                             self.write_field_index(field.hir_id, *i);
969                             self.tcx.check_stability(f.did, Some(pat_id), span);
970                             self.field_ty(span, f, substs)
971                         })
972                         .unwrap_or_else(|| {
973                             inexistent_fields.push(field.ident);
974                             no_field_errors = false;
975                             tcx.types.err
976                         })
977                 }
978             };
979
980             self.check_pat(&field.pat, field_ty, def_bm, ti);
981         }
982
983         let mut unmentioned_fields = variant
984             .fields
985             .iter()
986             .map(|field| field.ident.modern())
987             .filter(|ident| !used_fields.contains_key(&ident))
988             .collect::<Vec<_>>();
989
990         if inexistent_fields.len() > 0 && !variant.recovered {
991             self.error_inexistent_fields(
992                 kind_name,
993                 &inexistent_fields,
994                 &mut unmentioned_fields,
995                 variant,
996             );
997         }
998
999         // Require `..` if struct has non_exhaustive attribute.
1000         if variant.is_field_list_non_exhaustive() && !adt.did.is_local() && !etc {
1001             struct_span_err!(
1002                 tcx.sess,
1003                 span,
1004                 E0638,
1005                 "`..` required with {} marked as non-exhaustive",
1006                 kind_name
1007             )
1008             .emit();
1009         }
1010
1011         // Report an error if incorrect number of the fields were specified.
1012         if kind_name == "union" {
1013             if fields.len() != 1 {
1014                 tcx.sess
1015                     .struct_span_err(span, "union patterns should have exactly one field")
1016                     .emit();
1017             }
1018             if etc {
1019                 tcx.sess.struct_span_err(span, "`..` cannot be used in union patterns").emit();
1020             }
1021         } else if !etc && unmentioned_fields.len() > 0 {
1022             self.error_unmentioned_fields(span, &unmentioned_fields, variant);
1023         }
1024         no_field_errors
1025     }
1026
1027     fn error_field_already_bound(&self, span: Span, ident: ast::Ident, other_field: Span) {
1028         struct_span_err!(
1029             self.tcx.sess,
1030             span,
1031             E0025,
1032             "field `{}` bound multiple times in the pattern",
1033             ident
1034         )
1035         .span_label(span, format!("multiple uses of `{}` in pattern", ident))
1036         .span_label(other_field, format!("first use of `{}`", ident))
1037         .emit();
1038     }
1039
1040     fn error_inexistent_fields(
1041         &self,
1042         kind_name: &str,
1043         inexistent_fields: &[ast::Ident],
1044         unmentioned_fields: &mut Vec<ast::Ident>,
1045         variant: &ty::VariantDef,
1046     ) {
1047         let tcx = self.tcx;
1048         let (field_names, t, plural) = if inexistent_fields.len() == 1 {
1049             (format!("a field named `{}`", inexistent_fields[0]), "this", "")
1050         } else {
1051             (
1052                 format!(
1053                     "fields named {}",
1054                     inexistent_fields
1055                         .iter()
1056                         .map(|ident| format!("`{}`", ident))
1057                         .collect::<Vec<String>>()
1058                         .join(", ")
1059                 ),
1060                 "these",
1061                 "s",
1062             )
1063         };
1064         let spans = inexistent_fields.iter().map(|ident| ident.span).collect::<Vec<_>>();
1065         let mut err = struct_span_err!(
1066             tcx.sess,
1067             spans,
1068             E0026,
1069             "{} `{}` does not have {}",
1070             kind_name,
1071             tcx.def_path_str(variant.def_id),
1072             field_names
1073         );
1074         if let Some(ident) = inexistent_fields.last() {
1075             err.span_label(
1076                 ident.span,
1077                 format!(
1078                     "{} `{}` does not have {} field{}",
1079                     kind_name,
1080                     tcx.def_path_str(variant.def_id),
1081                     t,
1082                     plural
1083                 ),
1084             );
1085             if plural == "" {
1086                 let input = unmentioned_fields.iter().map(|field| &field.name);
1087                 let suggested_name = find_best_match_for_name(input, &ident.as_str(), None);
1088                 if let Some(suggested_name) = suggested_name {
1089                     err.span_suggestion(
1090                         ident.span,
1091                         "a field with a similar name exists",
1092                         suggested_name.to_string(),
1093                         Applicability::MaybeIncorrect,
1094                     );
1095
1096                     // we don't want to throw `E0027` in case we have thrown `E0026` for them
1097                     unmentioned_fields.retain(|&x| x.name != suggested_name);
1098                 }
1099             }
1100         }
1101         if tcx.sess.teach(&err.get_code().unwrap()) {
1102             err.note(
1103                 "This error indicates that a struct pattern attempted to \
1104                     extract a non-existent field from a struct. Struct fields \
1105                     are identified by the name used before the colon : so struct \
1106                     patterns should resemble the declaration of the struct type \
1107                     being matched.\n\n\
1108                     If you are using shorthand field patterns but want to refer \
1109                     to the struct field by a different name, you should rename \
1110                     it explicitly.",
1111             );
1112         }
1113         err.emit();
1114     }
1115
1116     fn error_unmentioned_fields(
1117         &self,
1118         span: Span,
1119         unmentioned_fields: &[ast::Ident],
1120         variant: &ty::VariantDef,
1121     ) {
1122         let field_names = if unmentioned_fields.len() == 1 {
1123             format!("field `{}`", unmentioned_fields[0])
1124         } else {
1125             let fields = unmentioned_fields
1126                 .iter()
1127                 .map(|name| format!("`{}`", name))
1128                 .collect::<Vec<String>>()
1129                 .join(", ");
1130             format!("fields {}", fields)
1131         };
1132         let mut diag = struct_span_err!(
1133             self.tcx.sess,
1134             span,
1135             E0027,
1136             "pattern does not mention {}",
1137             field_names
1138         );
1139         diag.span_label(span, format!("missing {}", field_names));
1140         if variant.ctor_kind == CtorKind::Fn {
1141             diag.note("trying to match a tuple variant with a struct variant pattern");
1142         }
1143         if self.tcx.sess.teach(&diag.get_code().unwrap()) {
1144             diag.note(
1145                 "This error indicates that a pattern for a struct fails to specify a \
1146                     sub-pattern for every one of the struct's fields. Ensure that each field \
1147                     from the struct's definition is mentioned in the pattern, or use `..` to \
1148                     ignore unwanted fields.",
1149             );
1150         }
1151         diag.emit();
1152     }
1153
1154     fn check_pat_box(
1155         &self,
1156         span: Span,
1157         inner: &'tcx Pat<'tcx>,
1158         expected: Ty<'tcx>,
1159         def_bm: BindingMode,
1160         ti: TopInfo<'tcx>,
1161     ) -> Ty<'tcx> {
1162         let tcx = self.tcx;
1163         let (box_ty, inner_ty) = if self.check_dereferenceable(span, expected, &inner) {
1164             // Here, `demand::subtype` is good enough, but I don't
1165             // think any errors can be introduced by using `demand::eqtype`.
1166             let inner_ty = self.next_ty_var(TypeVariableOrigin {
1167                 kind: TypeVariableOriginKind::TypeInference,
1168                 span: inner.span,
1169             });
1170             let box_ty = tcx.mk_box(inner_ty);
1171             self.demand_eqtype_pat(span, expected, box_ty, ti);
1172             (box_ty, inner_ty)
1173         } else {
1174             (tcx.types.err, tcx.types.err)
1175         };
1176         self.check_pat(&inner, inner_ty, def_bm, ti);
1177         box_ty
1178     }
1179
1180     fn check_pat_ref(
1181         &self,
1182         pat: &Pat<'_>,
1183         inner: &'tcx Pat<'tcx>,
1184         mutbl: hir::Mutability,
1185         expected: Ty<'tcx>,
1186         def_bm: BindingMode,
1187         ti: TopInfo<'tcx>,
1188     ) -> Ty<'tcx> {
1189         let tcx = self.tcx;
1190         let expected = self.shallow_resolve(expected);
1191         let (rptr_ty, inner_ty) = if self.check_dereferenceable(pat.span, expected, &inner) {
1192             // `demand::subtype` would be good enough, but using `eqtype` turns
1193             // out to be equally general. See (note_1) for details.
1194
1195             // Take region, inner-type from expected type if we can,
1196             // to avoid creating needless variables. This also helps with
1197             // the bad  interactions of the given hack detailed in (note_1).
1198             debug!("check_pat_ref: expected={:?}", expected);
1199             match expected.kind {
1200                 ty::Ref(_, r_ty, r_mutbl) if r_mutbl == mutbl => (expected, r_ty),
1201                 _ => {
1202                     let inner_ty = self.next_ty_var(TypeVariableOrigin {
1203                         kind: TypeVariableOriginKind::TypeInference,
1204                         span: inner.span,
1205                     });
1206                     let rptr_ty = self.new_ref_ty(pat.span, mutbl, inner_ty);
1207                     debug!("check_pat_ref: demanding {:?} = {:?}", expected, rptr_ty);
1208                     let err = self.demand_eqtype_diag(pat.span, expected, rptr_ty);
1209
1210                     // Look for a case like `fn foo(&foo: u32)` and suggest
1211                     // `fn foo(foo: &u32)`
1212                     if let Some(mut err) = err {
1213                         self.borrow_pat_suggestion(&mut err, &pat, &inner, &expected);
1214                         err.emit();
1215                     }
1216                     (rptr_ty, inner_ty)
1217                 }
1218             }
1219         } else {
1220             (tcx.types.err, tcx.types.err)
1221         };
1222         self.check_pat(&inner, inner_ty, def_bm, ti);
1223         rptr_ty
1224     }
1225
1226     /// Create a reference type with a fresh region variable.
1227     fn new_ref_ty(&self, span: Span, mutbl: hir::Mutability, ty: Ty<'tcx>) -> Ty<'tcx> {
1228         let region = self.next_region_var(infer::PatternRegion(span));
1229         let mt = ty::TypeAndMut { ty, mutbl };
1230         self.tcx.mk_ref(region, mt)
1231     }
1232
1233     /// Type check a slice pattern.
1234     ///
1235     /// Syntactically, these look like `[pat_0, ..., pat_n]`.
1236     /// Semantically, we are type checking a pattern with structure:
1237     /// ```
1238     /// [before_0, ..., before_n, (slice, after_0, ... after_n)?]
1239     /// ```
1240     /// The type of `slice`, if it is present, depends on the `expected` type.
1241     /// If `slice` is missing, then so is `after_i`.
1242     /// If `slice` is present, it can still represent 0 elements.
1243     fn check_pat_slice(
1244         &self,
1245         span: Span,
1246         before: &'tcx [&'tcx Pat<'tcx>],
1247         slice: Option<&'tcx Pat<'tcx>>,
1248         after: &'tcx [&'tcx Pat<'tcx>],
1249         expected: Ty<'tcx>,
1250         def_bm: BindingMode,
1251         ti: TopInfo<'tcx>,
1252     ) -> Ty<'tcx> {
1253         let err = self.tcx.types.err;
1254         let expected = self.structurally_resolved_type(span, expected);
1255         let (inner_ty, slice_ty, expected) = match expected.kind {
1256             // An array, so we might have something like `let [a, b, c] = [0, 1, 2];`.
1257             ty::Array(inner_ty, len) => {
1258                 let min = before.len() as u64 + after.len() as u64;
1259                 let slice_ty = self
1260                     .check_array_pat_len(span, slice, len, min)
1261                     .map_or(err, |len| self.tcx.mk_array(inner_ty, len));
1262                 (inner_ty, slice_ty, expected)
1263             }
1264             ty::Slice(inner_ty) => (inner_ty, expected, expected),
1265             // The expected type must be an array or slice, but was neither, so error.
1266             _ => {
1267                 if !expected.references_error() {
1268                     self.error_expected_array_or_slice(span, expected);
1269                 }
1270                 (err, err, err)
1271             }
1272         };
1273
1274         // Type check all the patterns before `slice`.
1275         for elt in before {
1276             self.check_pat(&elt, inner_ty, def_bm, ti);
1277         }
1278         // Type check the `slice`, if present, against its expected type.
1279         if let Some(slice) = slice {
1280             self.check_pat(&slice, slice_ty, def_bm, ti);
1281         }
1282         // Type check the elements after `slice`, if present.
1283         for elt in after {
1284             self.check_pat(&elt, inner_ty, def_bm, ti);
1285         }
1286         expected
1287     }
1288
1289     /// Type check the length of an array pattern.
1290     ///
1291     /// Return the length of the variable length pattern,
1292     /// if it exists and there are no errors.
1293     fn check_array_pat_len(
1294         &self,
1295         span: Span,
1296         slice: Option<&'tcx Pat<'tcx>>,
1297         len: &ty::Const<'tcx>,
1298         min_len: u64,
1299     ) -> Option<u64> {
1300         if let Some(len) = len.try_eval_usize(self.tcx, self.param_env) {
1301             // Now we know the length...
1302             if slice.is_none() {
1303                 // ...and since there is no variable-length pattern,
1304                 // we require an exact match between the number of elements
1305                 // in the array pattern and as provided by the matched type.
1306                 if min_len != len {
1307                     self.error_scrutinee_inconsistent_length(span, min_len, len);
1308                 }
1309             } else if let r @ Some(_) = len.checked_sub(min_len) {
1310                 // The variable-length pattern was there,
1311                 // so it has an array type with the remaining elements left as its size...
1312                 return r;
1313             } else {
1314                 // ...however, in this case, there were no remaining elements.
1315                 // That is, the slice pattern requires more than the array type offers.
1316                 self.error_scrutinee_with_rest_inconsistent_length(span, min_len, len);
1317             }
1318         } else {
1319             // No idea what the length is, which happens if we have e.g.,
1320             // `let [a, b] = arr` where `arr: [T; N]` where `const N: usize`.
1321             self.error_scrutinee_unfixed_length(span);
1322         }
1323         None
1324     }
1325
1326     fn error_scrutinee_inconsistent_length(&self, span: Span, min_len: u64, size: u64) {
1327         struct_span_err!(
1328             self.tcx.sess,
1329             span,
1330             E0527,
1331             "pattern requires {} element{} but array has {}",
1332             min_len,
1333             pluralize!(min_len),
1334             size,
1335         )
1336         .span_label(span, format!("expected {} element{}", size, pluralize!(size)))
1337         .emit();
1338     }
1339
1340     fn error_scrutinee_with_rest_inconsistent_length(&self, span: Span, min_len: u64, size: u64) {
1341         struct_span_err!(
1342             self.tcx.sess,
1343             span,
1344             E0528,
1345             "pattern requires at least {} element{} but array has {}",
1346             min_len,
1347             pluralize!(min_len),
1348             size,
1349         )
1350         .span_label(
1351             span,
1352             format!("pattern cannot match array of {} element{}", size, pluralize!(size),),
1353         )
1354         .emit();
1355     }
1356
1357     fn error_scrutinee_unfixed_length(&self, span: Span) {
1358         struct_span_err!(
1359             self.tcx.sess,
1360             span,
1361             E0730,
1362             "cannot pattern-match on an array without a fixed length",
1363         )
1364         .emit();
1365     }
1366
1367     fn error_expected_array_or_slice(&self, span: Span, expected_ty: Ty<'tcx>) {
1368         let mut err = struct_span_err!(
1369             self.tcx.sess,
1370             span,
1371             E0529,
1372             "expected an array or slice, found `{}`",
1373             expected_ty
1374         );
1375         if let ty::Ref(_, ty, _) = expected_ty.kind {
1376             if let ty::Array(..) | ty::Slice(..) = ty.kind {
1377                 err.help("the semantics of slice patterns changed recently; see issue #62254");
1378             }
1379         }
1380         err.span_label(span, format!("pattern cannot match with input type `{}`", expected_ty));
1381         err.emit();
1382     }
1383 }