1 use crate::consts::{constant, miri_to_const, Constant};
2 use crate::utils::sugg::Sugg;
3 use crate::utils::usage::is_unused;
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,
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;
17 Arm, BindingAnnotation, Block, BorrowKind, Expr, ExprKind, Guard, Local, MatchSource, Mutability, Node, Pat,
18 PatKind, QPath, RangeEnd,
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;
31 declare_clippy_lint! {
32 /// **What it does:** Checks for matches with a single arm where an `if let`
33 /// will usually suffice.
35 /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
37 /// **Known problems:** None.
41 /// # fn bar(stool: &str) {}
42 /// # let x = Some("abc");
45 /// Some(ref foo) => bar(foo),
50 /// if let Some(ref foo) = x {
56 "a `match` statement with a single nontrivial arm (i.e., where the other arm is `_ => {}`) instead of `if let`"
59 declare_clippy_lint! {
60 /// **What it does:** Checks for matches with two arms where an `if let else` will
63 /// **Why is this bad?** Just readability – `if let` nests less than a `match`.
65 /// **Known problems:** Personal style preferences may differ.
72 /// # fn bar(foo: &usize) {}
73 /// # let other_ref: usize = 1;
74 /// # let x: Option<&usize> = Some(&1);
76 /// Some(ref foo) => bar(foo),
77 /// _ => bar(&other_ref),
81 /// Using `if let` with `else`:
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 {
93 pub SINGLE_MATCH_ELSE,
95 "a `match` statement with two arms where the second arm's pattern is a placeholder instead of a specific match pattern"
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.
103 /// **Why is this bad?** It just makes the code less readable. That reference
104 /// destructuring adds nothing to the code.
106 /// **Known problems:** None.
112 /// &A(ref y) => foo(y),
119 /// A(ref y) => foo(y),
126 "a `match` or `if let` with all arms prefixed with `&` instead of deref-ing the match expression"
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.
133 /// **Why is this bad?** It makes the code less readable.
135 /// **Known problems:** None.
141 /// let condition: bool = true;
142 /// match condition {
147 /// Use if/else instead:
151 /// let condition: bool = true;
160 "a `match` on a boolean expression instead of an `if..else` block"
163 declare_clippy_lint! {
164 /// **What it does:** Checks for overlapping match arms.
166 /// **Why is this bad?** It is likely to be an error and if not, makes the code
169 /// **Known problems:** None.
175 /// 1...10 => println!("1 ... 10"),
176 /// 5...15 => println!("5 ... 15"),
180 pub MATCH_OVERLAPPING_ARM,
182 "a `match` with overlapping arms"
185 declare_clippy_lint! {
186 /// **What it does:** Checks for arm which matches all errors with `Err(_)`
187 /// and take drastic actions like `panic!`.
189 /// **Why is this bad?** It is generally a bad practice, similar to
190 /// catching all exceptions in java with `catch(Exception)`
192 /// **Known problems:** None.
196 /// let x: Result<i32, &str> = Ok(3);
198 /// Ok(_) => println!("ok"),
199 /// Err(_) => panic!("err"),
202 pub MATCH_WILD_ERR_ARM,
204 "a `match` with `Err(_)` arm and take drastic actions"
207 declare_clippy_lint! {
208 /// **What it does:** Checks for match which is used to add a reference to an
211 /// **Why is this bad?** Using `as_ref()` or `as_mut()` instead is shorter.
213 /// **Known problems:** None.
217 /// let x: Option<()> = None;
220 /// let r: Option<&()> = match x {
222 /// Some(ref v) => Some(v),
226 /// let r: Option<&()> = x.as_ref();
230 "a `match` on an Option value instead of using `as_ref()` or `as_mut`"
233 declare_clippy_lint! {
234 /// **What it does:** Checks for wildcard enum matches using `_`.
236 /// **Why is this bad?** New enum variants added by library updates can be missed.
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.
243 /// # enum Foo { A(usize), B(usize) }
244 /// # let x = Foo::B(1);
257 pub WILDCARD_ENUM_MATCH_ARM,
259 "a wildcard enum match arm using `_`"
262 declare_clippy_lint! {
263 /// **What it does:** Checks for wildcard enum matches for a single variant.
265 /// **Why is this bad?** New enum variants added by library updates can be missed.
267 /// **Known problems:** Suggested replacements may not use correct path to enum
268 /// if it's not present in the current scope.
273 /// # enum Foo { A, B, C }
274 /// # let x = Foo::B;
289 pub MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
291 "a wildcard enum match for a single variant"
294 declare_clippy_lint! {
295 /// **What it does:** Checks for wildcard pattern used with others patterns in same match arm.
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.
300 /// **Known problems:** None.
316 pub WILDCARD_IN_OR_PATTERNS,
318 "a wildcard pattern used with others patterns in same match arm"
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.
325 /// **Why is this bad?** Just readability – `let` doesn't nest, whereas a `match` does.
327 /// **Known problems:** None.
335 /// let wrapper = Wrapper::Data(42);
337 /// let data = match wrapper {
338 /// Wrapper::Data(i) => i,
342 /// The correct use would be:
348 /// let wrapper = Wrapper::Data(42);
349 /// let Wrapper::Data(data) = wrapper;
351 pub INFALLIBLE_DESTRUCTURING_MATCH,
353 "a `match` statement with a single infallible arm instead of a `let`"
356 declare_clippy_lint! {
357 /// **What it does:** Checks for useless match that binds to only one value.
359 /// **Why is this bad?** Readability and needless complexity.
361 /// **Known problems:** Suggested replacements may be incorrect when `match`
362 /// is actually binding temporary value, bringing a 'dropped while borrowed' error.
377 /// let (c, d) = (a, b);
379 pub MATCH_SINGLE_BINDING,
381 "a match with a single binding instead of using `let` statement"
384 declare_clippy_lint! {
385 /// **What it does:** Checks for unnecessary '..' pattern binding on struct when all fields are explicitly matched.
387 /// **Why is this bad?** Correctness and readability. It's like having a wildcard pattern after
388 /// matching all enum variants explicitly.
390 /// **Known problems:** None.
394 /// # struct A { a: i32 }
395 /// let a = A { a: 5 };
399 /// A { a: 5, .. } => {},
405 /// A { a: 5 } => {},
409 pub REST_PAT_IN_FULLY_BOUND_STRUCTS,
411 "a match on a struct that binds all fields but still uses the wildcard pattern"
414 declare_clippy_lint! {
415 /// **What it does:** Lint for redundant pattern matching over `Result`, `Option`,
416 /// `std::task::Poll` or `std::net::IpAddr`
418 /// **Why is this bad?** It's more concise and clear to just use the proper
421 /// **Known problems:** None.
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) {
442 /// The more idiomatic use would be:
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();
457 pub REDUNDANT_PATTERN_MATCHING,
459 "use the proper utility function avoiding an `if let`"
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!`
466 /// **Why is this bad?** Readability and needless complexity.
468 /// **Known problems:** This lint falsely triggers, if there are arms with
469 /// `cfg` attributes that remove an arm evaluating to `false`.
476 /// let a = match x {
481 /// let a = if let Some(0) = x {
488 /// let a = matches!(x, Some(0));
490 pub MATCH_LIKE_MATCHES_MACRO,
492 "a match that could be written with the matches! macro"
495 declare_clippy_lint! {
496 /// **What it does:** Checks for `match` with identical arm bodies.
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).
502 /// **Known problems:** False positive possible with order dependent `match`
504 /// [#860](https://github.com/rust-lang/rust-clippy/issues/860)).
511 /// Baz => bar(), // <= oops
515 /// This should probably be
520 /// Baz => baz(), // <= fixed
524 /// or if the original code was not a typo:
527 /// Bar | Baz => bar(), // <= shows the intent better
533 "`match` with identical arm bodies"
538 msrv: Option<RustcVersion>,
539 infallible_destructuring_match_linted: bool,
544 pub fn new(msrv: Option<RustcVersion>) -> Self {
552 impl_lint_pass!(Matches => [
557 MATCH_OVERLAPPING_ARM,
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,
571 const MATCH_LIKE_MATCHES_MACRO_MSRV: RustcVersion = RustcVersion::new(1, 42, 0);
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) {
579 redundant_pattern_match::check(cx, expr);
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);
586 lint_match_arms(cx, expr);
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);
598 if self.infallible_destructuring_match_linted {
599 self.infallible_destructuring_match_linted = false;
601 check_match_single_binding(cx, ex, arms, expr);
604 if let ExprKind::Match(ref ex, ref arms, _) = expr.kind {
605 check_match_ref_pats(cx, ex, arms, expr);
609 fn check_local(&mut self, cx: &LateContext<'tcx>, local: &'tcx Local<'_>) {
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;
619 if let Some(arg) = get_arg_name(&args[0]);
620 let body = remove_blocks(&arms[0].body);
621 if match_var(body, arg);
624 let mut applicability = Applicability::MachineApplicable;
625 self.infallible_destructuring_match_linted = true;
628 INFALLIBLE_DESTRUCTURING_MATCH,
630 "you seem to be trying to use `match` to destructure a single infallible pattern. \
631 Consider using `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),
645 fn check_pat(&mut self, cx: &LateContext<'tcx>, pat: &'tcx Pat<'_>) {
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();
659 REST_PAT_IN_FULLY_BOUND_STRUCTS,
661 "unnecessary use of `..` pattern in struct binding. All fields were already bound",
663 "consider removing `..` from this binding",
669 extract_msrv_attr!(LateContext);
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
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
685 let els = arms[1].body;
686 let els = if is_unit_expr(remove_blocks(els)) {
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
693 // block with 2+ statements or 1 expr and 1+ statement
696 // not a block, don't lint
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);
708 fn check_single_match_single_pattern(
709 cx: &LateContext<'_>,
713 els: Option<&Expr<'_>>,
715 if is_wild(&arms[1].pat) {
716 report_single_match_single_pattern(cx, ex, arms, expr, els);
720 fn report_single_match_single_pattern(
721 cx: &LateContext<'_>,
725 els: Option<&Expr<'_>>,
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)))
735 "you seem to be trying to use match for destructuring a single pattern. Consider using `if \
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)),
745 Applicability::HasPlaceholders,
749 fn check_single_match_opt_like(
750 cx: &LateContext<'_>,
755 els: Option<&Expr<'_>>,
757 // list of candidate `Enum`s we know will never get any more members
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"),
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) {
774 rustc_hir_pretty::to_string(rustc_hir_pretty::NO_ANN, |s| s.print_qpath(path, false))
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))
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);
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 {
797 "you seem to be trying to match on a boolean expression",
801 let exprs = if let PatKind::Lit(ref arm_bool) = arms[0].pat.kind {
802 if let ExprKind::Lit(ref lit) = arm_bool.kind {
804 LitKind::Bool(true) => Some((&*arms[0].body, &*arms[1].body)),
805 LitKind::Bool(false) => Some((&*arms[1].body, &*arms[0].body)),
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!(
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))
823 (false, true) => Some(format!(
825 snippet(cx, ex.span, "b"),
826 expr_block(cx, true_expr, None, "..", Some(expr.span))
829 let test = Sugg::hir(cx, ex, "..");
833 expr_block(cx, false_expr, None, "..", Some(expr.span))
836 (true, true) => None,
839 if let Some(sugg) = sugg {
840 diag.span_suggestion(
842 "consider using an `if`/`else` expression",
844 Applicability::HasPlaceholders,
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) {
862 MATCH_OVERLAPPING_ARM,
864 "some ranges overlap",
866 "overlaps with this",
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) {
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("_");
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;
895 if let ExprKind::Block(ref block, _) = arm.body.kind;
896 if is_panic_block(block);
898 // `Err(_)` or `Err(_e)` arm with `panic!` found
899 span_lint_and_note(cx,
902 &format!("`Err({})` matches all errors", &ident_bind_name),
904 "match each error separately or use the error output, or use `.except(msg)` if the error case is unreachable",
914 fn check_wild_enum_match(cx: &LateContext<'_>, ex: &Expr<'_>, arms: &[Arm<'_>]) {
915 let ty = cx.typeck_results().expr_ty(ex);
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.
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;
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);
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
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);
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.
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()));
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()));
969 let mut suggestion: Vec<String> = missing_variants
972 let suffix = match v.ctor_kind {
973 CtorKind::Fn => "(..)",
974 CtorKind::Const | CtorKind::Fictive => "",
976 let ident_str = if let Some(ident) = wildcard_ident {
977 format!("{} @ ", ident.name)
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)
986 if suggestion.is_empty() {
990 let mut message = "wildcard match will miss any future added variants";
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("_"));
999 if suggestion.len() == 1 {
1000 // No need to check for non-exhaustive enum as in that case len would be greater than 1
1003 MATCH_WILDCARD_FOR_SINGLE_VARIANTS,
1007 suggestion[0].clone(),
1008 Applicability::MaybeIncorrect,
1014 WILDCARD_ENUM_MATCH_ARM,
1018 suggestion.join(" | "),
1019 Applicability::MaybeIncorrect,
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()
1030 (&None, 1, Some(stmt)) => {
1031 is_expn_of(stmt.span, "panic").is_some() && is_expn_of(stmt.span, "unreachable").is_none()
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()));
1044 "you don't need to add `&` to both the expression and the patterns",
1048 let span = ex.span.source_callsite();
1049 suggs.push((span, Sugg::hir_with_macro_callsite(cx, ex, "..").deref().to_string()));
1051 "you don't need to add `&` to all patterns",
1052 "instead of prefixing all patterns with `&`, you can dereference the expression",
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()))
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);
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])
1081 if let Some(rb) = arm_ref {
1082 let suggestion = if rb == BindingAnnotation::Ref {
1088 let output_ty = cx.typeck_results().expr_ty(expr);
1089 let input_ty = cx.typeck_results().expr_ty(ex);
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;
1105 let mut applicability = Applicability::MachineApplicable;
1110 &format!("use `{}()` instead", suggestion),
1114 snippet_with_applicability(cx, ex.span, "_", &mut applicability),
1124 fn check_wild_in_or_pats(cx: &LateContext<'_>, arms: &[Arm<'_>]) {
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) {
1131 WILDCARD_IN_OR_PATTERNS,
1133 "wildcard pattern covers any other pattern as it will match anyway.",
1135 "Consider handling `_` separately.",
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),
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 {
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);
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()
1170 find_bool_lit(&arm.body.kind, desugared).map_or(false, |b| b == b0) &&
1171 arm.guard.is_none() && arm.attrs.is_empty()
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;
1178 use itertools::Itertools as _;
1180 .map(|arm| snippet_with_applicability(cx, arm.pat.span, "..", &mut applicability))
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))
1189 // strip potential borrows (#6503), but only if the type is a reference
1190 let mut ex_new = ex;
1191 if let ExprKind::AddrOf(BorrowKind::Ref, .., ex_inner) = ex.kind {
1192 if let ty::Ref(..) = cx.typeck_results().expr_ty(&ex_inner).kind() {
1198 MATCH_LIKE_MATCHES_MACRO,
1200 &format!("{} expression looks like `matches!` macro", if desugared { "if let .. else" } else { "match" }),
1203 "{}matches!({}, {})",
1204 if b0 { "" } else { "!" },
1205 snippet_with_applicability(cx, ex_new.span, "..", &mut applicability),
1217 /// Extract a `bool` or `{ bool }`
1218 fn find_bool_lit(ex: &ExprKind<'_>, desugared: bool) -> Option<bool> {
1220 ExprKind::Lit(Spanned {
1221 node: LitKind::Bool(b), ..
1231 if let ExprKind::Lit(Spanned {
1232 node: LitKind::Bool(b), ..
1244 fn check_match_single_binding<'a>(cx: &LateContext<'a>, ex: &Expr<'a>, arms: &[Arm<'_>], expr: &Expr<'_>) {
1245 if in_macro(expr.span) || arms.len() != 1 || is_refutable(cx, arms[0].pat) {
1250 // This is a hack to deal with arms that are excluded by macros like `#[cfg]`. It is only used here
1251 // to prevent false positives as there is currently no better way to detect if code was excluded by
1252 // a macro. See PR #6435
1254 if let Some(match_snippet) = snippet_opt(cx, expr.span);
1255 if let Some(arm_snippet) = snippet_opt(cx, arms[0].span);
1256 if let Some(ex_snippet) = snippet_opt(cx, ex.span);
1257 let rest_snippet = match_snippet.replace(&arm_snippet, "").replace(&ex_snippet, "");
1258 if rest_snippet.contains("=>");
1260 // The code it self contains another thick arrow "=>"
1261 // -> Either another arm or a comment
1266 let matched_vars = ex.span;
1267 let bind_names = arms[0].pat.span;
1268 let match_body = remove_blocks(&arms[0].body);
1269 let mut snippet_body = if match_body.span.from_expansion() {
1270 Sugg::hir_with_macro_callsite(cx, match_body, "..").to_string()
1272 snippet_block(cx, match_body.span, "..", Some(expr.span)).to_string()
1275 // Do we need to add ';' to suggestion ?
1276 match match_body.kind {
1277 ExprKind::Block(block, _) => {
1278 // macro + expr_ty(body) == ()
1279 if block.span.from_expansion() && cx.typeck_results().expr_ty(&match_body).is_unit() {
1280 snippet_body.push(';');
1284 // expr_ty(body) == ()
1285 if cx.typeck_results().expr_ty(&match_body).is_unit() {
1286 snippet_body.push(';');
1291 let mut applicability = Applicability::MaybeIncorrect;
1292 match arms[0].pat.kind {
1293 PatKind::Binding(..) | PatKind::Tuple(_, _) | PatKind::Struct(..) => {
1294 // If this match is in a local (`let`) stmt
1295 let (target_span, sugg) = if let Some(parent_let_node) = opt_parent_let(cx, ex) {
1297 parent_let_node.span,
1299 "let {} = {};\n{}let {} = {};",
1300 snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1301 snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1302 " ".repeat(indent_of(cx, expr.span).unwrap_or(0)),
1303 snippet_with_applicability(cx, parent_let_node.pat.span, "..", &mut applicability),
1308 // If we are in closure, we need curly braces around suggestion
1309 let mut indent = " ".repeat(indent_of(cx, ex.span).unwrap_or(0));
1310 let (mut cbrace_start, mut cbrace_end) = ("".to_string(), "".to_string());
1311 if let Some(parent_expr) = get_parent_expr(cx, expr) {
1312 if let ExprKind::Closure(..) = parent_expr.kind {
1313 cbrace_end = format!("\n{}}}", indent);
1314 // Fix body indent due to the closure
1315 indent = " ".repeat(indent_of(cx, bind_names).unwrap_or(0));
1316 cbrace_start = format!("{{\n{}", indent);
1322 "{}let {} = {};\n{}{}{}",
1324 snippet_with_applicability(cx, bind_names, "..", &mut applicability),
1325 snippet_with_applicability(cx, matched_vars, "..", &mut applicability),
1334 MATCH_SINGLE_BINDING,
1336 "this match could be written as a `let` statement",
1337 "consider using `let` statement",
1345 MATCH_SINGLE_BINDING,
1347 "this match could be replaced by its body itself",
1348 "consider using the match body instead",
1350 Applicability::MachineApplicable,
1357 /// Returns true if the `ex` match expression is in a local (`let`) statement
1358 fn opt_parent_let<'a>(cx: &LateContext<'a>, ex: &Expr<'a>) -> Option<&'a Local<'a>> {
1360 let map = &cx.tcx.hir();
1361 if let Some(Node::Expr(parent_arm_expr)) = map.find(map.get_parent_node(ex.hir_id));
1362 if let Some(Node::Local(parent_let_expr)) = map.find(map.get_parent_node(parent_arm_expr.hir_id));
1364 return Some(parent_let_expr);
1370 /// Gets all arms that are unbounded `PatRange`s.
1371 fn all_ranges<'tcx>(cx: &LateContext<'tcx>, arms: &'tcx [Arm<'_>], ty: Ty<'tcx>) -> Vec<SpannedRange<Constant>> {
1375 ref pat, guard: None, ..
1378 if let PatKind::Range(ref lhs, ref rhs, range_end) = pat.kind {
1379 let lhs = match lhs {
1380 Some(lhs) => constant(cx, cx.typeck_results(), lhs)?.0,
1381 None => miri_to_const(ty.numeric_min_val(cx.tcx)?)?,
1383 let rhs = match rhs {
1384 Some(rhs) => constant(cx, cx.typeck_results(), rhs)?.0,
1385 None => miri_to_const(ty.numeric_max_val(cx.tcx)?)?,
1387 let rhs = match range_end {
1388 RangeEnd::Included => Bound::Included(rhs),
1389 RangeEnd::Excluded => Bound::Excluded(rhs),
1391 return Some(SpannedRange {
1397 if let PatKind::Lit(ref value) = pat.kind {
1398 let value = constant(cx, cx.typeck_results(), value)?.0;
1399 return Some(SpannedRange {
1401 node: (value.clone(), Bound::Included(value)),
1410 #[derive(Debug, Eq, PartialEq)]
1411 pub struct SpannedRange<T> {
1413 pub node: (T, Bound<T>),
1416 type TypedRanges = Vec<SpannedRange<u128>>;
1418 /// Gets all `Int` ranges or all `Uint` ranges. Mixed types are an error anyway
1419 /// and other types than
1420 /// `Uint` and `Int` probably don't make sense.
1421 fn type_ranges(ranges: &[SpannedRange<Constant>]) -> TypedRanges {
1424 .filter_map(|range| match range.node {
1425 (Constant::Int(start), Bound::Included(Constant::Int(end))) => Some(SpannedRange {
1427 node: (start, Bound::Included(end)),
1429 (Constant::Int(start), Bound::Excluded(Constant::Int(end))) => Some(SpannedRange {
1431 node: (start, Bound::Excluded(end)),
1433 (Constant::Int(start), Bound::Unbounded) => Some(SpannedRange {
1435 node: (start, Bound::Unbounded),
1442 fn is_unit_expr(expr: &Expr<'_>) -> bool {
1444 ExprKind::Tup(ref v) if v.is_empty() => true,
1445 ExprKind::Block(ref b, _) if b.stmts.is_empty() && b.expr.is_none() => true,
1450 // Checks if arm has the form `None => None`
1451 fn is_none_arm(arm: &Arm<'_>) -> bool {
1452 matches!(arm.pat.kind, PatKind::Path(ref path) if match_qpath(path, &paths::OPTION_NONE))
1455 // Checks if arm has the form `Some(ref v) => Some(v)` (checks for `ref` and `ref mut`)
1456 fn is_ref_some_arm(arm: &Arm<'_>) -> Option<BindingAnnotation> {
1458 if let PatKind::TupleStruct(ref path, ref pats, _) = arm.pat.kind;
1459 if pats.len() == 1 && match_qpath(path, &paths::OPTION_SOME);
1460 if let PatKind::Binding(rb, .., ident, _) = pats[0].kind;
1461 if rb == BindingAnnotation::Ref || rb == BindingAnnotation::RefMut;
1462 if let ExprKind::Call(ref e, ref args) = remove_blocks(&arm.body).kind;
1463 if let ExprKind::Path(ref some_path) = e.kind;
1464 if match_qpath(some_path, &paths::OPTION_SOME) && args.len() == 1;
1465 if let ExprKind::Path(QPath::Resolved(_, ref path2)) = args[0].kind;
1466 if path2.segments.len() == 1 && ident.name == path2.segments[0].ident.name;
1474 fn has_only_ref_pats(arms: &[Arm<'_>]) -> bool {
1479 PatKind::Ref(..) => Some(true), // &-patterns
1480 PatKind::Wild => Some(false), // an "anything" wildcard is also fine
1481 _ => None, // any other pattern is not fine
1484 .collect::<Option<Vec<bool>>>();
1485 // look for Some(v) where there's at least one true element
1486 mapped.map_or(false, |v| v.iter().any(|el| *el))
1489 pub fn overlapping<T>(ranges: &[SpannedRange<T>]) -> Option<(&SpannedRange<T>, &SpannedRange<T>)>
1493 #[derive(Copy, Clone, Debug, Eq, PartialEq)]
1495 Start(T, &'a SpannedRange<T>),
1496 End(Bound<T>, &'a SpannedRange<T>),
1499 impl<'a, T: Copy> Kind<'a, T> {
1500 fn range(&self) -> &'a SpannedRange<T> {
1502 Kind::Start(_, r) | Kind::End(_, r) => r,
1506 fn value(self) -> Bound<T> {
1508 Kind::Start(t, _) => Bound::Included(t),
1509 Kind::End(t, _) => t,
1514 impl<'a, T: Copy + Ord> PartialOrd for Kind<'a, T> {
1515 fn partial_cmp(&self, other: &Self) -> Option<Ordering> {
1516 Some(self.cmp(other))
1520 impl<'a, T: Copy + Ord> Ord for Kind<'a, T> {
1521 fn cmp(&self, other: &Self) -> Ordering {
1522 match (self.value(), other.value()) {
1523 (Bound::Included(a), Bound::Included(b)) | (Bound::Excluded(a), Bound::Excluded(b)) => a.cmp(&b),
1524 // Range patterns cannot be unbounded (yet)
1525 (Bound::Unbounded, _) | (_, Bound::Unbounded) => unimplemented!(),
1526 (Bound::Included(a), Bound::Excluded(b)) => match a.cmp(&b) {
1527 Ordering::Equal => Ordering::Greater,
1530 (Bound::Excluded(a), Bound::Included(b)) => match a.cmp(&b) {
1531 Ordering::Equal => Ordering::Less,
1538 let mut values = Vec::with_capacity(2 * ranges.len());
1541 values.push(Kind::Start(r.node.0, r));
1542 values.push(Kind::End(r.node.1, r));
1547 for (a, b) in values.iter().zip(values.iter().skip(1)) {
1549 (&Kind::Start(_, ra), &Kind::End(_, rb)) => {
1550 if ra.node != rb.node {
1551 return Some((ra, rb));
1554 (&Kind::End(a, _), &Kind::Start(b, _)) if a != Bound::Included(b) => (),
1555 _ => return Some((a.range(), b.range())),
1562 mod redundant_pattern_match {
1563 use super::REDUNDANT_PATTERN_MATCHING;
1564 use crate::utils::{match_qpath, match_trait_method, paths, snippet, span_lint_and_then};
1565 use if_chain::if_chain;
1566 use rustc_ast::ast::LitKind;
1567 use rustc_errors::Applicability;
1568 use rustc_hir::{Arm, Expr, ExprKind, MatchSource, PatKind, QPath};
1569 use rustc_lint::LateContext;
1570 use rustc_span::sym;
1572 pub fn check<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
1573 if let ExprKind::Match(op, arms, ref match_source) = &expr.kind {
1574 match match_source {
1575 MatchSource::Normal => find_sugg_for_match(cx, expr, op, arms),
1576 MatchSource::IfLetDesugar { .. } => find_sugg_for_if_let(cx, expr, op, arms, "if"),
1577 MatchSource::WhileLetDesugar => find_sugg_for_if_let(cx, expr, op, arms, "while"),
1583 fn find_sugg_for_if_let<'tcx>(
1584 cx: &LateContext<'tcx>,
1585 expr: &'tcx Expr<'_>,
1588 keyword: &'static str,
1590 let good_method = match arms[0].pat.kind {
1591 PatKind::TupleStruct(ref path, ref patterns, _) if patterns.len() == 1 => {
1592 if let PatKind::Wild = patterns[0].kind {
1593 if match_qpath(path, &paths::RESULT_OK) {
1595 } else if match_qpath(path, &paths::RESULT_ERR) {
1597 } else if match_qpath(path, &paths::OPTION_SOME) {
1599 } else if match_qpath(path, &paths::POLL_READY) {
1601 } else if match_qpath(path, &paths::IPADDR_V4) {
1603 } else if match_qpath(path, &paths::IPADDR_V6) {
1612 PatKind::Path(ref path) => {
1613 if match_qpath(path, &paths::OPTION_NONE) {
1615 } else if match_qpath(path, &paths::POLL_PENDING) {
1624 // check that `while_let_on_iterator` lint does not trigger
1626 if keyword == "while";
1627 if let ExprKind::MethodCall(method_path, _, _, _) = op.kind;
1628 if method_path.ident.name == sym::next;
1629 if match_trait_method(cx, op, &paths::ITERATOR);
1635 let result_expr = match &op.kind {
1636 ExprKind::AddrOf(_, _, borrowed) => borrowed,
1641 REDUNDANT_PATTERN_MATCHING,
1643 &format!("redundant pattern matching, consider using `{}`", good_method),
1645 // while let ... = ... { ... }
1646 // ^^^^^^^^^^^^^^^^^^^^^^^^^^^
1647 let expr_span = expr.span;
1649 // while let ... = ... { ... }
1651 let op_span = result_expr.span.source_callsite();
1653 // while let ... = ... { ... }
1654 // ^^^^^^^^^^^^^^^^^^^
1655 let span = expr_span.until(op_span.shrink_to_hi());
1656 diag.span_suggestion(
1659 format!("{} {}.{}", keyword, snippet(cx, op_span, "_"), good_method),
1660 Applicability::MachineApplicable, // snippet
1666 fn find_sugg_for_match<'tcx>(cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>, op: &Expr<'_>, arms: &[Arm<'_>]) {
1667 if arms.len() == 2 {
1668 let node_pair = (&arms[0].pat.kind, &arms[1].pat.kind);
1670 let found_good_method = match node_pair {
1672 PatKind::TupleStruct(ref path_left, ref patterns_left, _),
1673 PatKind::TupleStruct(ref path_right, ref patterns_right, _),
1674 ) if patterns_left.len() == 1 && patterns_right.len() == 1 => {
1675 if let (PatKind::Wild, PatKind::Wild) = (&patterns_left[0].kind, &patterns_right[0].kind) {
1676 find_good_method_for_match(
1686 find_good_method_for_match(
1700 (PatKind::TupleStruct(ref path_left, ref patterns, _), PatKind::Path(ref path_right))
1701 | (PatKind::Path(ref path_left), PatKind::TupleStruct(ref path_right, ref patterns, _))
1702 if patterns.len() == 1 =>
1704 if let PatKind::Wild = patterns[0].kind {
1705 find_good_method_for_match(
1709 &paths::OPTION_SOME,
1710 &paths::OPTION_NONE,
1715 find_good_method_for_match(
1720 &paths::POLL_PENDING,
1732 if let Some(good_method) = found_good_method {
1733 let span = expr.span.to(op.span);
1734 let result_expr = match &op.kind {
1735 ExprKind::AddrOf(_, _, borrowed) => borrowed,
1740 REDUNDANT_PATTERN_MATCHING,
1742 &format!("redundant pattern matching, consider using `{}`", good_method),
1744 diag.span_suggestion(
1747 format!("{}.{}", snippet(cx, result_expr.span, "_"), good_method),
1748 Applicability::MaybeIncorrect, // snippet
1756 fn find_good_method_for_match<'a>(
1758 path_left: &QPath<'_>,
1759 path_right: &QPath<'_>,
1760 expected_left: &[&str],
1761 expected_right: &[&str],
1762 should_be_left: &'a str,
1763 should_be_right: &'a str,
1764 ) -> Option<&'a str> {
1765 let body_node_pair = if match_qpath(path_left, expected_left) && match_qpath(path_right, expected_right) {
1766 (&(*arms[0].body).kind, &(*arms[1].body).kind)
1767 } else if match_qpath(path_right, expected_left) && match_qpath(path_left, expected_right) {
1768 (&(*arms[1].body).kind, &(*arms[0].body).kind)
1773 match body_node_pair {
1774 (ExprKind::Lit(ref lit_left), ExprKind::Lit(ref lit_right)) => match (&lit_left.node, &lit_right.node) {
1775 (LitKind::Bool(true), LitKind::Bool(false)) => Some(should_be_left),
1776 (LitKind::Bool(false), LitKind::Bool(true)) => Some(should_be_right),
1785 fn test_overlapping() {
1786 use rustc_span::source_map::DUMMY_SP;
1788 let sp = |s, e| SpannedRange {
1793 assert_eq!(None, overlapping::<u8>(&[]));
1794 assert_eq!(None, overlapping(&[sp(1, Bound::Included(4))]));
1797 overlapping(&[sp(1, Bound::Included(4)), sp(5, Bound::Included(6))])
1802 sp(1, Bound::Included(4)),
1803 sp(5, Bound::Included(6)),
1804 sp(10, Bound::Included(11))
1808 Some((&sp(1, Bound::Included(4)), &sp(3, Bound::Included(6)))),
1809 overlapping(&[sp(1, Bound::Included(4)), sp(3, Bound::Included(6))])
1812 Some((&sp(5, Bound::Included(6)), &sp(6, Bound::Included(11)))),
1814 sp(1, Bound::Included(4)),
1815 sp(5, Bound::Included(6)),
1816 sp(6, Bound::Included(11))
1821 /// Implementation of `MATCH_SAME_ARMS`.
1822 fn lint_match_arms<'tcx>(cx: &LateContext<'tcx>, expr: &Expr<'_>) {
1823 fn same_bindings<'tcx>(lhs: &FxHashMap<Symbol, Ty<'tcx>>, rhs: &FxHashMap<Symbol, Ty<'tcx>>) -> bool {
1824 lhs.len() == rhs.len()
1827 .all(|(name, l_ty)| rhs.get(name).map_or(false, |r_ty| TyS::same_type(l_ty, r_ty)))
1830 if let ExprKind::Match(_, ref arms, MatchSource::Normal) = expr.kind {
1831 let hash = |&(_, arm): &(usize, &Arm<'_>)| -> u64 {
1832 let mut h = SpanlessHash::new(cx);
1833 h.hash_expr(&arm.body);
1837 let eq = |&(lindex, lhs): &(usize, &Arm<'_>), &(rindex, rhs): &(usize, &Arm<'_>)| -> bool {
1838 let min_index = usize::min(lindex, rindex);
1839 let max_index = usize::max(lindex, rindex);
1841 // Arms with a guard are ignored, those can’t always be merged together
1842 // This is also the case for arms in-between each there is an arm with a guard
1843 (min_index..=max_index).all(|index| arms[index].guard.is_none()) &&
1844 SpanlessEq::new(cx).eq_expr(&lhs.body, &rhs.body) &&
1845 // all patterns should have the same bindings
1846 same_bindings(&bindings(cx, &lhs.pat), &bindings(cx, &rhs.pat))
1849 let indexed_arms: Vec<(usize, &Arm<'_>)> = arms.iter().enumerate().collect();
1850 for (&(_, i), &(_, j)) in search_same(&indexed_arms, hash, eq) {
1855 "this `match` has identical arm bodies",
1857 diag.span_note(i.body.span, "same as this");
1859 // Note: this does not use `span_suggestion` on purpose:
1860 // there is no clean way
1861 // to remove the other arm. Building a span and suggest to replace it to ""
1862 // makes an even more confusing error message. Also in order not to make up a
1863 // span for the whole pattern, the suggestion is only shown when there is only
1864 // one pattern. The user should know about `|` if they are already using it…
1866 let lhs = snippet(cx, i.pat.span, "<pat1>");
1867 let rhs = snippet(cx, j.pat.span, "<pat2>");
1869 if let PatKind::Wild = j.pat.kind {
1870 // if the last arm is _, then i could be integrated into _
1871 // note that i.pat cannot be _, because that would mean that we're
1872 // hiding all the subsequent arms, and rust won't compile
1876 "`{}` has the same arm body as the `_` wildcard, consider removing it",
1881 diag.span_help(i.pat.span, &format!("consider refactoring into `{} | {}`", lhs, rhs));
1889 /// Returns the list of bindings in a pattern.
1890 fn bindings<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>) -> FxHashMap<Symbol, Ty<'tcx>> {
1891 fn bindings_impl<'tcx>(cx: &LateContext<'tcx>, pat: &Pat<'_>, map: &mut FxHashMap<Symbol, Ty<'tcx>>) {
1893 PatKind::Box(ref pat) | PatKind::Ref(ref pat, _) => bindings_impl(cx, pat, map),
1894 PatKind::TupleStruct(_, pats, _) => {
1896 bindings_impl(cx, pat, map);
1899 PatKind::Binding(.., ident, ref as_pat) => {
1900 if let Entry::Vacant(v) = map.entry(ident.name) {
1901 v.insert(cx.typeck_results().pat_ty(pat));
1903 if let Some(ref as_pat) = *as_pat {
1904 bindings_impl(cx, as_pat, map);
1907 PatKind::Or(fields) | PatKind::Tuple(fields, _) => {
1909 bindings_impl(cx, pat, map);
1912 PatKind::Struct(_, fields, _) => {
1914 bindings_impl(cx, &pat.pat, map);
1917 PatKind::Slice(lhs, ref mid, rhs) => {
1919 bindings_impl(cx, pat, map);
1921 if let Some(ref mid) = *mid {
1922 bindings_impl(cx, mid, map);
1925 bindings_impl(cx, pat, map);
1928 PatKind::Lit(..) | PatKind::Range(..) | PatKind::Wild | PatKind::Path(..) => (),
1932 let mut result = FxHashMap::default();
1933 bindings_impl(cx, pat, &mut result);