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};
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::{ObligationCause, Pattern};
13 use rustc_span::hygiene::DesugaringKind;
14 use rustc_span::source_map::{Span, Spanned};
16 use syntax::util::lev_distance::find_best_match_for_name;
19 use std::collections::hash_map::Entry::{Occupied, Vacant};
21 use super::report_unexpected_variant_res;
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.
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";
32 /// Information about the expected type at the top level of type checking a pattern.
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.
39 /// Was the origin of the `span` from a scrutinee expression?
41 /// Otherwise there is no scrutinee and it could be e.g. from the type of a formal parameter.
43 /// The span giving rise to the `expected` type, if one could be provided.
45 /// If `origin_expr` is `true`, then this is the span of the scrutinee as in:
47 /// - `match scrutinee { ... }`
48 /// - `let _ = scrutinee;`
50 /// This is used to point to add context in type errors.
51 /// In the following example, `span` corresponds to the `a + b` expression:
54 /// error[E0308]: mismatched types
55 /// --> src/main.rs:L:C
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`
62 /// = note: expected type `usize`
63 /// found type `std::result::Result<_, _>`
68 impl<'tcx> FnCtxt<'_, 'tcx> {
69 fn pattern_cause(&self, ti: TopInfo<'tcx>, cause_span: Span) -> ObligationCause<'tcx> {
70 let code = Pattern { span: ti.span, root_ty: ti.expected, origin_expr: ti.origin_expr };
71 self.cause(cause_span, code)
74 fn demand_eqtype_pat_diag(
80 ) -> Option<DiagnosticBuilder<'tcx>> {
81 self.demand_eqtype_with_origin(&self.pattern_cause(ti, cause_span), expected, actual)
91 self.demand_eqtype_pat_diag(cause_span, expected, actual, ti).map(|mut err| err.emit());
95 const INITIAL_BM: BindingMode = BindingMode::BindByValue(hir::Mutability::Not);
97 /// Mode for adjusting the expected type and binding mode.
99 /// Peel off all immediate reference types.
101 /// Reset binding mode to the inital mode.
103 /// Pass on the input binding mode and expected type.
107 impl<'a, 'tcx> FnCtxt<'a, 'tcx> {
108 /// Type check the given top level pattern against the `expected` type.
110 /// If a `Some(span)` is provided and `origin_expr` holds,
111 /// then the `span` represents the scrutinee's span.
112 /// The scrutinee is found in e.g. `match scrutinee { ... }` and `let pat = scrutinee;`.
114 /// Otherwise, `Some(span)` represents the span of a type expression
115 /// which originated the `expected` type.
116 pub fn check_pat_top(
118 pat: &'tcx Pat<'tcx>,
123 self.check_pat(pat, expected, INITIAL_BM, TopInfo { expected, origin_expr, span });
126 /// Type check the given `pat` against the `expected` type
127 /// with the provided `def_bm` (default binding mode).
129 /// Outside of this module, `check_pat_top` should always be used.
130 /// Conversely, inside this module, `check_pat_top` should never be used.
133 pat: &'tcx Pat<'tcx>,
138 debug!("check_pat(pat={:?},expected={:?},def_bm={:?})", pat, expected, def_bm);
140 let path_res = match &pat.kind {
141 PatKind::Path(qpath) => Some(self.resolve_ty_and_res_ufcs(qpath, pat.hir_id, pat.span)),
144 let adjust_mode = self.calc_adjust_mode(pat, path_res.map(|(res, ..)| res));
145 let (expected, def_bm) = self.calc_default_binding_mode(pat, expected, def_bm, adjust_mode);
147 let ty = match pat.kind {
148 PatKind::Wild => expected,
149 PatKind::Lit(lt) => self.check_pat_lit(pat.span, lt, expected, ti),
150 PatKind::Range(lhs, rhs, _) => self.check_pat_range(pat.span, lhs, rhs, expected, ti),
151 PatKind::Binding(ba, var_id, _, sub) => {
152 self.check_pat_ident(pat, ba, var_id, sub, expected, def_bm, ti)
154 PatKind::TupleStruct(ref qpath, subpats, ddpos) => {
155 self.check_pat_tuple_struct(pat, qpath, subpats, ddpos, expected, def_bm, ti)
157 PatKind::Path(ref qpath) => {
158 self.check_pat_path(pat, path_res.unwrap(), qpath, expected, ti)
160 PatKind::Struct(ref qpath, fields, etc) => {
161 self.check_pat_struct(pat, qpath, fields, etc, expected, def_bm, ti)
163 PatKind::Or(pats) => {
165 self.check_pat(pat, expected, def_bm, ti);
169 PatKind::Tuple(elements, ddpos) => {
170 self.check_pat_tuple(pat.span, elements, ddpos, expected, def_bm, ti)
172 PatKind::Box(inner) => self.check_pat_box(pat.span, inner, expected, def_bm, ti),
173 PatKind::Ref(inner, mutbl) => {
174 self.check_pat_ref(pat, inner, mutbl, expected, def_bm, ti)
176 PatKind::Slice(before, slice, after) => {
177 self.check_pat_slice(pat.span, before, slice, after, expected, def_bm, ti)
181 self.write_ty(pat.hir_id, ty);
183 // (note_1): In most of the cases where (note_1) is referenced
184 // (literals and constants being the exception), we relate types
185 // using strict equality, even though subtyping would be sufficient.
186 // There are a few reasons for this, some of which are fairly subtle
187 // and which cost me (nmatsakis) an hour or two debugging to remember,
188 // so I thought I'd write them down this time.
190 // 1. There is no loss of expressiveness here, though it does
191 // cause some inconvenience. What we are saying is that the type
192 // of `x` becomes *exactly* what is expected. This can cause unnecessary
193 // errors in some cases, such as this one:
196 // fn foo<'x>(x: &'x int) {
203 // The reason we might get an error is that `z` might be
204 // assigned a type like `&'x int`, and then we would have
205 // a problem when we try to assign `&a` to `z`, because
206 // the lifetime of `&a` (i.e., the enclosing block) is
207 // shorter than `'x`.
209 // HOWEVER, this code works fine. The reason is that the
210 // expected type here is whatever type the user wrote, not
211 // the initializer's type. In this case the user wrote
212 // nothing, so we are going to create a type variable `Z`.
213 // Then we will assign the type of the initializer (`&'x
214 // int`) as a subtype of `Z`: `&'x int <: Z`. And hence we
215 // will instantiate `Z` as a type `&'0 int` where `'0` is
216 // a fresh region variable, with the constraint that `'x :
217 // '0`. So basically we're all set.
219 // Note that there are two tests to check that this remains true
220 // (`regions-reassign-{match,let}-bound-pointer.rs`).
222 // 2. Things go horribly wrong if we use subtype. The reason for
223 // THIS is a fairly subtle case involving bound regions. See the
224 // `givens` field in `region_constraints`, as well as the test
225 // `regions-relate-bound-regions-on-closures-to-inference-variables.rs`,
226 // for details. Short version is that we must sometimes detect
227 // relationships between specific region variables and regions
228 // bound in a closure signature, and that detection gets thrown
229 // off when we substitute fresh region variables here to enable
233 /// Compute the new expected type and default binding mode from the old ones
234 /// as well as the pattern form we are currently checking.
235 fn calc_default_binding_mode(
237 pat: &'tcx Pat<'tcx>,
240 adjust_mode: AdjustMode,
241 ) -> (Ty<'tcx>, BindingMode) {
243 AdjustMode::Pass => (expected, def_bm),
244 AdjustMode::Reset => (expected, INITIAL_BM),
245 AdjustMode::Peel => self.peel_off_references(pat, expected, def_bm),
249 /// How should the binding mode and expected type be adjusted?
251 /// When the pattern is a path pattern, `opt_path_res` must be `Some(res)`.
252 fn calc_adjust_mode(&self, pat: &'tcx Pat<'tcx>, opt_path_res: Option<Res>) -> AdjustMode {
254 // Type checking these product-like types successfully always require
255 // that the expected type be of those types and not reference types.
257 | PatKind::TupleStruct(..)
261 | PatKind::Slice(..) => AdjustMode::Peel,
262 // String and byte-string literals result in types `&str` and `&[u8]` respectively.
263 // All other literals result in non-reference types.
264 // As a result, we allow `if let 0 = &&0 {}` but not `if let "foo" = &&"foo {}`.
265 PatKind::Lit(lt) => match self.check_expr(lt).kind {
266 ty::Ref(..) => AdjustMode::Pass,
267 _ => AdjustMode::Peel,
269 PatKind::Path(_) => match opt_path_res.unwrap() {
270 // These constants can be of a reference type, e.g. `const X: &u8 = &0;`.
271 // Peeling the reference types too early will cause type checking failures.
272 // Although it would be possible to *also* peel the types of the constants too.
273 Res::Def(DefKind::Const, _) | Res::Def(DefKind::AssocConst, _) => AdjustMode::Pass,
274 // In the `ValueNS`, we have `SelfCtor(..) | Ctor(_, Const), _)` remaining which
275 // could successfully compile. The former being `Self` requires a unit struct.
276 // In either case, and unlike constants, the pattern itself cannot be
277 // a reference type wherefore peeling doesn't give up any expressivity.
278 _ => AdjustMode::Peel,
280 // When encountering a `& mut? pat` pattern, reset to "by value".
281 // This is so that `x` and `y` here are by value, as they appear to be:
284 // match &(&22, &44) {
290 PatKind::Ref(..) => AdjustMode::Reset,
291 // A `_` pattern works with any expected type, so there's no need to do anything.
293 // Bindings also work with whatever the expected type is,
294 // and moreover if we peel references off, that will give us the wrong binding type.
295 // Also, we can have a subpattern `binding @ pat`.
296 // Each side of the `@` should be treated independently (like with OR-patterns).
297 | PatKind::Binding(..)
298 // An OR-pattern just propagates to each individual alternative.
299 // This is maximally flexible, allowing e.g., `Some(mut x) | &Some(mut x)`.
300 // In that example, `Some(mut x)` results in `Peel` whereas `&Some(mut x)` in `Reset`.
301 | PatKind::Or(_) => AdjustMode::Pass,
305 /// Peel off as many immediately nested `& mut?` from the expected type as possible
306 /// and return the new expected type and binding default binding mode.
307 /// The adjustments vector, if non-empty is stored in a table.
308 fn peel_off_references(
310 pat: &'tcx Pat<'tcx>,
312 mut def_bm: BindingMode,
313 ) -> (Ty<'tcx>, BindingMode) {
314 let mut expected = self.resolve_vars_with_obligations(&expected);
316 // Peel off as many `&` or `&mut` from the scrutinee type as possible. For example,
317 // for `match &&&mut Some(5)` the loop runs three times, aborting when it reaches
318 // the `Some(5)` which is not of type Ref.
320 // For each ampersand peeled off, update the binding mode and push the original
321 // type into the adjustments vector.
323 // See the examples in `ui/match-defbm*.rs`.
324 let mut pat_adjustments = vec![];
325 while let ty::Ref(_, inner_ty, inner_mutability) = expected.kind {
326 debug!("inspecting {:?}", expected);
328 debug!("current discriminant is Ref, inserting implicit deref");
329 // Preserve the reference type. We'll need it later during HAIR lowering.
330 pat_adjustments.push(expected);
333 def_bm = ty::BindByReference(match def_bm {
334 // If default binding mode is by value, make it `ref` or `ref mut`
335 // (depending on whether we observe `&` or `&mut`).
337 // When `ref mut`, stay a `ref mut` (on `&mut`) or downgrade to `ref` (on `&`).
338 ty::BindByReference(hir::Mutability::Mut) => inner_mutability,
339 // Once a `ref`, always a `ref`.
340 // This is because a `& &mut` cannot mutate the underlying value.
341 ty::BindByReference(m @ hir::Mutability::Not) => m,
345 if pat_adjustments.len() > 0 {
346 debug!("default binding mode is now {:?}", def_bm);
347 self.inh.tables.borrow_mut().pat_adjustments_mut().insert(pat.hir_id, pat_adjustments);
356 lt: &hir::Expr<'tcx>,
360 // We've already computed the type above (when checking for a non-ref pat),
361 // so avoid computing it again.
362 let ty = self.node_ty(lt.hir_id);
364 // Byte string patterns behave the same way as array patterns
365 // They can denote both statically and dynamically-sized byte arrays.
367 if let hir::ExprKind::Lit(Spanned { node: ast::LitKind::ByteStr(_), .. }) = lt.kind {
368 let expected = self.structurally_resolved_type(span, expected);
369 if let ty::Ref(_, ty::TyS { kind: ty::Slice(_), .. }, _) = expected.kind {
371 pat_ty = tcx.mk_imm_ref(tcx.lifetimes.re_static, tcx.mk_slice(tcx.types.u8));
375 // Somewhat surprising: in this case, the subtyping relation goes the
376 // opposite way as the other cases. Actually what we really want is not
377 // a subtyping relation at all but rather that there exists a LUB
378 // (so that they can be compared). However, in practice, constants are
379 // always scalars or strings. For scalars subtyping is irrelevant,
380 // and for strings `ty` is type is `&'static str`, so if we say that
382 // &'static str <: expected
384 // then that's equivalent to there existing a LUB.
385 let cause = self.pattern_cause(ti, span);
386 if let Some(mut err) = self.demand_suptype_with_origin(&cause, expected, pat_ty) {
390 // In the case of `if`- and `while`-expressions we've already checked
391 // that `scrutinee: bool`. We know that the pattern is `true`,
392 // so an error here would be a duplicate and from the wrong POV.
393 s.is_desugaring(DesugaringKind::CondTemporary)
405 lhs: Option<&'tcx hir::Expr<'tcx>>,
406 rhs: Option<&'tcx hir::Expr<'tcx>>,
410 let calc_side = |opt_expr: Option<&'tcx hir::Expr<'tcx>>| match opt_expr {
411 None => (None, None),
413 let ty = self.check_expr(expr);
414 // Check that the end-point is of numeric or char type.
415 let fail = !(ty.is_numeric() || ty.is_char() || ty.references_error());
416 (Some(ty), Some((fail, ty, expr.span)))
419 let (lhs_ty, lhs) = calc_side(lhs);
420 let (rhs_ty, rhs) = calc_side(rhs);
422 if let (Some((true, ..)), _) | (_, Some((true, ..))) = (lhs, rhs) {
423 // There exists a side that didn't meet our criteria that the end-point
424 // be of a numeric or char type, as checked in `calc_side` above.
425 self.emit_err_pat_range(span, lhs, rhs);
426 return self.tcx.types.err;
429 // Now that we know the types can be unified we find the unified type
430 // and use it to type the entire expression.
431 let common_type = self.resolve_vars_if_possible(&lhs_ty.or(rhs_ty).unwrap_or(expected));
433 // Subtyping doesn't matter here, as the value is some kind of scalar.
434 let demand_eqtype = |x, y| {
435 if let Some((_, x_ty, x_span)) = x {
436 self.demand_eqtype_pat_diag(x_span, expected, x_ty, ti).map(|mut err| {
437 if let Some((_, y_ty, y_span)) = y {
438 self.endpoint_has_type(&mut err, y_span, y_ty);
444 demand_eqtype(lhs, rhs);
445 demand_eqtype(rhs, lhs);
450 fn endpoint_has_type(&self, err: &mut DiagnosticBuilder<'_>, span: Span, ty: Ty<'_>) {
451 if !ty.references_error() {
452 err.span_label(span, &format!("this is of type `{}`", ty));
456 fn emit_err_pat_range(
459 lhs: Option<(bool, Ty<'tcx>, Span)>,
460 rhs: Option<(bool, Ty<'tcx>, Span)>,
462 let span = match (lhs, rhs) {
463 (Some((true, ..)), Some((true, ..))) => span,
464 (Some((true, _, sp)), _) => sp,
465 (_, Some((true, _, sp))) => sp,
466 _ => span_bug!(span, "emit_err_pat_range: no side failed or exists but still error?"),
468 let mut err = struct_span_err!(
472 "only char and numeric types are allowed in range patterns"
474 let msg = |ty| format!("this is of type `{}` but it should be `char` or numeric", ty);
475 let mut one_side_err = |first_span, first_ty, second: Option<(bool, Ty<'tcx>, Span)>| {
476 err.span_label(first_span, &msg(first_ty));
477 if let Some((_, ty, sp)) = second {
478 self.endpoint_has_type(&mut err, sp, ty);
482 (Some((true, lhs_ty, lhs_sp)), Some((true, rhs_ty, rhs_sp))) => {
483 err.span_label(lhs_sp, &msg(lhs_ty));
484 err.span_label(rhs_sp, &msg(rhs_ty));
486 (Some((true, lhs_ty, lhs_sp)), rhs) => one_side_err(lhs_sp, lhs_ty, rhs),
487 (lhs, Some((true, rhs_ty, rhs_sp))) => one_side_err(rhs_sp, rhs_ty, lhs),
488 _ => span_bug!(span, "Impossible, verified above."),
490 if self.tcx.sess.teach(&err.get_code().unwrap()) {
492 "In a match expression, only numbers and characters can be matched \
493 against a range. This is because the compiler checks that the range \
494 is non-empty at compile-time, and is unable to evaluate arbitrary \
495 comparison functions. If you want to capture values of an orderable \
496 type between two end-points, you can use a guard.",
505 ba: hir::BindingAnnotation,
507 sub: Option<&'tcx Pat<'tcx>>,
512 // Determine the binding mode...
514 hir::BindingAnnotation::Unannotated => def_bm,
515 _ => BindingMode::convert(ba),
517 // ...and store it in a side table:
518 self.inh.tables.borrow_mut().pat_binding_modes_mut().insert(pat.hir_id, bm);
520 debug!("check_pat_ident: pat.hir_id={:?} bm={:?}", pat.hir_id, bm);
522 let local_ty = self.local_ty(pat.span, pat.hir_id).decl_ty;
523 let eq_ty = match bm {
524 ty::BindByReference(mutbl) => {
525 // If the binding is like `ref x | ref mut x`,
526 // then `x` is assigned a value of type `&M T` where M is the
527 // mutability and T is the expected type.
529 // `x` is assigned a value of type `&M T`, hence `&M T <: typeof(x)`
530 // is required. However, we use equality, which is stronger.
531 // See (note_1) for an explanation.
532 self.new_ref_ty(pat.span, mutbl, expected)
534 // Otherwise, the type of x is the expected type `T`.
535 ty::BindByValue(_) => {
536 // As above, `T <: typeof(x)` is required, but we use equality, see (note_1).
540 self.demand_eqtype_pat(pat.span, eq_ty, local_ty, ti);
542 // If there are multiple arms, make sure they all agree on
543 // what the type of the binding `x` ought to be.
544 if var_id != pat.hir_id {
545 self.check_binding_alt_eq_ty(pat.span, var_id, local_ty, ti);
548 if let Some(p) = sub {
549 self.check_pat(&p, expected, def_bm, ti);
555 fn check_binding_alt_eq_ty(&self, span: Span, var_id: HirId, ty: Ty<'tcx>, ti: TopInfo<'tcx>) {
556 let var_ty = self.local_ty(span, var_id).decl_ty;
557 if let Some(mut err) = self.demand_eqtype_pat_diag(span, var_ty, ty, ti) {
558 let hir = self.tcx.hir();
559 let var_ty = self.resolve_vars_with_obligations(var_ty);
560 let msg = format!("first introduced with type `{}` here", var_ty);
561 err.span_label(hir.span(var_id), msg);
562 let in_arm = hir.parent_iter(var_id).any(|(_, n)| matches!(n, hir::Node::Arm(..)));
563 let pre = if in_arm { "in the same arm, " } else { "" };
564 err.note(&format!("{}a binding must have the same type in all alternatives", pre));
569 fn borrow_pat_suggestion(
571 err: &mut DiagnosticBuilder<'_>,
577 if let PatKind::Binding(..) = inner.kind {
578 let binding_parent_id = tcx.hir().get_parent_node(pat.hir_id);
579 let binding_parent = tcx.hir().get(binding_parent_id);
580 debug!("inner {:?} pat {:?} parent {:?}", inner, pat, binding_parent);
581 match binding_parent {
582 hir::Node::Param(hir::Param { span, .. }) => {
583 if let Ok(snippet) = tcx.sess.source_map().span_to_snippet(inner.span) {
586 &format!("did you mean `{}`", snippet),
587 format!(" &{}", expected),
588 Applicability::MachineApplicable,
592 hir::Node::Arm(_) | hir::Node::Pat(_) => {
593 // rely on match ergonomics or it might be nested `&&pat`
594 if let Ok(snippet) = tcx.sess.source_map().span_to_snippet(inner.span) {
597 "you can probably remove the explicit borrow",
599 Applicability::MaybeIncorrect,
603 _ => {} // don't provide suggestions in other cases #55175
608 pub fn check_dereferenceable(&self, span: Span, expected: Ty<'tcx>, inner: &Pat<'_>) -> bool {
609 if let PatKind::Binding(..) = inner.kind {
610 if let Some(mt) = self.shallow_resolve(expected).builtin_deref(true) {
611 if let ty::Dynamic(..) = mt.ty.kind {
612 // This is "x = SomeTrait" being reduced from
613 // "let &x = &SomeTrait" or "let box x = Box<SomeTrait>", an error.
614 let type_str = self.ty_to_string(expected);
615 let mut err = struct_span_err!(
619 "type `{}` cannot be dereferenced",
622 err.span_label(span, format!("type `{}` cannot be dereferenced", type_str));
623 if self.tcx.sess.teach(&err.get_code().unwrap()) {
624 err.note(CANNOT_IMPLICITLY_DEREF_POINTER_TRAIT_OBJ);
636 pat: &'tcx Pat<'tcx>,
637 qpath: &hir::QPath<'_>,
638 fields: &'tcx [hir::FieldPat<'tcx>],
644 // Resolve the path and check the definition for errors.
645 let (variant, pat_ty) = if let Some(variant_ty) = self.check_struct_path(qpath, pat.hir_id)
649 for field in fields {
650 self.check_pat(&field.pat, self.tcx.types.err, def_bm, ti);
652 return self.tcx.types.err;
655 // Type-check the path.
656 self.demand_eqtype_pat(pat.span, expected, pat_ty, ti);
658 // Type-check subpatterns.
660 .check_struct_pat_fields(pat_ty, pat.hir_id, pat.span, variant, fields, etc, def_bm, ti)
671 path_resolution: (Res, Option<Ty<'tcx>>, &'b [hir::PathSegment<'b>]),
672 qpath: &hir::QPath<'_>,
678 // We have already resolved the path.
679 let (res, opt_ty, segments) = path_resolution;
682 self.set_tainted_by_errors();
683 return tcx.types.err;
685 Res::Def(DefKind::Method, _)
686 | Res::Def(DefKind::Ctor(_, CtorKind::Fictive), _)
687 | Res::Def(DefKind::Ctor(_, CtorKind::Fn), _) => {
688 report_unexpected_variant_res(tcx, res, pat.span, qpath);
689 return tcx.types.err;
691 Res::Def(DefKind::Ctor(_, CtorKind::Const), _)
693 | Res::Def(DefKind::Const, _)
694 | Res::Def(DefKind::AssocConst, _) => {} // OK
695 _ => bug!("unexpected pattern resolution: {:?}", res),
698 // Type-check the path.
699 let pat_ty = self.instantiate_value_path(segments, opt_ty, res, pat.span, pat.hir_id).0;
700 if let Some(mut err) =
701 self.demand_suptype_with_origin(&self.pattern_cause(ti, pat.span), expected, pat_ty)
708 fn check_pat_tuple_struct(
711 qpath: &hir::QPath<'_>,
712 subpats: &'tcx [&'tcx Pat<'tcx>],
713 ddpos: Option<usize>,
721 self.check_pat(&pat, tcx.types.err, def_bm, ti);
724 let report_unexpected_res = |res: Res| {
726 "expected tuple struct or tuple variant, found {} `{}`",
728 hir::print::to_string(&tcx.hir(), |s| s.print_qpath(qpath, false)),
730 let mut err = struct_span_err!(tcx.sess, pat.span, E0164, "{}", msg);
731 match (res, &pat.kind) {
732 (Res::Def(DefKind::Fn, _), _) | (Res::Def(DefKind::Method, _), _) => {
733 err.span_label(pat.span, "`fn` calls are not allowed in patterns");
735 "for more information, visit \
736 https://doc.rust-lang.org/book/ch18-00-patterns.html",
740 err.span_label(pat.span, "not a tuple variant or struct");
747 // Resolve the path and check the definition for errors.
748 let (res, opt_ty, segments) = self.resolve_ty_and_res_ufcs(qpath, pat.hir_id, pat.span);
750 self.set_tainted_by_errors();
752 return self.tcx.types.err;
755 // Type-check the path.
757 self.instantiate_value_path(segments, opt_ty, res, pat.span, pat.hir_id);
759 report_unexpected_res(res);
760 return tcx.types.err;
763 let variant = match res {
765 self.set_tainted_by_errors();
767 return tcx.types.err;
769 Res::Def(DefKind::AssocConst, _) | Res::Def(DefKind::Method, _) => {
770 report_unexpected_res(res);
771 return tcx.types.err;
773 Res::Def(DefKind::Ctor(_, CtorKind::Fn), _) => tcx.expect_variant_res(res),
774 _ => bug!("unexpected pattern resolution: {:?}", res),
777 // Replace constructor type with constructed type for tuple struct patterns.
778 let pat_ty = pat_ty.fn_sig(tcx).output();
779 let pat_ty = pat_ty.no_bound_vars().expect("expected fn type");
781 // Type-check the tuple struct pattern against the expected type.
782 let diag = self.demand_eqtype_pat_diag(pat.span, expected, pat_ty, ti);
783 let had_err = diag.is_some();
784 diag.map(|mut err| err.emit());
786 // Type-check subpatterns.
787 if subpats.len() == variant.fields.len()
788 || subpats.len() < variant.fields.len() && ddpos.is_some()
790 let substs = match pat_ty.kind {
791 ty::Adt(_, substs) => substs,
792 _ => bug!("unexpected pattern type {:?}", pat_ty),
794 for (i, subpat) in subpats.iter().enumerate_and_adjust(variant.fields.len(), ddpos) {
795 let field_ty = self.field_ty(subpat.span, &variant.fields[i], substs);
796 self.check_pat(&subpat, field_ty, def_bm, ti);
798 self.tcx.check_stability(variant.fields[i].did, Some(pat.hir_id), subpat.span);
801 // Pattern has wrong number of fields.
802 self.e0023(pat.span, res, qpath, subpats, &variant.fields, expected, had_err);
804 return tcx.types.err;
813 qpath: &hir::QPath<'_>,
814 subpats: &'tcx [&'tcx Pat<'tcx>],
815 fields: &'tcx [ty::FieldDef],
819 let subpats_ending = pluralize!(subpats.len());
820 let fields_ending = pluralize!(fields.len());
821 let res_span = self.tcx.def_span(res.def_id());
822 let mut err = struct_span_err!(
826 "this pattern has {} field{}, but the corresponding {} has {} field{}",
835 format!("expected {} field{}, found {}", fields.len(), fields_ending, subpats.len(),),
837 .span_label(res_span, format!("{} defined here", res.descr()));
839 // Identify the case `Some(x, y)` where the expected type is e.g. `Option<(T, U)>`.
840 // More generally, the expected type wants a tuple variant with one field of an
841 // N-arity-tuple, e.g., `V_i((p_0, .., p_N))`. Meanwhile, the user supplied a pattern
842 // with the subpatterns directly in the tuple variant pattern, e.g., `V_i(p_0, .., p_N)`.
843 let missing_parenthesis = match (&expected.kind, fields, had_err) {
844 // #67037: only do this if we could sucessfully type-check the expected type against
845 // the tuple struct pattern. Otherwise the substs could get out of range on e.g.,
846 // `let P() = U;` where `P != U` with `struct P<T>(T);`.
847 (ty::Adt(_, substs), [field], false) => {
848 let field_ty = self.field_ty(pat_span, field, substs);
849 match field_ty.kind {
850 ty::Tuple(_) => field_ty.tuple_fields().count() == subpats.len(),
856 if missing_parenthesis {
857 let (left, right) = match subpats {
858 // This is the zero case; we aim to get the "hi" part of the `QPath`'s
859 // span as the "lo" and then the "hi" part of the pattern's span as the "hi".
862 // help: missing parenthesis
864 // L | let A(()) = A(());
867 let qpath_span = match qpath {
868 hir::QPath::Resolved(_, path) => path.span,
869 hir::QPath::TypeRelative(_, ps) => ps.ident.span,
871 (qpath_span.shrink_to_hi(), pat_span)
873 // Easy case. Just take the "lo" of the first sub-pattern and the "hi" of the
874 // last sub-pattern. In the case of `A(x)` the first and last may coincide.
877 // help: missing parenthesis
879 // L | let A((x, y)) = A((1, 2));
881 [first, ..] => (first.span.shrink_to_lo(), subpats.last().unwrap().span),
883 err.multipart_suggestion(
884 "missing parenthesis",
885 vec![(left, "(".to_string()), (right.shrink_to_hi(), ")".to_string())],
886 Applicability::MachineApplicable,
896 elements: &'tcx [&'tcx Pat<'tcx>],
897 ddpos: Option<usize>,
903 let mut expected_len = elements.len();
905 // Require known type only when `..` is present.
906 if let ty::Tuple(ref tys) = self.structurally_resolved_type(span, expected).kind {
907 expected_len = tys.len();
910 let max_len = cmp::max(expected_len, elements.len());
912 let element_tys_iter = (0..max_len).map(|_| {
913 GenericArg::from(self.next_ty_var(
914 // FIXME: `MiscVariable` for now -- obtaining the span and name information
915 // from all tuple elements isn't trivial.
916 TypeVariableOrigin { kind: TypeVariableOriginKind::TypeInference, span },
919 let element_tys = tcx.mk_substs(element_tys_iter);
920 let pat_ty = tcx.mk_ty(ty::Tuple(element_tys));
921 if let Some(mut err) = self.demand_eqtype_pat_diag(span, expected, pat_ty, ti) {
923 // Walk subpatterns with an expected type of `err` in this case to silence
924 // further errors being emitted when using the bindings. #50333
925 let element_tys_iter = (0..max_len).map(|_| tcx.types.err);
926 for (_, elem) in elements.iter().enumerate_and_adjust(max_len, ddpos) {
927 self.check_pat(elem, &tcx.types.err, def_bm, ti);
929 tcx.mk_tup(element_tys_iter)
931 for (i, elem) in elements.iter().enumerate_and_adjust(max_len, ddpos) {
932 self.check_pat(elem, &element_tys[i].expect_ty(), def_bm, ti);
938 fn check_struct_pat_fields(
943 variant: &'tcx ty::VariantDef,
944 fields: &'tcx [hir::FieldPat<'tcx>],
951 let (substs, adt) = match adt_ty.kind {
952 ty::Adt(adt, substs) => (substs, adt),
953 _ => span_bug!(span, "struct pattern is not an ADT"),
955 let kind_name = adt.variant_descr();
957 // Index the struct fields' types.
958 let field_map = variant
962 .map(|(i, field)| (field.ident.modern(), (i, field)))
963 .collect::<FxHashMap<_, _>>();
965 // Keep track of which fields have already appeared in the pattern.
966 let mut used_fields = FxHashMap::default();
967 let mut no_field_errors = true;
969 let mut inexistent_fields = vec![];
970 // Typecheck each field.
971 for field in fields {
972 let span = field.span;
973 let ident = tcx.adjust_ident(field.ident, variant.def_id);
974 let field_ty = match used_fields.entry(ident) {
975 Occupied(occupied) => {
976 self.error_field_already_bound(span, field.ident, *occupied.get());
977 no_field_errors = false;
985 self.write_field_index(field.hir_id, *i);
986 self.tcx.check_stability(f.did, Some(pat_id), span);
987 self.field_ty(span, f, substs)
990 inexistent_fields.push(field.ident);
991 no_field_errors = false;
997 self.check_pat(&field.pat, field_ty, def_bm, ti);
1000 let mut unmentioned_fields = variant
1003 .map(|field| field.ident.modern())
1004 .filter(|ident| !used_fields.contains_key(&ident))
1005 .collect::<Vec<_>>();
1007 if inexistent_fields.len() > 0 && !variant.recovered {
1008 self.error_inexistent_fields(
1011 &mut unmentioned_fields,
1016 // Require `..` if struct has non_exhaustive attribute.
1017 if variant.is_field_list_non_exhaustive() && !adt.did.is_local() && !etc {
1022 "`..` required with {} marked as non-exhaustive",
1028 // Report an error if incorrect number of the fields were specified.
1029 if kind_name == "union" {
1030 if fields.len() != 1 {
1032 .struct_span_err(span, "union patterns should have exactly one field")
1036 tcx.sess.struct_span_err(span, "`..` cannot be used in union patterns").emit();
1038 } else if !etc && unmentioned_fields.len() > 0 {
1039 self.error_unmentioned_fields(span, &unmentioned_fields, variant);
1044 fn error_field_already_bound(&self, span: Span, ident: ast::Ident, other_field: Span) {
1049 "field `{}` bound multiple times in the pattern",
1052 .span_label(span, format!("multiple uses of `{}` in pattern", ident))
1053 .span_label(other_field, format!("first use of `{}`", ident))
1057 fn error_inexistent_fields(
1060 inexistent_fields: &[ast::Ident],
1061 unmentioned_fields: &mut Vec<ast::Ident>,
1062 variant: &ty::VariantDef,
1065 let (field_names, t, plural) = if inexistent_fields.len() == 1 {
1066 (format!("a field named `{}`", inexistent_fields[0]), "this", "")
1073 .map(|ident| format!("`{}`", ident))
1074 .collect::<Vec<String>>()
1081 let spans = inexistent_fields.iter().map(|ident| ident.span).collect::<Vec<_>>();
1082 let mut err = struct_span_err!(
1086 "{} `{}` does not have {}",
1088 tcx.def_path_str(variant.def_id),
1091 if let Some(ident) = inexistent_fields.last() {
1095 "{} `{}` does not have {} field{}",
1097 tcx.def_path_str(variant.def_id),
1103 let input = unmentioned_fields.iter().map(|field| &field.name);
1104 let suggested_name = find_best_match_for_name(input, &ident.as_str(), None);
1105 if let Some(suggested_name) = suggested_name {
1106 err.span_suggestion(
1108 "a field with a similar name exists",
1109 suggested_name.to_string(),
1110 Applicability::MaybeIncorrect,
1113 // we don't want to throw `E0027` in case we have thrown `E0026` for them
1114 unmentioned_fields.retain(|&x| x.name != suggested_name);
1118 if tcx.sess.teach(&err.get_code().unwrap()) {
1120 "This error indicates that a struct pattern attempted to \
1121 extract a non-existent field from a struct. Struct fields \
1122 are identified by the name used before the colon : so struct \
1123 patterns should resemble the declaration of the struct type \
1125 If you are using shorthand field patterns but want to refer \
1126 to the struct field by a different name, you should rename \
1133 fn error_unmentioned_fields(
1136 unmentioned_fields: &[ast::Ident],
1137 variant: &ty::VariantDef,
1139 let field_names = if unmentioned_fields.len() == 1 {
1140 format!("field `{}`", unmentioned_fields[0])
1142 let fields = unmentioned_fields
1144 .map(|name| format!("`{}`", name))
1145 .collect::<Vec<String>>()
1147 format!("fields {}", fields)
1149 let mut diag = struct_span_err!(
1153 "pattern does not mention {}",
1156 diag.span_label(span, format!("missing {}", field_names));
1157 if variant.ctor_kind == CtorKind::Fn {
1158 diag.note("trying to match a tuple variant with a struct variant pattern");
1160 if self.tcx.sess.teach(&diag.get_code().unwrap()) {
1162 "This error indicates that a pattern for a struct fails to specify a \
1163 sub-pattern for every one of the struct's fields. Ensure that each field \
1164 from the struct's definition is mentioned in the pattern, or use `..` to \
1165 ignore unwanted fields.",
1174 inner: &'tcx Pat<'tcx>,
1176 def_bm: BindingMode,
1180 let (box_ty, inner_ty) = if self.check_dereferenceable(span, expected, &inner) {
1181 // Here, `demand::subtype` is good enough, but I don't
1182 // think any errors can be introduced by using `demand::eqtype`.
1183 let inner_ty = self.next_ty_var(TypeVariableOrigin {
1184 kind: TypeVariableOriginKind::TypeInference,
1187 let box_ty = tcx.mk_box(inner_ty);
1188 self.demand_eqtype_pat(span, expected, box_ty, ti);
1191 (tcx.types.err, tcx.types.err)
1193 self.check_pat(&inner, inner_ty, def_bm, ti);
1200 inner: &'tcx Pat<'tcx>,
1201 mutbl: hir::Mutability,
1203 def_bm: BindingMode,
1207 let expected = self.shallow_resolve(expected);
1208 let (rptr_ty, inner_ty) = if self.check_dereferenceable(pat.span, expected, &inner) {
1209 // `demand::subtype` would be good enough, but using `eqtype` turns
1210 // out to be equally general. See (note_1) for details.
1212 // Take region, inner-type from expected type if we can,
1213 // to avoid creating needless variables. This also helps with
1214 // the bad interactions of the given hack detailed in (note_1).
1215 debug!("check_pat_ref: expected={:?}", expected);
1216 match expected.kind {
1217 ty::Ref(_, r_ty, r_mutbl) if r_mutbl == mutbl => (expected, r_ty),
1219 let inner_ty = self.next_ty_var(TypeVariableOrigin {
1220 kind: TypeVariableOriginKind::TypeInference,
1223 let rptr_ty = self.new_ref_ty(pat.span, mutbl, inner_ty);
1224 debug!("check_pat_ref: demanding {:?} = {:?}", expected, rptr_ty);
1225 let err = self.demand_eqtype_diag(pat.span, expected, rptr_ty);
1227 // Look for a case like `fn foo(&foo: u32)` and suggest
1228 // `fn foo(foo: &u32)`
1229 if let Some(mut err) = err {
1230 self.borrow_pat_suggestion(&mut err, &pat, &inner, &expected);
1237 (tcx.types.err, tcx.types.err)
1239 self.check_pat(&inner, inner_ty, def_bm, ti);
1243 /// Create a reference type with a fresh region variable.
1244 fn new_ref_ty(&self, span: Span, mutbl: hir::Mutability, ty: Ty<'tcx>) -> Ty<'tcx> {
1245 let region = self.next_region_var(infer::PatternRegion(span));
1246 let mt = ty::TypeAndMut { ty, mutbl };
1247 self.tcx.mk_ref(region, mt)
1250 /// Type check a slice pattern.
1252 /// Syntactically, these look like `[pat_0, ..., pat_n]`.
1253 /// Semantically, we are type checking a pattern with structure:
1255 /// [before_0, ..., before_n, (slice, after_0, ... after_n)?]
1257 /// The type of `slice`, if it is present, depends on the `expected` type.
1258 /// If `slice` is missing, then so is `after_i`.
1259 /// If `slice` is present, it can still represent 0 elements.
1263 before: &'tcx [&'tcx Pat<'tcx>],
1264 slice: Option<&'tcx Pat<'tcx>>,
1265 after: &'tcx [&'tcx Pat<'tcx>],
1267 def_bm: BindingMode,
1270 let err = self.tcx.types.err;
1271 let expected = self.structurally_resolved_type(span, expected);
1272 let (inner_ty, slice_ty, expected) = match expected.kind {
1273 // An array, so we might have something like `let [a, b, c] = [0, 1, 2];`.
1274 ty::Array(inner_ty, len) => {
1275 let min = before.len() as u64 + after.len() as u64;
1277 .check_array_pat_len(span, slice, len, min)
1278 .map_or(err, |len| self.tcx.mk_array(inner_ty, len));
1279 (inner_ty, slice_ty, expected)
1281 ty::Slice(inner_ty) => (inner_ty, expected, expected),
1282 // The expected type must be an array or slice, but was neither, so error.
1284 if !expected.references_error() {
1285 self.error_expected_array_or_slice(span, expected);
1291 // Type check all the patterns before `slice`.
1293 self.check_pat(&elt, inner_ty, def_bm, ti);
1295 // Type check the `slice`, if present, against its expected type.
1296 if let Some(slice) = slice {
1297 self.check_pat(&slice, slice_ty, def_bm, ti);
1299 // Type check the elements after `slice`, if present.
1301 self.check_pat(&elt, inner_ty, def_bm, ti);
1306 /// Type check the length of an array pattern.
1308 /// Return the length of the variable length pattern,
1309 /// if it exists and there are no errors.
1310 fn check_array_pat_len(
1313 slice: Option<&'tcx Pat<'tcx>>,
1314 len: &ty::Const<'tcx>,
1317 if let Some(len) = len.try_eval_usize(self.tcx, self.param_env) {
1318 // Now we know the length...
1319 if slice.is_none() {
1320 // ...and since there is no variable-length pattern,
1321 // we require an exact match between the number of elements
1322 // in the array pattern and as provided by the matched type.
1324 self.error_scrutinee_inconsistent_length(span, min_len, len);
1326 } else if let r @ Some(_) = len.checked_sub(min_len) {
1327 // The variable-length pattern was there,
1328 // so it has an array type with the remaining elements left as its size...
1331 // ...however, in this case, there were no remaining elements.
1332 // That is, the slice pattern requires more than the array type offers.
1333 self.error_scrutinee_with_rest_inconsistent_length(span, min_len, len);
1336 // No idea what the length is, which happens if we have e.g.,
1337 // `let [a, b] = arr` where `arr: [T; N]` where `const N: usize`.
1338 self.error_scrutinee_unfixed_length(span);
1343 fn error_scrutinee_inconsistent_length(&self, span: Span, min_len: u64, size: u64) {
1348 "pattern requires {} element{} but array has {}",
1350 pluralize!(min_len),
1353 .span_label(span, format!("expected {} element{}", size, pluralize!(size)))
1357 fn error_scrutinee_with_rest_inconsistent_length(&self, span: Span, min_len: u64, size: u64) {
1362 "pattern requires at least {} element{} but array has {}",
1364 pluralize!(min_len),
1369 format!("pattern cannot match array of {} element{}", size, pluralize!(size),),
1374 fn error_scrutinee_unfixed_length(&self, span: Span) {
1379 "cannot pattern-match on an array without a fixed length",
1384 fn error_expected_array_or_slice(&self, span: Span, expected_ty: Ty<'tcx>) {
1385 let mut err = struct_span_err!(
1389 "expected an array or slice, found `{}`",
1392 if let ty::Ref(_, ty, _) = expected_ty.kind {
1393 if let ty::Array(..) | ty::Slice(..) = ty.kind {
1394 err.help("the semantics of slice patterns changed recently; see issue #62254");
1397 err.span_label(span, format!("pattern cannot match with input type `{}`", expected_ty));