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