clippy_lints/src/matches.rs

   1 use crate::consts::{constant, miri_to_const, Constant};
   2 use crate::utils::sugg::Sugg;
   3 use crate::utils::usage::is_unused;
   4 use crate::utils::{
   5     expr_block, get_arg_name, get_parent_expr, in_macro, indent_of, is_allowed, is_expn_of, is_refutable,
   6     is_type_diagnostic_item, is_wild, match_qpath, match_type, match_var, meets_msrv, multispan_sugg, remove_blocks,
   7     snippet, snippet_block, snippet_opt, snippet_with_applicability, span_lint_and_help, span_lint_and_note,
   8     span_lint_and_sugg, span_lint_and_then,
   9 };
  10 use crate::utils::{paths, search_same, SpanlessEq, SpanlessHash};
  11 use if_chain::if_chain;
  12 use rustc_ast::ast::LitKind;
  13 use rustc_data_structures::fx::FxHashMap;
  14 use rustc_errors::Applicability;
  15 use rustc_hir::def::CtorKind;
  16 use rustc_hir::{
  17     Arm, BindingAnnotation, Block, BorrowKind, Expr, ExprKind, Guard, Local, MatchSource, Mutability, Node, Pat,
  18     PatKind, QPath, RangeEnd,
  19 };
  20 use rustc_lint::{LateContext, LateLintPass, LintContext};
  21 use rustc_middle::lint::in_external_macro;
  22 use rustc_middle::ty::{self, Ty, TyS};
  23 use rustc_semver::RustcVersion;
  24 use rustc_session::{declare_tool_lint, impl_lint_pass};
  25 use rustc_span::source_map::{Span, Spanned};
  26 use rustc_span::{sym, Symbol};
  27 use std::cmp::Ordering;
  28 use std::collections::hash_map::Entry;
  29 use std::collections::Bound;
  30
  31 declare_clippy_lint! {
  32     /// **What it does:** Checks for matches with a single arm where an `if let`
  33     /// will usually suffice.
  34     ///
  35     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  36     ///
  37     /// **Known problems:** None.
  38     ///
  39     /// **Example:**
  40     /// ```rust
  41     /// # fn bar(stool: &str) {}
  42     /// # let x = Some("abc");
  43     /// // Bad
  44     /// match x {
  45     ///     Some(ref foo) => bar(foo),
  46     ///     _ => (),
  47     /// }
  48     ///
  49     /// // Good
  50     /// if let Some(ref foo) = x {
  51     ///     bar(foo);
  52     /// }
  53     /// ```
  54     pub SINGLE_MATCH,
  55     style,
  56     "a `match` statement with a single nontrivial arm (i.e., where the other arm is `_ => {}`) instead of `if let`"
  57 }
  58
  59 declare_clippy_lint! {
  60     /// **What it does:** Checks for matches with two arms where an `if let else` will
  61     /// usually suffice.
  62     ///
  63     /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
  64     ///
  65     /// **Known problems:** Personal style preferences may differ.
  66     ///
  67     /// **Example:**
  68     ///
  69     /// Using `match`:
  70     ///
  71     /// ```rust
  72     /// # fn bar(foo: &usize) {}
  73     /// # let other_ref: usize = 1;
  74     /// # let x: Option<&usize> = Some(&1);
  75     /// match x {
  76     ///     Some(ref foo) => bar(foo),
  77     ///     _ => bar(&other_ref),
  78     /// }
  79     /// ```
  80     ///
  81     /// Using `if let` with `else`:
  82     ///
  83     /// ```rust
  84     /// # fn bar(foo: &usize) {}
  85     /// # let other_ref: usize = 1;
  86     /// # let x: Option<&usize> = Some(&1);
  87     /// if let Some(ref foo) = x {
  88     ///     bar(foo);
  89     /// } else {
  90     ///     bar(&other_ref);
  91     /// }
  92     /// ```
  93     pub SINGLE_MATCH_ELSE,
  94     pedantic,
  95     "a `match` statement with two arms where the second arm's pattern is a placeholder instead of a specific match pattern"
  96 }
  97
  98 declare_clippy_lint! {
  99     /// **What it does:** Checks for matches where all arms match a reference,
 100     /// suggesting to remove the reference and deref the matched expression
 101     /// instead. It also checks for `if let &foo = bar` blocks.
 102     ///
 103     /// **Why is this bad?** It just makes the code less readable. That reference
 104     /// destructuring adds nothing to the code.
 105     ///
 106     /// **Known problems:** None.
 107     ///
 108     /// **Example:**
 109     /// ```rust,ignore
 110     /// // Bad
 111     /// match x {
 112     ///     &A(ref y) => foo(y),
 113     ///     &B => bar(),
 114     ///     _ => frob(&x),
 115     /// }
 116     ///
 117     /// // Good
 118     /// match *x {
 119     ///     A(ref y) => foo(y),
 120     ///     B => bar(),
 121     ///     _ => frob(x),
 122     /// }
 123     /// ```
 124     pub MATCH_REF_PATS,
 125     style,
 126     "a `match` or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
 127 }
 128
 129 declare_clippy_lint! {
 130     /// **What it does:** Checks for matches where match expression is a `bool`. It
 131     /// suggests to replace the expression with an `if...else` block.
 132     ///
 133     /// **Why is this bad?** It makes the code less readable.
 134     ///
 135     /// **Known problems:** None.
 136     ///
 137     /// **Example:**
 138     /// ```rust
 139     /// # fn foo() {}
 140     /// # fn bar() {}
 141     /// let condition: bool = true;
 142     /// match condition {
 143     ///     true => foo(),
 144     ///     false => bar(),
 145     /// }
 146     /// ```
 147     /// Use if/else instead:
 148     /// ```rust
 149     /// # fn foo() {}
 150     /// # fn bar() {}
 151     /// let condition: bool = true;
 152     /// if condition {
 153     ///     foo();
 154     /// } else {
 155     ///     bar();
 156     /// }
 157     /// ```
 158     pub MATCH_BOOL,
 159     pedantic,
 160     "a `match` on a boolean expression instead of an `if..else` block"
 161 }
 162
 163 declare_clippy_lint! {
 164     /// **What it does:** Checks for overlapping match arms.
 165     ///
 166     /// **Why is this bad?** It is likely to be an error and if not, makes the code
 167     /// less obvious.
 168     ///
 169     /// **Known problems:** None.
 170     ///
 171     /// **Example:**
 172     /// ```rust
 173     /// let x = 5;
 174     /// match x {
 175     ///     1...10 => println!("1 ... 10"),
 176     ///     5...15 => println!("5 ... 15"),
 177     ///     _ => (),
 178     /// }
 179     /// ```
 180     pub MATCH_OVERLAPPING_ARM,
 181     style,
 182     "a `match` with overlapping arms"
 183 }
 184
 185 declare_clippy_lint! {
 186     /// **What it does:** Checks for arm which matches all errors with `Err(_)`
 187     /// and take drastic actions like `panic!`.
 188     ///
 189     /// **Why is this bad?** It is generally a bad practice, similar to
 190     /// catching all exceptions in java with `catch(Exception)`
 191     ///
 192     /// **Known problems:** None.
 193     ///
 194     /// **Example:**
 195     /// ```rust
 196     /// let x: Result<i32, &str> = Ok(3);
 197     /// match x {
 198     ///     Ok(_) => println!("ok"),
 199     ///     Err(_) => panic!("err"),
 200     /// }
 201     /// ```
 202     pub MATCH_WILD_ERR_ARM,
 203     pedantic,
 204     "a `match` with `Err(_)` arm and take drastic actions"
 205 }
 206
 207 declare_clippy_lint! {
 208     /// **What it does:** Checks for match which is used to add a reference to an
 209     /// `Option` value.
 210     ///
 211     /// **Why is this bad?** Using `as_ref()` or `as_mut()` instead is shorter.
 212     ///
 213     /// **Known problems:** None.
 214     ///
 215     /// **Example:**
 216     /// ```rust
 217     /// let x: Option<()> = None;
 218     ///
 219     /// // Bad
 220     /// let r: Option<&()> = match x {
 221     ///     None => None,
 222     ///     Some(ref v) => Some(v),
 223     /// };
 224     ///
 225     /// // Good
 226     /// let r: Option<&()> = x.as_ref();
 227     /// ```
 228     pub MATCH_AS_REF,
 229     complexity,
 230     "a `match` on an Option value instead of using `as_ref()` or `as_mut`"
 231 }
 232
 233 declare_clippy_lint! {
 234     /// **What it does:** Checks for wildcard enum matches using `_`.
 235     ///
 236     /// **Why is this bad?** New enum variants added by library updates can be missed.
 237     ///
 238     /// **Known problems:** Suggested replacements may be incorrect if guards exhaustively cover some
 239     /// variants, and also may not use correct path to enum if it's not present in the current scope.
 240     ///
 241     /// **Example:**
 242     /// ```rust
 243     /// # enum Foo { A(usize), B(usize) }
 244     /// # let x = Foo::B(1);
 245     /// // Bad
 246     /// match x {
 247     ///     Foo::A(_) => {},
 248     ///     _ => {},
 249     /// }
 250     ///
 251     /// // Good
 252     /// match x {
 253     ///     Foo::A(_) => {},
 254     ///     Foo::B(_) => {},
 255     /// }
 256     /// ```
 257     pub WILDCARD_ENUM_MATCH_ARM,
 258     restriction,
 259     "a wildcard enum match arm using `_`"
 260 }
 261
 262 declare_clippy_lint! {
 263     /// **What it does:** Checks for wildcard enum matches for a single variant.
 264     ///
 265     /// **Why is this bad?** New enum variants added by library updates can be missed.
 266     ///
 267     /// **Known problems:** Suggested replacements may not use correct path to enum
 268     /// if it's not present in the current scope.
 269     ///
 270     /// **Example:**
 271     ///
 272     /// ```rust
 273     /// # enum Foo { A, B, C }
 274     /// # let x = Foo::B;
 275     /// // Bad
 276     /// match x {
 277     ///     Foo::A => {},
 278     ///     Foo::B => {},
 279     ///     _ => {},
 280     /// }
 281     ///
 282     /// // Good
 283     /// match x {
 284     ///     Foo::A => {},
 285     ///     Foo::B => {},
 286     ///     Foo::C => {},
 287     /// }
 288     /// ```
 289     pub MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
 290     pedantic,
 291     "a wildcard enum match for a single variant"
 292 }
 293
 294 declare_clippy_lint! {
 295     /// **What it does:** Checks for wildcard pattern used with others patterns in same match arm.
 296     ///
 297     /// **Why is this bad?** Wildcard pattern already covers any other pattern as it will match anyway.
 298     /// It makes the code less readable, especially to spot wildcard pattern use in match arm.
 299     ///
 300     /// **Known problems:** None.
 301     ///
 302     /// **Example:**
 303     /// ```rust
 304     /// // Bad
 305     /// match "foo" {
 306     ///     "a" => {},
 307     ///     "bar" | _ => {},
 308     /// }
 309     ///
 310     /// // Good
 311     /// match "foo" {
 312     ///     "a" => {},
 313     ///     _ => {},
 314     /// }
 315     /// ```
 316     pub WILDCARD_IN_OR_PATTERNS,
 317     complexity,
 318     "a wildcard pattern used with others patterns in same match arm"
 319 }
 320
 321 declare_clippy_lint! {
 322     /// **What it does:** Checks for matches being used to destructure a single-variant enum
 323     /// or tuple struct where a `let` will suffice.
 324     ///
 325     /// **Why is this bad?** Just readability – `let` doesn't nest, whereas a `match` does.
 326     ///
 327     /// **Known problems:** None.
 328     ///
 329     /// **Example:**
 330     /// ```rust
 331     /// enum Wrapper {
 332     ///     Data(i32),
 333     /// }
 334     ///
 335     /// let wrapper = Wrapper::Data(42);
 336     ///
 337     /// let data = match wrapper {
 338     ///     Wrapper::Data(i) => i,
 339     /// };
 340     /// ```
 341     ///
 342     /// The correct use would be:
 343     /// ```rust
 344     /// enum Wrapper {
 345     ///     Data(i32),
 346     /// }
 347     ///
 348     /// let wrapper = Wrapper::Data(42);
 349     /// let Wrapper::Data(data) = wrapper;
 350     /// ```
 351     pub INFALLIBLE_DESTRUCTURING_MATCH,
 352     style,
 353     "a `match` statement with a single infallible arm instead of a `let`"
 354 }
 355
 356 declare_clippy_lint! {
 357     /// **What it does:** Checks for useless match that binds to only one value.
 358     ///
 359     /// **Why is this bad?** Readability and needless complexity.
 360     ///
 361     /// **Known problems:**  Suggested replacements may be incorrect when `match`
 362     /// is actually binding temporary value, bringing a 'dropped while borrowed' error.
 363     ///
 364     /// **Example:**
 365     /// ```rust
 366     /// # let a = 1;
 367     /// # let b = 2;
 368     ///
 369     /// // Bad
 370     /// match (a, b) {
 371     ///     (c, d) => {
 372     ///         // useless match
 373     ///     }
 374     /// }
 375     ///
 376     /// // Good
 377     /// let (c, d) = (a, b);
 378     /// ```
 379     pub MATCH_SINGLE_BINDING,
 380     complexity,
 381     "a match with a single binding instead of using `let` statement"
 382 }
 383
 384 declare_clippy_lint! {
 385     /// **What it does:** Checks for unnecessary '..' pattern binding on struct when all fields are explicitly matched.
 386     ///
 387     /// **Why is this bad?** Correctness and readability. It's like having a wildcard pattern after
 388     /// matching all enum variants explicitly.
 389     ///
 390     /// **Known problems:** None.
 391     ///
 392     /// **Example:**
 393     /// ```rust
 394     /// # struct A { a: i32 }
 395     /// let a = A { a: 5 };
 396     ///
 397     /// // Bad
 398     /// match a {
 399     ///     A { a: 5, .. } => {},
 400     ///     _ => {},
 401     /// }
 402     ///
 403     /// // Good
 404     /// match a {
 405     ///     A { a: 5 } => {},
 406     ///     _ => {},
 407     /// }
 408     /// ```
 409     pub REST_PAT_IN_FULLY_BOUND_STRUCTS,
 410     restriction,
 411     "a match on a struct that binds all fields but still uses the wildcard pattern"
 412 }
 413
 414 declare_clippy_lint! {
 415     /// **What it does:** Lint for redundant pattern matching over `Result`, `Option`,
 416     /// `std::task::Poll` or `std::net::IpAddr`
 417     ///
 418     /// **Why is this bad?** It's more concise and clear to just use the proper
 419     /// utility function
 420     ///
 421     /// **Known problems:** None.
 422     ///
 423     /// **Example:**
 424     ///
 425     /// ```rust
 426     /// # use std::task::Poll;
 427     /// # use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 428     /// if let Ok(_) = Ok::<i32, i32>(42) {}
 429     /// if let Err(_) = Err::<i32, i32>(42) {}
 430     /// if let None = None::<()> {}
 431     /// if let Some(_) = Some(42) {}
 432     /// if let Poll::Pending = Poll::Pending::<()> {}
 433     /// if let Poll::Ready(_) = Poll::Ready(42) {}
 434     /// if let IpAddr::V4(_) = IpAddr::V4(Ipv4Addr::LOCALHOST) {}
 435     /// if let IpAddr::V6(_) = IpAddr::V6(Ipv6Addr::LOCALHOST) {}
 436     /// match Ok::<i32, i32>(42) {
 437     ///     Ok(_) => true,
 438     ///     Err(_) => false,
 439     /// };
 440     /// ```
 441     ///
 442     /// The more idiomatic use would be:
 443     ///
 444     /// ```rust
 445     /// # use std::task::Poll;
 446     /// # use std::net::{IpAddr, Ipv4Addr, Ipv6Addr};
 447     /// if Ok::<i32, i32>(42).is_ok() {}
 448     /// if Err::<i32, i32>(42).is_err() {}
 449     /// if None::<()>.is_none() {}
 450     /// if Some(42).is_some() {}
 451     /// if Poll::Pending::<()>.is_pending() {}
 452     /// if Poll::Ready(42).is_ready() {}
 453     /// if IpAddr::V4(Ipv4Addr::LOCALHOST).is_ipv4() {}
 454     /// if IpAddr::V6(Ipv6Addr::LOCALHOST).is_ipv6() {}
 455     /// Ok::<i32, i32>(42).is_ok();
 456     /// ```
 457     pub REDUNDANT_PATTERN_MATCHING,
 458     style,
 459     "use the proper utility function avoiding an `if let`"
 460 }
 461
 462 declare_clippy_lint! {
 463     /// **What it does:** Checks for `match`  or `if let` expressions producing a
 464     /// `bool` that could be written using `matches!`
 465     ///
 466     /// **Why is this bad?** Readability and needless complexity.
 467     ///
 468     /// **Known problems:** This lint falsely triggers, if there are arms with
 469     /// `cfg` attributes that remove an arm evaluating to `false`.
 470     ///
 471     /// **Example:**
 472     /// ```rust
 473     /// let x = Some(5);
 474     ///
 475     /// // Bad
 476     /// let a = match x {
 477     ///     Some(0) => true,
 478     ///     _ => false,
 479     /// };
 480     ///
 481     /// let a = if let Some(0) = x {
 482     ///     true
 483     /// } else {
 484     ///     false
 485     /// };
 486     ///
 487     /// // Good
 488     /// let a = matches!(x, Some(0));
 489     /// ```
 490     pub MATCH_LIKE_MATCHES_MACRO,
 491     style,
 492     "a match that could be written with the matches! macro"
 493 }
 494
 495 declare_clippy_lint! {
 496     /// **What it does:** Checks for `match` with identical arm bodies.
 497     ///
 498     /// **Why is this bad?** This is probably a copy & paste error. If arm bodies
 499     /// are the same on purpose, you can factor them
 500     /// [using `|`](https://doc.rust-lang.org/book/patterns.html#multiple-patterns).
 501     ///
 502     /// **Known problems:** False positive possible with order dependent `match`
 503     /// (see issue
 504     /// [#860](https://github.com/rust-lang/rust-clippy/issues/860)).
 505     ///
 506     /// **Example:**
 507     /// ```rust,ignore
 508     /// match foo {
 509     ///     Bar => bar(),
 510     ///     Quz => quz(),
 511     ///     Baz => bar(), // <= oops
 512     /// }
 513     /// ```
 514     ///
 515     /// This should probably be
 516     /// ```rust,ignore
 517     /// match foo {
 518     ///     Bar => bar(),
 519     ///     Quz => quz(),
 520     ///     Baz => baz(), // <= fixed
 521     /// }
 522     /// ```
 523     ///
 524     /// or if the original code was not a typo:
 525     /// ```rust,ignore
 526     /// match foo {
 527     ///     Bar | Baz => bar(), // <= shows the intent better
 528     ///     Quz => quz(),
 529     /// }
 530     /// ```
 531     pub MATCH_SAME_ARMS,
 532     pedantic,
 533     "`match` with identical arm bodies"
 534 }
 535
 536 #[derive(Default)]
 537 pub struct Matches {
 538     msrv: Option<RustcVersion>,
 539     infallible_destructuring_match_linted: bool,
 540 }
 541
 542 impl Matches {
 543     #[must_use]
 544     pub fn new(msrv: Option<RustcVersion>) -> Self {
 545         Self {
 546             msrv,
 547             ..Matches::default()
 548         }
 549     }
 550 }
 551
 552 impl_lint_pass!(Matches => [
 553     SINGLE_MATCH,
 554     MATCH_REF_PATS,
 555     MATCH_BOOL,
 556     SINGLE_MATCH_ELSE,
 557     MATCH_OVERLAPPING_ARM,
 558     MATCH_WILD_ERR_ARM,
 559     MATCH_AS_REF,
 560     WILDCARD_ENUM_MATCH_ARM,
 561     MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
 562     WILDCARD_IN_OR_PATTERNS,
 563     MATCH_SINGLE_BINDING,
 564     INFALLIBLE_DESTRUCTURING_MATCH,
 565     REST_PAT_IN_FULLY_BOUND_STRUCTS,
 566     REDUNDANT_PATTERN_MATCHING,
 567     MATCH_LIKE_MATCHES_MACRO,
 568     MATCH_SAME_ARMS,
 569 ]);
 570
 571 const MATCH_LIKE_MATCHES_MACRO_MSRV: RustcVersion = RustcVersion::new(1, 42, 0);
 572
 573 impl<'tcx> LateLintPass<'tcx> for Matches {
 574     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
 575         if in_external_macro(cx.sess(), expr.span) || in_macro(expr.span) {
 576             return;
 577         }
 578
 579         redundant_pattern_match::check(cx, expr);
 580
 581         if meets_msrv(self.msrv.as_ref(), &MATCH_LIKE_MATCHES_MACRO_MSRV) {
 582             if !check_match_like_matches(cx, expr) {
 583                 lint_match_arms(cx, expr);
 584             }
 585         } else {
 586             lint_match_arms(cx, expr);
 587         }
 588
 589         if let ExprKind::Match(ref ex, ref arms, MatchSource::Normal) = expr.kind {
 590             check_single_match(cx, ex, arms, expr);
 591             check_match_bool(cx, ex, arms, expr);
 592             check_overlapping_arms(cx, ex, arms);
 593             check_wild_err_arm(cx, ex, arms);
 594             check_wild_enum_match(cx, ex, arms);
 595             check_match_as_ref(cx, ex, arms, expr);
 596             check_wild_in_or_pats(cx, arms);
 597
 598             if self.infallible_destructuring_match_linted {
 599                 self.infallible_destructuring_match_linted = false;
 600             } else {
 601                 check_match_single_binding(cx, ex, arms, expr);
 602             }
 603         }
 604         if let ExprKind::Match(ref ex, ref arms, _) = expr.kind {
 605             check_match_ref_pats(cx, ex, arms, expr);
 606         }
 607     }
 608
 609     fn check_local(&mut self, cx: &LateContext<'tcx>, local: &'tcx Local<'_>) {
 610         if_chain! {
 611             if !in_external_macro(cx.sess(), local.span);
 612             if !in_macro(local.span);
 613             if let Some(ref expr) = local.init;
 614             if let ExprKind::Match(ref target, ref arms, MatchSource::Normal) = expr.kind;
 615             if arms.len() == 1 && arms[0].guard.is_none();
 616             if let PatKind::TupleStruct(
 617                 QPath::Resolved(None, ref variant_name), ref args, _) = arms[0].pat.kind;
 618             if args.len() == 1;
 619             if let Some(arg) = get_arg_name(&args[0]);
 620             let body = remove_blocks(&arms[0].body);
 621             if match_var(body, arg);
 622
 623             then {
 624                 let mut applicability = Applicability::MachineApplicable;
 625                 self.infallible_destructuring_match_linted = true;
 626                 span_lint_and_sugg(
 627                     cx,
 628                     INFALLIBLE_DESTRUCTURING_MATCH,
 629                     local.span,
 630                     "you seem to be trying to use `match` to destructure a single infallible pattern. \
 631                     Consider using `let`",
 632                     "try this",
 633                     format!(
 634                         "let {}({}) = {};",
 635                         snippet_with_applicability(cx, variant_name.span, "..", &mut applicability),
 636                         snippet_with_applicability(cx, local.pat.span, "..", &mut applicability),
 637                         snippet_with_applicability(cx, target.span, "..", &mut applicability),
 638                     ),
 639                     applicability,
 640                 );
 641             }
 642         }
 643     }
 644
 645     fn check_pat(&mut self, cx: &LateContext<'tcx>, pat: &'tcx Pat<'_>) {
 646         if_chain! {
 647             if !in_external_macro(cx.sess(), pat.span);
 648             if !in_macro(pat.span);
 649             if let PatKind::Struct(QPath::Resolved(_, ref path), fields, true) = pat.kind;
 650             if let Some(def_id) = path.res.opt_def_id();
 651             let ty = cx.tcx.type_of(def_id);
 652             if let ty::Adt(def, _) = ty.kind();
 653             if def.is_struct() || def.is_union();
 654             if fields.len() == def.non_enum_variant().fields.len();
 655
 656             then {
 657                 span_lint_and_help(
 658                     cx,
 659                     REST_PAT_IN_FULLY_BOUND_STRUCTS,
 660                     pat.span,
 661                     "unnecessary use of `..` pattern in struct binding. All fields were already bound",
 662                     None,
 663                     "consider removing `..` from this binding",
 664                 );
 665             }
 666         }
 667     }
 668
 669     extract_msrv_attr!(LateContext);
 670 }
 671
 672 #[rustfmt::skip]
 673 fn check_single_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 674     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
 675         if in_macro(expr.span) {
 676             // Don't lint match expressions present in
 677             // macro_rules! block
 678             return;
 679         }
 680         if let PatKind::Or(..) = arms[0].pat.kind {
 681             // don't lint for or patterns for now, this makes
 682             // the lint noisy in unnecessary situations
 683             return;
 684         }
 685         let els = arms[1].body;
 686         let els = if is_unit_expr(remove_blocks(els)) {
 687             None
 688         } else if let ExprKind::Block(Block { stmts, expr: block_expr, .. }, _) = els.kind {
 689             if stmts.len() == 1 && block_expr.is_none() || stmts.is_empty() && block_expr.is_some() {
 690                 // single statement/expr "else" block, don't lint
 691                 return;
 692             }
 693             // block with 2+ statements or 1 expr and 1+ statement
 694             Some(els)
 695         } else {
 696             // not a block, don't lint
 697             return;
 698         };
 699
 700         let ty = cx.typeck_results().expr_ty(ex);
 701         if *ty.kind() != ty::Bool || is_allowed(cx, MATCH_BOOL, ex.hir_id) {
 702             check_single_match_single_pattern(cx, ex, arms, expr, els);
 703             check_single_match_opt_like(cx, ex, arms, expr, ty, els);
 704         }
 705     }
 706 }
 707
 708 fn check_single_match_single_pattern(
 709     cx: &LateContext<'_>,
 710     ex: &Expr<'_>,
 711     arms: &[Arm<'_>],
 712     expr: &Expr<'_>,
 713     els: Option<&Expr<'_>>,
 714 ) {
 715     if is_wild(&arms[1].pat) {
 716         report_single_match_single_pattern(cx, ex, arms, expr, els);
 717     }
 718 }
 719
 720 fn report_single_match_single_pattern(
 721     cx: &LateContext<'_>,
 722     ex: &Expr<'_>,
 723     arms: &[Arm<'_>],
 724     expr: &Expr<'_>,
 725     els: Option<&Expr<'_>>,
 726 ) {
 727     let lint = if els.is_some() { SINGLE_MATCH_ELSE } else { SINGLE_MATCH };
 728     let els_str = els.map_or(String::new(), |els| {
 729         format!(" else {}", expr_block(cx, els, None, "..", Some(expr.span)))
 730     });
 731     span_lint_and_sugg(
 732         cx,
 733         lint,
 734         expr.span,
 735         "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
 736          let`",
 737         "try this",
 738         format!(
 739             "if let {} = {} {}{}",
 740             snippet(cx, arms[0].pat.span, ".."),
 741             snippet(cx, ex.span, ".."),
 742             expr_block(cx, &arms[0].body, None, "..", Some(expr.span)),
 743             els_str,
 744         ),
 745         Applicability::HasPlaceholders,
 746     );
 747 }
 748
 749 fn check_single_match_opt_like(
 750     cx: &LateContext<'_>,
 751     ex: &Expr<'_>,
 752     arms: &[Arm<'_>],
 753     expr: &Expr<'_>,
 754     ty: Ty<'_>,
 755     els: Option<&Expr<'_>>,
 756 ) {
 757     // list of candidate `Enum`s we know will never get any more members
 758     let candidates = &[
 759         (&paths::COW, "Borrowed"),
 760         (&paths::COW, "Cow::Borrowed"),
 761         (&paths::COW, "Cow::Owned"),
 762         (&paths::COW, "Owned"),
 763         (&paths::OPTION, "None"),
 764         (&paths::RESULT, "Err"),
 765         (&paths::RESULT, "Ok"),
 766     ];
 767
 768     let path = match arms[1].pat.kind {
 769         PatKind::TupleStruct(ref path, ref inner, _) => {
 770             // Contains any non wildcard patterns (e.g., `Err(err)`)?
 771             if !inner.iter().all(is_wild) {
 772                 return;
 773             }
 774             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 775         },
 776         PatKind::Binding(BindingAnnotation::Unannotated, .., ident, None) => ident.to_string(),
 777         PatKind::Path(ref path) => {
 778             rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
 779         },
 780         _ => return,
 781     };
 782
 783     for &(ty_path, pat_path) in candidates {
 784         if path == *pat_path && match_type(cx, ty, ty_path) {
 785             report_single_match_single_pattern(cx, ex, arms, expr, els);
 786         }
 787     }
 788 }
 789
 790 fn check_match_bool(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
 791     // Type of expression is `bool`.
 792     if *cx.typeck_results().expr_ty(ex).kind() == ty::Bool {
 793         span_lint_and_then(
 794             cx,
 795             MATCH_BOOL,
 796             expr.span,
 797             "you seem to be trying to match on a boolean expression",
 798             move |diag| {
 799                 if arms.len() == 2 {
 800                     // no guards
 801                     let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pat.kind {
 802                         if let ExprKind::Lit(ref lit) = arm_bool.kind {
 803                             match lit.node {
 804                                 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
 805                                 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
 806                                 _ => None,
 807                             }
 808                         } else {
 809                             None
 810                         }
 811                     } else {
 812                         None
 813                     };
 814
 815                     if let Some((true_expr, false_expr)) = exprs {
 816                         let sugg = match (is_unit_expr(true_expr), is_unit_expr(false_expr)) {
 817                             (false, false) => Some(format!(
 818                                 "if {} {} else {}",
 819                                 snippet(cx, ex.span, "b"),
 820                                 expr_block(cx, true_expr, None, "..", Some(expr.span)),
 821                                 expr_block(cx, false_expr, None, "..", Some(expr.span))
 822                             )),
 823                             (false, true) => Some(format!(
 824                                 "if {} {}",
 825                                 snippet(cx, ex.span, "b"),
 826                                 expr_block(cx, true_expr, None, "..", Some(expr.span))
 827                             )),
 828                             (true, false) => {
 829                                 let test = Sugg::hir(cx, ex, "..");
 830                                 Some(format!(
 831                                     "if {} {}",
 832                                     !test,
 833                                     expr_block(cx, false_expr, None, "..", Some(expr.span))
 834                                 ))
 835                             },
 836                             (true, true) => None,
 837                         };
 838
 839                         if let Some(sugg) = sugg {
 840                             diag.span_suggestion(
 841                                 expr.span,
 842                                 "consider using an `if`/`else` expression",
 843                                 sugg,
 844                                 Applicability::HasPlaceholders,
 845                             );
 846                         }
 847                     }
 848                 }
 849             },
 850         );
 851     }
 852 }
 853
 854 fn check_overlapping_arms<'tcx>(cx: &LateContext<'tcx>, ex: &'tcx Expr<'_>, arms: &'tcx [Arm<'_>]) {
 855     if arms.len() >= 2 && cx.typeck_results().expr_ty(ex).is_integral() {
 856         let ranges = all_ranges(cx, arms, cx.typeck_results().expr_ty(ex));
 857         let type_ranges = type_ranges(&ranges);
 858         if !type_ranges.is_empty() {
 859             if let Some((start, end)) = overlapping(&type_ranges) {
 860                 span_lint_and_note(
 861                     cx,
 862                     MATCH_OVERLAPPING_ARM,
 863                     start.span,
 864                     "some ranges overlap",
 865                     Some(end.span),
 866                     "overlaps with this",
 867                 );
 868             }
 869         }
 870     }
 871 }
 872
 873 fn check_wild_err_arm(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 874     let ex_ty = cx.typeck_results().expr_ty(ex).peel_refs();
 875     if is_type_diagnostic_item(cx, ex_ty, sym::result_type) {
 876         for arm in arms {
 877             if let PatKind::TupleStruct(ref path, ref inner, _) = arm.pat.kind {
 878                 let path_str = rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false));
 879                 if path_str == "Err" {
 880                     let mut matching_wild = inner.iter().any(is_wild);
 881                     let mut ident_bind_name = String::from("_");
 882                     if !matching_wild {
 883                         // Looking for unused bindings (i.e.: `_e`)
 884                         inner.iter().for_each(|pat| {
 885                             if let PatKind::Binding(.., ident, None) = &pat.kind {
 886                                 if ident.as_str().starts_with('_') && is_unused(ident, arm.body) {
 887                                     ident_bind_name = (&ident.name.as_str()).to_string();
 888                                     matching_wild = true;
 889                                 }
 890                             }
 891                         });
 892                     }
 893                     if_chain! {
 894                         if matching_wild;
 895                         if let ExprKind::Block(ref block, _) = arm.body.kind;
 896                         if is_panic_block(block);
 897                         then {
 898                             // `Err(_)` or `Err(_e)` arm with `panic!` found
 899                             span_lint_and_note(cx,
 900                                 MATCH_WILD_ERR_ARM,
 901                                 arm.pat.span,
 902                                 &format!("`Err({})` matches all errors", &ident_bind_name),
 903                                 None,
 904                                 "match each error separately or use the error output, or use `.except(msg)` if the error case is unreachable",
 905                             );
 906                         }
 907                     }
 908                 }
 909             }
 910         }
 911     }
 912 }
 913
 914 fn check_wild_enum_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
 915     let ty = cx.typeck_results().expr_ty(ex);
 916     if !ty.is_enum() {
 917         // If there isn't a nice closed set of possible values that can be conveniently enumerated,
 918         // don't complain about not enumerating the mall.
 919         return;
 920     }
 921
 922     // First pass - check for violation, but don't do much book-keeping because this is hopefully
 923     // the uncommon case, and the book-keeping is slightly expensive.
 924     let mut wildcard_span = None;
 925     let mut wildcard_ident = None;
 926     for arm in arms {
 927         if let PatKind::Wild = arm.pat.kind {
 928             wildcard_span = Some(arm.pat.span);
 929         } else if let PatKind::Binding(_, _, ident, None) = arm.pat.kind {
 930             wildcard_span = Some(arm.pat.span);
 931             wildcard_ident = Some(ident);
 932         }
 933     }
 934
 935     if let Some(wildcard_span) = wildcard_span {
 936         // Accumulate the variants which should be put in place of the wildcard because they're not
 937         // already covered.
 938
 939         let mut missing_variants = vec![];
 940         if let ty::Adt(def, _) = ty.kind() {
 941             for variant in &def.variants {
 942                 missing_variants.push(variant);
 943             }
 944         }
 945
 946         for arm in arms {
 947             if arm.guard.is_some() {
 948                 // Guards mean that this case probably isn't exhaustively covered. Technically
 949                 // this is incorrect, as we should really check whether each variant is exhaustively
 950                 // covered by the set of guards that cover it, but that's really hard to do.
 951                 continue;
 952             }
 953             if let PatKind::Path(ref path) = arm.pat.kind {
 954                 if let QPath::Resolved(_, p) = path {
 955                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 956                 }
 957             } else if let PatKind::TupleStruct(QPath::Resolved(_, p), ref patterns, ..) = arm.pat.kind {
 958                 // Some simple checks for exhaustive patterns.
 959                 // There is a room for improvements to detect more cases,
 960                 // but it can be more expensive to do so.
 961                 let is_pattern_exhaustive =
 962                     |pat: &&Pat<'_>| matches!(pat.kind, PatKind::Wild | PatKind::Binding(.., None));
 963                 if patterns.iter().all(is_pattern_exhaustive) {
 964                     missing_variants.retain(|e| e.ctor_def_id != Some(p.res.def_id()));
 965                 }
 966             }
 967         }
 968
 969         let mut suggestion: Vec<String> = missing_variants
 970             .iter()
 971             .map(|v| {
 972                 let suffix = match v.ctor_kind {
 973                     CtorKind::Fn => "(..)",
 974                     CtorKind::Const | CtorKind::Fictive => "",
 975                 };
 976                 let ident_str = if let Some(ident) = wildcard_ident {
 977                     format!("{} @ ", ident.name)
 978                 } else {
 979                     String::new()
 980                 };
 981                 // This path assumes that the enum type is imported into scope.
 982                 format!("{}{}{}", ident_str, cx.tcx.def_path_str(v.def_id), suffix)
 983             })
 984             .collect();
 985
 986         if suggestion.is_empty() {
 987             return;
 988         }
 989
 990         let mut message = "wildcard match will miss any future added variants";
 991
 992         if let ty::Adt(def, _) = ty.kind() {
 993             if def.is_variant_list_non_exhaustive() {
 994                 message = "match on non-exhaustive enum doesn't explicitly match all known variants";
 995                 suggestion.push(String::from("_"));
 996             }
 997         }
 998
 999         if suggestion.len() == 1 {
1000             // No need to check for non-exhaustive enum as in that case len would be greater than 1
1001             span_lint_and_sugg(
1002                 cx,
1003                 MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
1004                 wildcard_span,
1005                 message,
1006                 "try this",
1007                 suggestion[0].clone(),
1008                 Applicability::MaybeIncorrect,
1009             )
1010         };
1011
1012         span_lint_and_sugg(
1013             cx,
1014             WILDCARD_ENUM_MATCH_ARM,
1015             wildcard_span,
1016             message,
1017             "try this",
1018             suggestion.join(" | "),
1019             Applicability::MaybeIncorrect,
1020         )
1021     }
1022 }
1023
1024 // If the block contains only a `panic!` macro (as expression or statement)
1025 fn is_panic_block(block: &Block<'_>) -> bool {
1026     match (&block.expr, block.stmts.len(), block.stmts.first()) {
1027         (&Some(ref exp), 0, _) => {
1028             is_expn_of(exp.span, "panic").is_some() && is_expn_of(exp.span, "unreachable").is_none()
1029         },
1030         (&None, 1, Some(stmt)) => {
1031             is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
1032         },
1033         _ => false,
1034     }
1035 }
1036
1037 fn check_match_ref_pats(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1038     if has_only_ref_pats(arms) {
1039         let mut suggs = Vec::with_capacity(arms.len() + 1);
1040         let (title, msg) = if let ExprKind::AddrOf(BorrowKind::Ref, Mutability::Not, ref inner) = ex.kind {
1041             let span = ex.span.source_callsite();
1042             suggs.push((span, Sugg::hir_with_macro_callsite(cx, inner, "..").to_string()));
1043             (
1044                 "you don't need to add `&` to both the expression and the patterns",
1045                 "try",
1046             )
1047         } else {
1048             let span = ex.span.source_callsite();
1049             suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
1050             (
1051                 "you don't need to add `&` to all patterns",
1052                 "instead of prefixing all patterns with `&`, you can dereference the expression",
1053             )
1054         };
1055
1056         suggs.extend(arms.iter().filter_map(|a| {
1057             if let PatKind::Ref(ref refp, _) = a.pat.kind {
1058                 Some((a.pat.span, snippet(cx, refp.span, "..").to_string()))
1059             } else {
1060                 None
1061             }
1062         }));
1063
1064         span_lint_and_then(cx, MATCH_REF_PATS, expr.span, title, |diag| {
1065             if !expr.span.from_expansion() {
1066                 multispan_sugg(diag, msg, suggs);
1067             }
1068         });
1069     }
1070 }
1071
1072 fn check_match_as_ref(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1073     if arms.len() == 2 && arms[0].guard.is_none() && arms[1].guard.is_none() {
1074         let arm_ref: Option<BindingAnnotation> = if is_none_arm(&arms[0]) {
1075             is_ref_some_arm(&arms[1])
1076         } else if is_none_arm(&arms[1]) {
1077             is_ref_some_arm(&arms[0])
1078         } else {
1079             None
1080         };
1081         if let Some(rb) = arm_ref {
1082             let suggestion = if rb == BindingAnnotation::Ref {
1083                 "as_ref"
1084             } else {
1085                 "as_mut"
1086             };
1087
1088             let output_ty = cx.typeck_results().expr_ty(expr);
1089             let input_ty = cx.typeck_results().expr_ty(ex);
1090
1091             let cast = if_chain! {
1092                 if let ty::Adt(_, substs) = input_ty.kind();
1093                 let input_ty = substs.type_at(0);
1094                 if let ty::Adt(_, substs) = output_ty.kind();
1095                 let output_ty = substs.type_at(0);
1096                 if let ty::Ref(_, output_ty, _) = *output_ty.kind();
1097                 if input_ty != output_ty;
1098                 then {
1099                     ".map(|x| x as _)"
1100                 } else {
1101                     ""
1102                 }
1103             };
1104
1105             let mut applicability = Applicability::MachineApplicable;
1106             span_lint_and_sugg(
1107                 cx,
1108                 MATCH_AS_REF,
1109                 expr.span,
1110                 &format!("use `{}()` instead", suggestion),
1111                 "try this",
1112                 format!(
1113                     "{}.{}(){}",
1114                     snippet_with_applicability(cx, ex.span, "_", &mut applicability),
1115                     suggestion,
1116                     cast,
1117                 ),
1118                 applicability,
1119             )
1120         }
1121     }
1122 }
1123
1124 fn check_wild_in_or_pats(cx: &LateContext<'_>, arms: &[Arm<'_>]) {
1125     for arm in arms {
1126         if let PatKind::Or(ref fields) = arm.pat.kind {
1127             // look for multiple fields in this arm that contains at least one Wild pattern
1128             if fields.len() > 1 && fields.iter().any(is_wild) {
1129                 span_lint_and_help(
1130                     cx,
1131                     WILDCARD_IN_OR_PATTERNS,
1132                     arm.pat.span,
1133                     "wildcard pattern covers any other pattern as it will match anyway.",
1134                     None,
1135                     "Consider handling `_` separately.",
1136                 );
1137             }
1138         }
1139     }
1140 }
1141
1142 /// Lint a `match` or `if let .. { .. } else { .. }` expr that could be replaced by `matches!`
1143 fn check_match_like_matches<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) -> bool {
1144     if let ExprKind::Match(ex, arms, ref match_source) = &expr.kind {
1145         match match_source {
1146             MatchSource::Normal => find_matches_sugg(cx, ex, arms, expr, false),
1147             MatchSource::IfLetDesugar { .. } => find_matches_sugg(cx, ex, arms, expr, true),
1148             _ => false,
1149         }
1150     } else {
1151         false
1152     }
1153 }
1154
1155 /// Lint a `match` or desugared `if let` for replacement by `matches!`
1156 fn find_matches_sugg(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>], expr: &Expr<'_>, desugared: bool) -> bool {
1157     if_chain! {
1158         if arms.len() >= 2;
1159         if cx.typeck_results().expr_ty(expr).is_bool();
1160         if let Some((b1_arm, b0_arms)) = arms.split_last();
1161         if let Some(b0) = find_bool_lit(&b0_arms[0].body.kind, desugared);
1162         if let Some(b1) = find_bool_lit(&b1_arm.body.kind, desugared);
1163         if is_wild(&b1_arm.pat);
1164         if b0 != b1;
1165         let if_guard = &b0_arms[0].guard;
1166         if if_guard.is_none() || b0_arms.len() == 1;
1167         if b0_arms[0].attrs.is_empty();
1168         if b0_arms[1..].iter()
1169             .all(|arm| {
1170                 find_bool_lit(&arm.body.kind, desugared).map_or(false, |b| b == b0) &&
1171                 arm.guard.is_none() && arm.attrs.is_empty()
1172             });
1173         then {
1174             // The suggestion may be incorrect, because some arms can have `cfg` attributes
1175             // evaluated into `false` and so such arms will be stripped before.
1176             let mut applicability = Applicability::MaybeIncorrect;
1177             let pat = {
1178                 use itertools::Itertools as _;
1179                 b0_arms.iter()
1180                     .map(|arm| snippet_with_applicability(cx, arm.pat.span, "..", &mut applicability))
1181                     .join(" | ")
1182             };
1183             let pat_and_guard = if let Some(Guard::If(g)) = if_guard {
1184                 format!("{} if {}", pat, snippet_with_applicability(cx, g.span, "..", &mut applicability))
1185             } else {
1186                 pat
1187             };
1188             span_lint_and_sugg(
1189                 cx,
1190                 MATCH_LIKE_MATCHES_MACRO,
1191                 expr.span,
1192                 &format!("{} expression looks like `matches!` macro", if desugared { "if let .. else" } else { "match" }),
1193                 "try this",
1194                 format!(
1195                     "{}matches!({}, {})",
1196                     if b0 { "" } else { "!" },
1197                     snippet_with_applicability(cx, ex.span, "..", &mut applicability),
1198                     pat_and_guard,
1199                 ),
1200                 applicability,
1201             );
1202             true
1203         } else {
1204             false
1205         }
1206     }
1207 }
1208
1209 /// Extract a `bool` or `{ bool }`
1210 fn find_bool_lit(ex: &ExprKind<'_>, desugared: bool) -> Option<bool> {
1211     match ex {
1212         ExprKind::Lit(Spanned {
1213             node: LitKind::Bool(b), ..
1214         }) => Some(*b),
1215         ExprKind::Block(
1216             rustc_hir::Block {
1217                 stmts: &[],
1218                 expr: Some(exp),
1219                 ..
1220             },
1221             _,
1222         ) if desugared => {
1223             if let ExprKind::Lit(Spanned {
1224                 node: LitKind::Bool(b), ..
1225             }) = exp.kind
1226             {
1227                 Some(b)
1228             } else {
1229                 None
1230             }
1231         },
1232         _ => None,
1233     }
1234 }
1235
1236 fn check_match_single_binding<'a>(cx: &LateContext<'a>, ex: &Expr<'a>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1237     if in_macro(expr.span) || arms.len() != 1 || is_refutable(cx, arms[0].pat) {
1238         return;
1239     }
1240
1241     // HACK:
1242     // This is a hack to deal with arms that are excluded by macros like `#[cfg]`. It is only used here
1243     // to prevent false positives as there is currently no better way to detect if code was excluded by
1244     // a macro. See PR #6435
1245     if_chain! {
1246         if let Some(match_snippet) = snippet_opt(cx, expr.span);
1247         if let Some(arm_snippet) = snippet_opt(cx, arms[0].span);
1248         if let Some(ex_snippet) = snippet_opt(cx, ex.span);
1249         let rest_snippet = match_snippet.replace(&arm_snippet, "").replace(&ex_snippet, "");
1250         if rest_snippet.contains("=>");
1251         then {
1252             // The code it self contains another thick arrow "=>"
1253             // -> Either another arm or a comment
1254             return;
1255         }
1256     }
1257
1258     let matched_vars = ex.span;
1259     let bind_names = arms[0].pat.span;
1260     let match_body = remove_blocks(&arms[0].body);
1261     let mut snippet_body = if match_body.span.from_expansion() {
1262         Sugg::hir_with_macro_callsite(cx, match_body, "..").to_string()
1263     } else {
1264         snippet_block(cx, match_body.span, "..", Some(expr.span)).to_string()
1265     };
1266
1267     // Do we need to add ';' to suggestion ?
1268     match match_body.kind {
1269         ExprKind::Block(block, _) => {
1270             // macro + expr_ty(body) == ()
1271             if block.span.from_expansion() && cx.typeck_results().expr_ty(&match_body).is_unit() {
1272                 snippet_body.push(';');
1273             }
1274         },
1275         _ => {
1276             // expr_ty(body) == ()
1277             if cx.typeck_results().expr_ty(&match_body).is_unit() {
1278                 snippet_body.push(';');
1279             }
1280         },
1281     }
1282
1283     let mut applicability = Applicability::MaybeIncorrect;
1284     match arms[0].pat.kind {
1285         PatKind::Binding(..) | PatKind::Tuple(_, _) | PatKind::Struct(..) => {
1286             // If this match is in a local (`let`) stmt
1287             let (target_span, sugg) = if let Some(parent_let_node) = opt_parent_let(cx, ex) {
1288                 (
1289                     parent_let_node.span,
1290                     format!(
1291                         "let {} = {};\n{}let {} = {};",
1292                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1293                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1294                         " ".repeat(indent_of(cx, expr.span).unwrap_or(0)),
1295                         snippet_with_applicability(cx, parent_let_node.pat.span, "..", &mut applicability),
1296                         snippet_body
1297                     ),
1298                 )
1299             } else {
1300                 // If we are in closure, we need curly braces around suggestion
1301                 let mut indent = " ".repeat(indent_of(cx, ex.span).unwrap_or(0));
1302                 let (mut cbrace_start, mut cbrace_end) = ("".to_string(), "".to_string());
1303                 if let Some(parent_expr) = get_parent_expr(cx, expr) {
1304                     if let ExprKind::Closure(..) = parent_expr.kind {
1305                         cbrace_end = format!("\n{}}}", indent);
1306                         // Fix body indent due to the closure
1307                         indent = " ".repeat(indent_of(cx, bind_names).unwrap_or(0));
1308                         cbrace_start = format!("{{\n{}", indent);
1309                     }
1310                 };
1311                 (
1312                     expr.span,
1313                     format!(
1314                         "{}let {} = {};\n{}{}{}",
1315                         cbrace_start,
1316                         snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1317                         snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1318                         indent,
1319                         snippet_body,
1320                         cbrace_end
1321                     ),
1322                 )
1323             };
1324             span_lint_and_sugg(
1325                 cx,
1326                 MATCH_SINGLE_BINDING,
1327                 target_span,
1328                 "this match could be written as a `let` statement",
1329                 "consider using `let` statement",
1330                 sugg,
1331                 applicability,
1332             );
1333         },
1334         PatKind::Wild => {
1335             span_lint_and_sugg(
1336                 cx,
1337                 MATCH_SINGLE_BINDING,
1338                 expr.span,
1339                 "this match could be replaced by its body itself",
1340                 "consider using the match body instead",
1341                 snippet_body,
1342                 Applicability::MachineApplicable,
1343             );
1344         },
1345         _ => (),
1346     }
1347 }
1348
1349 /// Returns true if the `ex` match expression is in a local (`let`) statement
1350 fn opt_parent_let<'a>(cx: &LateContext<'a>, ex: &Expr<'a>) -> Option<&'a Local<'a>> {
1351     if_chain! {
1352         let map = &cx.tcx.hir();
1353         if let Some(Node::Expr(parent_arm_expr)) = map.find(map.get_parent_node(ex.hir_id));
1354         if let Some(Node::Local(parent_let_expr)) = map.find(map.get_parent_node(parent_arm_expr.hir_id));
1355         then {
1356             return Some(parent_let_expr);
1357         }
1358     }
1359     None
1360 }
1361
1362 /// Gets all arms that are unbounded `PatRange`s.
1363 fn all_ranges<'tcx>(cx: &LateContext<'tcx>, arms: &'tcx [Arm<'_>], ty: Ty<'tcx>) -> Vec<SpannedRange<Constant>> {
1364     arms.iter()
1365         .flat_map(|arm| {
1366             if let Arm {
1367                 ref pat, guard: None, ..
1368             } = *arm
1369             {
1370                 if let PatKind::Range(ref lhs, ref rhs, range_end) = pat.kind {
1371                     let lhs = match lhs {
1372                         Some(lhs) => constant(cx, cx.typeck_results(), lhs)?.0,
1373                         None => miri_to_const(ty.numeric_min_val(cx.tcx)?)?,
1374                     };
1375                     let rhs = match rhs {
1376                         Some(rhs) => constant(cx, cx.typeck_results(), rhs)?.0,
1377                         None => miri_to_const(ty.numeric_max_val(cx.tcx)?)?,
1378                     };
1379                     let rhs = match range_end {
1380                         RangeEnd::Included => Bound::Included(rhs),
1381                         RangeEnd::Excluded => Bound::Excluded(rhs),
1382                     };
1383                     return Some(SpannedRange {
1384                         span: pat.span,
1385                         node: (lhs, rhs),
1386                     });
1387                 }
1388
1389                 if let PatKind::Lit(ref value) = pat.kind {
1390                     let value = constant(cx, cx.typeck_results(), value)?.0;
1391                     return Some(SpannedRange {
1392                         span: pat.span,
1393                         node: (value.clone(), Bound::Included(value)),
1394                     });
1395                 }
1396             }
1397             None
1398         })
1399         .collect()
1400 }
1401
1402 #[derive(Debug, Eq, PartialEq)]
1403 pub struct SpannedRange<T> {
1404     pub span: Span,
1405     pub node: (T, Bound<T>),
1406 }
1407
1408 type TypedRanges = Vec<SpannedRange<u128>>;
1409
1410 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
1411 /// and other types than
1412 /// `Uint` and `Int` probably don't make sense.
1413 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
1414     ranges
1415         .iter()
1416         .filter_map(|range| match range.node {
1417             (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
1418                 span: range.span,
1419                 node: (start, Bound::Included(end)),
1420             }),
1421             (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
1422                 span: range.span,
1423                 node: (start, Bound::Excluded(end)),
1424             }),
1425             (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
1426                 span: range.span,
1427                 node: (start, Bound::Unbounded),
1428             }),
1429             _ => None,
1430         })
1431         .collect()
1432 }
1433
1434 fn is_unit_expr(expr: &Expr<'_>) -> bool {
1435     match expr.kind {
1436         ExprKind::Tup(ref v) if v.is_empty() => true,
1437         ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
1438         _ => false,
1439     }
1440 }
1441
1442 // Checks if arm has the form `None => None`
1443 fn is_none_arm(arm: &Arm<'_>) -> bool {
1444     matches!(arm.pat.kind, PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE))
1445 }
1446
1447 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
1448 fn is_ref_some_arm(arm: &Arm<'_>) -> Option<BindingAnnotation> {
1449     if_chain! {
1450         if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
1451         if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
1452         if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
1453         if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
1454         if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
1455         if let ExprKind::Path(ref some_path) = e.kind;
1456         if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
1457         if let ExprKind::Path(QPath::Resolved(_, ref path2)) = args[0].kind;
1458         if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
1459         then {
1460             return Some(rb)
1461         }
1462     }
1463     None
1464 }
1465
1466 fn has_only_ref_pats(arms: &[Arm<'_>]) -> bool {
1467     let mapped = arms
1468         .iter()
1469         .map(|a| {
1470             match a.pat.kind {
1471                 PatKind::Ref(..) => Some(true), // &-patterns
1472                 PatKind::Wild => Some(false),   // an "anything" wildcard is also fine
1473                 _ => None,                      // any other pattern is not fine
1474             }
1475         })
1476         .collect::<Option<Vec<bool>>>();
1477     // look for Some(v) where there's at least one true element
1478     mapped.map_or(false, |v| v.iter().any(|el| *el))
1479 }
1480
1481 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
1482 where
1483     T: Copy + Ord,
1484 {
1485     #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1486     enum Kind<'a, T> {
1487         Start(T, &'a SpannedRange<T>),
1488         End(Bound<T>, &'a SpannedRange<T>),
1489     }
1490
1491     impl<'a, T: Copy> Kind<'a, T> {
1492         fn range(&self) -> &'a SpannedRange<T> {
1493             match *self {
1494                 Kind::Start(_, r) | Kind::End(_, r) => r,
1495             }
1496         }
1497
1498         fn value(self) -> Bound<T> {
1499             match self {
1500                 Kind::Start(t, _) => Bound::Included(t),
1501                 Kind::End(t, _) => t,
1502             }
1503         }
1504     }
1505
1506     impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
1507         fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1508             Some(self.cmp(other))
1509         }
1510     }
1511
1512     impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
1513         fn cmp(&self, other: &Self) -> Ordering {
1514             match (self.value(), other.value()) {
1515                 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
1516                 // Range patterns cannot be unbounded (yet)
1517                 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
1518                 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
1519                     Ordering::Equal => Ordering::Greater,
1520                     other => other,
1521                 },
1522                 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
1523                     Ordering::Equal => Ordering::Less,
1524                     other => other,
1525                 },
1526             }
1527         }
1528     }
1529
1530     let mut values = Vec::with_capacity(2 * ranges.len());
1531
1532     for r in ranges {
1533         values.push(Kind::Start(r.node.0, r));
1534         values.push(Kind::End(r.node.1, r));
1535     }
1536
1537     values.sort();
1538
1539     for (a, b) in values.iter().zip(values.iter().skip(1)) {
1540         match (a, b) {
1541             (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
1542                 if ra.node != rb.node {
1543                     return Some((ra, rb));
1544                 }
1545             },
1546             (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
1547             _ => return Some((a.range(), b.range())),
1548         }
1549     }
1550
1551     None
1552 }
1553
1554 mod redundant_pattern_match {
1555     use super::REDUNDANT_PATTERN_MATCHING;
1556     use crate::utils::{match_qpath, match_trait_method, paths, snippet, span_lint_and_then};
1557     use if_chain::if_chain;
1558     use rustc_ast::ast::LitKind;
1559     use rustc_errors::Applicability;
1560     use rustc_hir::{Arm, Expr, ExprKind, MatchSource, PatKind, QPath};
1561     use rustc_lint::LateContext;
1562     use rustc_span::sym;
1563
1564     pub fn check<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
1565         if let ExprKind::Match(op, arms, ref match_source) = &expr.kind {
1566             match match_source {
1567                 MatchSource::Normal => find_sugg_for_match(cx, expr, op, arms),
1568                 MatchSource::IfLetDesugar { .. } => find_sugg_for_if_let(cx, expr, op, arms, "if"),
1569                 MatchSource::WhileLetDesugar => find_sugg_for_if_let(cx, expr, op, arms, "while"),
1570                 _ => {},
1571             }
1572         }
1573     }
1574
1575     fn find_sugg_for_if_let<'tcx>(
1576         cx: &LateContext<'tcx>,
1577         expr: &'tcx Expr<'_>,
1578         op: &Expr<'_>,
1579         arms: &[Arm<'_>],
1580         keyword: &'static str,
1581     ) {
1582         let good_method = match arms[0].pat.kind {
1583             PatKind::TupleStruct(ref path, ref patterns, _) if patterns.len() == 1 => {
1584                 if let PatKind::Wild = patterns[0].kind {
1585                     if match_qpath(path, &paths::RESULT_OK) {
1586                         "is_ok()"
1587                     } else if match_qpath(path, &paths::RESULT_ERR) {
1588                         "is_err()"
1589                     } else if match_qpath(path, &paths::OPTION_SOME) {
1590                         "is_some()"
1591                     } else if match_qpath(path, &paths::POLL_READY) {
1592                         "is_ready()"
1593                     } else if match_qpath(path, &paths::IPADDR_V4) {
1594                         "is_ipv4()"
1595                     } else if match_qpath(path, &paths::IPADDR_V6) {
1596                         "is_ipv6()"
1597                     } else {
1598                         return;
1599                     }
1600                 } else {
1601                     return;
1602                 }
1603             },
1604             PatKind::Path(ref path) => {
1605                 if match_qpath(path, &paths::OPTION_NONE) {
1606                     "is_none()"
1607                 } else if match_qpath(path, &paths::POLL_PENDING) {
1608                     "is_pending()"
1609                 } else {
1610                     return;
1611                 }
1612             },
1613             _ => return,
1614         };
1615
1616         // check that `while_let_on_iterator` lint does not trigger
1617         if_chain! {
1618             if keyword == "while";
1619             if let ExprKind::MethodCall(method_path, _, _, _) = op.kind;
1620             if method_path.ident.name == sym::next;
1621             if match_trait_method(cx, op, &paths::ITERATOR);
1622             then {
1623                 return;
1624             }
1625         }
1626
1627         let result_expr = match &op.kind {
1628             ExprKind::AddrOf(_, _, borrowed) => borrowed,
1629             _ => op,
1630         };
1631         span_lint_and_then(
1632             cx,
1633             REDUNDANT_PATTERN_MATCHING,
1634             arms[0].pat.span,
1635             &format!("redundant pattern matching, consider using `{}`", good_method),
1636             |diag| {
1637                 // while let ... = ... { ... }
1638                 // ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1639                 let expr_span = expr.span;
1640
1641                 // while let ... = ... { ... }
1642                 //                 ^^^
1643                 let op_span = result_expr.span.source_callsite();
1644
1645                 // while let ... = ... { ... }
1646                 // ^^^^^^^^^^^^^^^^^^^
1647                 let span = expr_span.until(op_span.shrink_to_hi());
1648                 diag.span_suggestion(
1649                     span,
1650                     "try this",
1651                     format!("{} {}.{}", keyword, snippet(cx, op_span, "_"), good_method),
1652                     Applicability::MachineApplicable, // snippet
1653                 );
1654             },
1655         );
1656     }
1657
1658     fn find_sugg_for_match<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, op: &Expr<'_>, arms: &[Arm<'_>]) {
1659         if arms.len() == 2 {
1660             let node_pair = (&arms[0].pat.kind, &arms[1].pat.kind);
1661
1662             let found_good_method = match node_pair {
1663                 (
1664                     PatKind::TupleStruct(ref path_left, ref patterns_left, _),
1665                     PatKind::TupleStruct(ref path_right, ref patterns_right, _),
1666                 ) if patterns_left.len() == 1 && patterns_right.len() == 1 => {
1667                     if let (PatKind::Wild, PatKind::Wild) = (&patterns_left[0].kind, &patterns_right[0].kind) {
1668                         find_good_method_for_match(
1669                             arms,
1670                             path_left,
1671                             path_right,
1672                             &paths::RESULT_OK,
1673                             &paths::RESULT_ERR,
1674                             "is_ok()",
1675                             "is_err()",
1676                         )
1677                         .or_else(|| {
1678                             find_good_method_for_match(
1679                                 arms,
1680                                 path_left,
1681                                 path_right,
1682                                 &paths::IPADDR_V4,
1683                                 &paths::IPADDR_V6,
1684                                 "is_ipv4()",
1685                                 "is_ipv6()",
1686                             )
1687                         })
1688                     } else {
1689                         None
1690                     }
1691                 },
1692                 (PatKind::TupleStruct(ref path_left, ref patterns, _), PatKind::Path(ref path_right))
1693                 | (PatKind::Path(ref path_left), PatKind::TupleStruct(ref path_right, ref patterns, _))
1694                     if patterns.len() == 1 =>
1695                 {
1696                     if let PatKind::Wild = patterns[0].kind {
1697                         find_good_method_for_match(
1698                             arms,
1699                             path_left,
1700                             path_right,
1701                             &paths::OPTION_SOME,
1702                             &paths::OPTION_NONE,
1703                             "is_some()",
1704                             "is_none()",
1705                         )
1706                         .or_else(|| {
1707                             find_good_method_for_match(
1708                                 arms,
1709                                 path_left,
1710                                 path_right,
1711                                 &paths::POLL_READY,
1712                                 &paths::POLL_PENDING,
1713                                 "is_ready()",
1714                                 "is_pending()",
1715                             )
1716                         })
1717                     } else {
1718                         None
1719                     }
1720                 },
1721                 _ => None,
1722             };
1723
1724             if let Some(good_method) = found_good_method {
1725                 let span = expr.span.to(op.span);
1726                 let result_expr = match &op.kind {
1727                     ExprKind::AddrOf(_, _, borrowed) => borrowed,
1728                     _ => op,
1729                 };
1730                 span_lint_and_then(
1731                     cx,
1732                     REDUNDANT_PATTERN_MATCHING,
1733                     expr.span,
1734                     &format!("redundant pattern matching, consider using `{}`", good_method),
1735                     |diag| {
1736                         diag.span_suggestion(
1737                             span,
1738                             "try this",
1739                             format!("{}.{}", snippet(cx, result_expr.span, "_"), good_method),
1740                             Applicability::MaybeIncorrect, // snippet
1741                         );
1742                     },
1743                 );
1744             }
1745         }
1746     }
1747
1748     fn find_good_method_for_match<'a>(
1749         arms: &[Arm<'_>],
1750         path_left: &QPath<'_>,
1751         path_right: &QPath<'_>,
1752         expected_left: &[&str],
1753         expected_right: &[&str],
1754         should_be_left: &'a str,
1755         should_be_right: &'a str,
1756     ) -> Option<&'a str> {
1757         let body_node_pair = if match_qpath(path_left, expected_left) && match_qpath(path_right, expected_right) {
1758             (&(*arms[0].body).kind, &(*arms[1].body).kind)
1759         } else if match_qpath(path_right, expected_left) && match_qpath(path_left, expected_right) {
1760             (&(*arms[1].body).kind, &(*arms[0].body).kind)
1761         } else {
1762             return None;
1763         };
1764
1765         match body_node_pair {
1766             (ExprKind::Lit(ref lit_left), ExprKind::Lit(ref lit_right)) => match (&lit_left.node, &lit_right.node) {
1767                 (LitKind::Bool(true), LitKind::Bool(false)) => Some(should_be_left),
1768                 (LitKind::Bool(false), LitKind::Bool(true)) => Some(should_be_right),
1769                 _ => None,
1770             },
1771             _ => None,
1772         }
1773     }
1774 }
1775
1776 #[test]
1777 fn test_overlapping() {
1778     use rustc_span::source_map::DUMMY_SP;
1779
1780     let sp = |s, e| SpannedRange {
1781         span: DUMMY_SP,
1782         node: (s, e),
1783     };
1784
1785     assert_eq!(None, overlapping::<u8>(&[]));
1786     assert_eq!(None, overlapping(&[sp(1, Bound::Included(4))]));
1787     assert_eq!(
1788         None,
1789         overlapping(&[sp(1, Bound::Included(4)), sp(5, Bound::Included(6))])
1790     );
1791     assert_eq!(
1792         None,
1793         overlapping(&[
1794             sp(1, Bound::Included(4)),
1795             sp(5, Bound::Included(6)),
1796             sp(10, Bound::Included(11))
1797         ],)
1798     );
1799     assert_eq!(
1800         Some((&sp(1, Bound::Included(4)), &sp(3, Bound::Included(6)))),
1801         overlapping(&[sp(1, Bound::Included(4)), sp(3, Bound::Included(6))])
1802     );
1803     assert_eq!(
1804         Some((&sp(5, Bound::Included(6)), &sp(6, Bound::Included(11)))),
1805         overlapping(&[
1806             sp(1, Bound::Included(4)),
1807             sp(5, Bound::Included(6)),
1808             sp(6, Bound::Included(11))
1809         ],)
1810     );
1811 }
1812
1813 /// Implementation of `MATCH_SAME_ARMS`.
1814 fn lint_match_arms<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) {
1815     fn same_bindings<'tcx>(lhs: &FxHashMap<Symbol, Ty<'tcx>>, rhs: &FxHashMap<Symbol, Ty<'tcx>>) -> bool {
1816         lhs.len() == rhs.len()
1817             && lhs
1818                 .iter()
1819                 .all(|(name, l_ty)| rhs.get(name).map_or(false, |r_ty| TyS::same_type(l_ty, r_ty)))
1820     }
1821
1822     if let ExprKind::Match(_, ref arms, MatchSource::Normal) = expr.kind {
1823         let hash = |&(_, arm): &(usize, &Arm<'_>)| -> u64 {
1824             let mut h = SpanlessHash::new(cx);
1825             h.hash_expr(&arm.body);
1826             h.finish()
1827         };
1828
1829         let eq = |&(lindex, lhs): &(usize, &Arm<'_>), &(rindex, rhs): &(usize, &Arm<'_>)| -> bool {
1830             let min_index = usize::min(lindex, rindex);
1831             let max_index = usize::max(lindex, rindex);
1832
1833             // Arms with a guard are ignored, those can’t always be merged together
1834             // This is also the case for arms in-between each there is an arm with a guard
1835             (min_index..=max_index).all(|index| arms[index].guard.is_none()) &&
1836                 SpanlessEq::new(cx).eq_expr(&lhs.body, &rhs.body) &&
1837                 // all patterns should have the same bindings
1838                 same_bindings(&bindings(cx, &lhs.pat), &bindings(cx, &rhs.pat))
1839         };
1840
1841         let indexed_arms: Vec<(usize, &Arm<'_>)> = arms.iter().enumerate().collect();
1842         for (&(_, i), &(_, j)) in search_same(&indexed_arms, hash, eq) {
1843             span_lint_and_then(
1844                 cx,
1845                 MATCH_SAME_ARMS,
1846                 j.body.span,
1847                 "this `match` has identical arm bodies",
1848                 |diag| {
1849                     diag.span_note(i.body.span, "same as this");
1850
1851                     // Note: this does not use `span_suggestion` on purpose:
1852                     // there is no clean way
1853                     // to remove the other arm. Building a span and suggest to replace it to ""
1854                     // makes an even more confusing error message. Also in order not to make up a
1855                     // span for the whole pattern, the suggestion is only shown when there is only
1856                     // one pattern. The user should know about `|` if they are already using it…
1857
1858                     let lhs = snippet(cx, i.pat.span, "<pat1>");
1859                     let rhs = snippet(cx, j.pat.span, "<pat2>");
1860
1861                     if let PatKind::Wild = j.pat.kind {
1862                         // if the last arm is _, then i could be integrated into _
1863                         // note that i.pat cannot be _, because that would mean that we're
1864                         // hiding all the subsequent arms, and rust won't compile
1865                         diag.span_note(
1866                             i.body.span,
1867                             &format!(
1868                                 "`{}` has the same arm body as the `_` wildcard, consider removing it",
1869                                 lhs
1870                             ),
1871                         );
1872                     } else {
1873                         diag.span_help(i.pat.span, &format!("consider refactoring into `{} | {}`", lhs, rhs));
1874                     }
1875                 },
1876             );
1877         }
1878     }
1879 }
1880
1881 /// Returns the list of bindings in a pattern.
1882 fn bindings<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>) -> FxHashMap<Symbol, Ty<'tcx>> {
1883     fn bindings_impl<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>, map: &mut FxHashMap<Symbol, Ty<'tcx>>) {
1884         match pat.kind {
1885             PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => bindings_impl(cx, pat, map),
1886             PatKind::TupleStruct(_, pats, _) => {
1887                 for pat in pats {
1888                     bindings_impl(cx, pat, map);
1889                 }
1890             },
1891             PatKind::Binding(.., ident, ref as_pat) => {
1892                 if let Entry::Vacant(v) = map.entry(ident.name) {
1893                     v.insert(cx.typeck_results().pat_ty(pat));
1894                 }
1895                 if let Some(ref as_pat) = *as_pat {
1896                     bindings_impl(cx, as_pat, map);
1897                 }
1898             },
1899             PatKind::Or(fields) | PatKind::Tuple(fields, _) => {
1900                 for pat in fields {
1901                     bindings_impl(cx, pat, map);
1902                 }
1903             },
1904             PatKind::Struct(_, fields, _) => {
1905                 for pat in fields {
1906                     bindings_impl(cx, &pat.pat, map);
1907                 }
1908             },
1909             PatKind::Slice(lhs, ref mid, rhs) => {
1910                 for pat in lhs {
1911                     bindings_impl(cx, pat, map);
1912                 }
1913                 if let Some(ref mid) = *mid {
1914                     bindings_impl(cx, mid, map);
1915                 }
1916                 for pat in rhs {
1917                     bindings_impl(cx, pat, map);
1918                 }
1919             },
1920             PatKind::Lit(..) | PatKind::Range(..) | PatKind::Wild | PatKind::Path(..) => (),
1921         }
1922     }
1923
1924     let mut result = FxHashMap::default();
1925     bindings_impl(cx, pat, &mut result);
1926     result
1927 }