clippy_lints/src/methods/mod.rs

   1 mod option_map_unwrap_or;
   2 mod unnecessary_filter_map;
   3
   4 use std::borrow::Cow;
   5 use std::fmt;
   6 use std::iter;
   7
   8 use if_chain::if_chain;
   9 use matches::matches;
  10 use rustc::hir;
  11 use rustc::hir::intravisit::{self, Visitor};
  12 use rustc::lint::{in_external_macro, LateContext, LateLintPass, Lint, LintArray, LintContext, LintPass};
  13 use rustc::ty::{self, Predicate, Ty};
  14 use rustc::{declare_lint_pass, declare_tool_lint};
  15 use rustc_errors::Applicability;
  16 use syntax::ast;
  17 use syntax::source_map::Span;
  18 use syntax::symbol::{sym, LocalInternedString};
  19
  20 use crate::utils::sugg;
  21 use crate::utils::usage::mutated_variables;
  22 use crate::utils::{
  23     get_arg_name, get_parent_expr, get_trait_def_id, has_iter_method, implements_trait, in_macro, is_copy,
  24     is_ctor_function, is_expn_of, iter_input_pats, last_path_segment, match_def_path, match_qpath, match_trait_method,
  25     match_type, match_var, method_calls, method_chain_args, remove_blocks, return_ty, same_tys, single_segment_path,
  26     snippet, snippet_with_applicability, snippet_with_macro_callsite, span_lint, span_lint_and_sugg,
  27     span_lint_and_then, span_note_and_lint, walk_ptrs_ty, walk_ptrs_ty_depth, SpanlessEq,
  28 };
  29 use crate::utils::{paths, span_help_and_lint};
  30
  31 declare_clippy_lint! {
  32     /// **What it does:** Checks for `.unwrap()` calls on `Option`s.
  33     ///
  34     /// **Why is this bad?** Usually it is better to handle the `None` case, or to
  35     /// at least call `.expect(_)` with a more helpful message. Still, for a lot of
  36     /// quick-and-dirty code, `unwrap` is a good choice, which is why this lint is
  37     /// `Allow` by default.
  38     ///
  39     /// **Known problems:** None.
  40     ///
  41     /// **Example:**
  42     ///
  43     /// Using unwrap on an `Option`:
  44     ///
  45     /// ```rust
  46     /// let opt = Some(1);
  47     /// opt.unwrap();
  48     /// ```
  49     ///
  50     /// Better:
  51     ///
  52     /// ```rust
  53     /// let opt = Some(1);
  54     /// opt.expect("more helpful message");
  55     /// ```
  56     pub OPTION_UNWRAP_USED,
  57     restriction,
  58     "using `Option.unwrap()`, which should at least get a better message using `expect()`"
  59 }
  60
  61 declare_clippy_lint! {
  62     /// **What it does:** Checks for `.unwrap()` calls on `Result`s.
  63     ///
  64     /// **Why is this bad?** `result.unwrap()` will let the thread panic on `Err`
  65     /// values. Normally, you want to implement more sophisticated error handling,
  66     /// and propagate errors upwards with `try!`.
  67     ///
  68     /// Even if you want to panic on errors, not all `Error`s implement good
  69     /// messages on display. Therefore, it may be beneficial to look at the places
  70     /// where they may get displayed. Activate this lint to do just that.
  71     ///
  72     /// **Known problems:** None.
  73     ///
  74     /// **Example:**
  75     /// Using unwrap on an `Option`:
  76     ///
  77     /// ```rust
  78     /// let res: Result<usize, ()> = Ok(1);
  79     /// res.unwrap();
  80     /// ```
  81     ///
  82     /// Better:
  83     ///
  84     /// ```rust
  85     /// let res: Result<usize, ()> = Ok(1);
  86     /// res.expect("more helpful message");
  87     /// ```
  88     pub RESULT_UNWRAP_USED,
  89     restriction,
  90     "using `Result.unwrap()`, which might be better handled"
  91 }
  92
  93 declare_clippy_lint! {
  94     /// **What it does:** Checks for methods that should live in a trait
  95     /// implementation of a `std` trait (see [llogiq's blog
  96     /// post](http://llogiq.github.io/2015/07/30/traits.html) for further
  97     /// information) instead of an inherent implementation.
  98     ///
  99     /// **Why is this bad?** Implementing the traits improve ergonomics for users of
 100     /// the code, often with very little cost. Also people seeing a `mul(...)`
 101     /// method
 102     /// may expect `*` to work equally, so you should have good reason to disappoint
 103     /// them.
 104     ///
 105     /// **Known problems:** None.
 106     ///
 107     /// **Example:**
 108     /// ```ignore
 109     /// struct X;
 110     /// impl X {
 111     ///     fn add(&self, other: &X) -> X {
 112     ///         ..
 113     ///     }
 114     /// }
 115     /// ```
 116     pub SHOULD_IMPLEMENT_TRAIT,
 117     style,
 118     "defining a method that should be implementing a std trait"
 119 }
 120
 121 declare_clippy_lint! {
 122     /// **What it does:** Checks for methods with certain name prefixes and which
 123     /// doesn't match how self is taken. The actual rules are:
 124     ///
 125     /// |Prefix |`self` taken          |
 126     /// |-------|----------------------|
 127     /// |`as_`  |`&self` or `&mut self`|
 128     /// |`from_`| none                 |
 129     /// |`into_`|`self`                |
 130     /// |`is_`  |`&self` or none       |
 131     /// |`to_`  |`&self`               |
 132     ///
 133     /// **Why is this bad?** Consistency breeds readability. If you follow the
 134     /// conventions, your users won't be surprised that they, e.g., need to supply a
 135     /// mutable reference to a `as_..` function.
 136     ///
 137     /// **Known problems:** None.
 138     ///
 139     /// **Example:**
 140     /// ```ignore
 141     /// impl X {
 142     ///     fn as_str(self) -> &str {
 143     ///         ..
 144     ///     }
 145     /// }
 146     /// ```
 147     pub WRONG_SELF_CONVENTION,
 148     style,
 149     "defining a method named with an established prefix (like \"into_\") that takes `self` with the wrong convention"
 150 }
 151
 152 declare_clippy_lint! {
 153     /// **What it does:** This is the same as
 154     /// [`wrong_self_convention`](#wrong_self_convention), but for public items.
 155     ///
 156     /// **Why is this bad?** See [`wrong_self_convention`](#wrong_self_convention).
 157     ///
 158     /// **Known problems:** Actually *renaming* the function may break clients if
 159     /// the function is part of the public interface. In that case, be mindful of
 160     /// the stability guarantees you've given your users.
 161     ///
 162     /// **Example:**
 163     /// ```rust
 164     /// # struct X;
 165     /// impl<'a> X {
 166     ///     pub fn as_str(self) -> &'a str {
 167     ///         "foo"
 168     ///     }
 169     /// }
 170     /// ```
 171     pub WRONG_PUB_SELF_CONVENTION,
 172     restriction,
 173     "defining a public method named with an established prefix (like \"into_\") that takes `self` with the wrong convention"
 174 }
 175
 176 declare_clippy_lint! {
 177     /// **What it does:** Checks for usage of `ok().expect(..)`.
 178     ///
 179     /// **Why is this bad?** Because you usually call `expect()` on the `Result`
 180     /// directly to get a better error message.
 181     ///
 182     /// **Known problems:** The error type needs to implement `Debug`
 183     ///
 184     /// **Example:**
 185     /// ```ignore
 186     /// x.ok().expect("why did I do this again?")
 187     /// ```
 188     pub OK_EXPECT,
 189     style,
 190     "using `ok().expect()`, which gives worse error messages than calling `expect` directly on the Result"
 191 }
 192
 193 declare_clippy_lint! {
 194     /// **What it does:** Checks for usage of `_.map(_).unwrap_or(_)`.
 195     ///
 196     /// **Why is this bad?** Readability, this can be written more concisely as
 197     /// `_.map_or(_, _)`.
 198     ///
 199     /// **Known problems:** The order of the arguments is not in execution order
 200     ///
 201     /// **Example:**
 202     /// ```rust
 203     /// # let x = Some(1);
 204     /// x.map(|a| a + 1).unwrap_or(0);
 205     /// ```
 206     pub OPTION_MAP_UNWRAP_OR,
 207     pedantic,
 208     "using `Option.map(f).unwrap_or(a)`, which is more succinctly expressed as `map_or(a, f)`"
 209 }
 210
 211 declare_clippy_lint! {
 212     /// **What it does:** Checks for usage of `_.map(_).unwrap_or_else(_)`.
 213     ///
 214     /// **Why is this bad?** Readability, this can be written more concisely as
 215     /// `_.map_or_else(_, _)`.
 216     ///
 217     /// **Known problems:** The order of the arguments is not in execution order.
 218     ///
 219     /// **Example:**
 220     /// ```rust
 221     /// # let x = Some(1);
 222     /// # fn some_function() -> usize { 1 }
 223     /// x.map(|a| a + 1).unwrap_or_else(some_function);
 224     /// ```
 225     pub OPTION_MAP_UNWRAP_OR_ELSE,
 226     pedantic,
 227     "using `Option.map(f).unwrap_or_else(g)`, which is more succinctly expressed as `map_or_else(g, f)`"
 228 }
 229
 230 declare_clippy_lint! {
 231     /// **What it does:** Checks for usage of `result.map(_).unwrap_or_else(_)`.
 232     ///
 233     /// **Why is this bad?** Readability, this can be written more concisely as
 234     /// `result.ok().map_or_else(_, _)`.
 235     ///
 236     /// **Known problems:** None.
 237     ///
 238     /// **Example:**
 239     /// ```rust
 240     /// # let x: Result<usize, ()> = Ok(1);
 241     /// # fn some_function(foo: ()) -> usize { 1 }
 242     /// x.map(|a| a + 1).unwrap_or_else(some_function);
 243     /// ```
 244     pub RESULT_MAP_UNWRAP_OR_ELSE,
 245     pedantic,
 246     "using `Result.map(f).unwrap_or_else(g)`, which is more succinctly expressed as `.ok().map_or_else(g, f)`"
 247 }
 248
 249 declare_clippy_lint! {
 250     /// **What it does:** Checks for usage of `_.map_or(None, _)`.
 251     ///
 252     /// **Why is this bad?** Readability, this can be written more concisely as
 253     /// `_.and_then(_)`.
 254     ///
 255     /// **Known problems:** The order of the arguments is not in execution order.
 256     ///
 257     /// **Example:**
 258     /// ```ignore
 259     /// opt.map_or(None, |a| a + 1)
 260     /// ```
 261     pub OPTION_MAP_OR_NONE,
 262     style,
 263     "using `Option.map_or(None, f)`, which is more succinctly expressed as `and_then(f)`"
 264 }
 265
 266 declare_clippy_lint! {
 267     /// **What it does:** Checks for usage of `_.and_then(|x| Some(y))`.
 268     ///
 269     /// **Why is this bad?** Readability, this can be written more concisely as
 270     /// `_.map(|x| y)`.
 271     ///
 272     /// **Known problems:** None
 273     ///
 274     /// **Example:**
 275     ///
 276     /// ```rust
 277     /// let x = Some("foo");
 278     /// let _ = x.and_then(|s| Some(s.len()));
 279     /// ```
 280     ///
 281     /// The correct use would be:
 282     ///
 283     /// ```rust
 284     /// let x = Some("foo");
 285     /// let _ = x.map(|s| s.len());
 286     /// ```
 287     pub OPTION_AND_THEN_SOME,
 288     complexity,
 289     "using `Option.and_then(|x| Some(y))`, which is more succinctly expressed as `map(|x| y)`"
 290 }
 291
 292 declare_clippy_lint! {
 293     /// **What it does:** Checks for usage of `_.filter(_).next()`.
 294     ///
 295     /// **Why is this bad?** Readability, this can be written more concisely as
 296     /// `_.find(_)`.
 297     ///
 298     /// **Known problems:** None.
 299     ///
 300     /// **Example:**
 301     /// ```rust
 302     /// # let vec = vec![1];
 303     /// vec.iter().filter(|x| **x == 0).next();
 304     /// ```
 305     /// Could be written as
 306     /// ```rust
 307     /// # let vec = vec![1];
 308     /// vec.iter().find(|x| **x == 0);
 309     /// ```
 310     pub FILTER_NEXT,
 311     complexity,
 312     "using `filter(p).next()`, which is more succinctly expressed as `.find(p)`"
 313 }
 314
 315 declare_clippy_lint! {
 316     /// **What it does:** Checks for usage of `_.map(_).flatten(_)`,
 317     ///
 318     /// **Why is this bad?** Readability, this can be written more concisely as a
 319     /// single method call.
 320     ///
 321     /// **Known problems:**
 322     ///
 323     /// **Example:**
 324     /// ```rust
 325     /// let vec = vec![vec![1]];
 326     /// vec.iter().map(|x| x.iter()).flatten();
 327     /// ```
 328     pub MAP_FLATTEN,
 329     pedantic,
 330     "using combinations of `flatten` and `map` which can usually be written as a single method call"
 331 }
 332
 333 declare_clippy_lint! {
 334     /// **What it does:** Checks for usage of `_.filter(_).map(_)`,
 335     /// `_.filter(_).flat_map(_)`, `_.filter_map(_).flat_map(_)` and similar.
 336     ///
 337     /// **Why is this bad?** Readability, this can be written more concisely as a
 338     /// single method call.
 339     ///
 340     /// **Known problems:** Often requires a condition + Option/Iterator creation
 341     /// inside the closure.
 342     ///
 343     /// **Example:**
 344     /// ```rust
 345     /// let vec = vec![1];
 346     /// vec.iter().filter(|x| **x == 0).map(|x| *x * 2);
 347     /// ```
 348     pub FILTER_MAP,
 349     pedantic,
 350     "using combinations of `filter`, `map`, `filter_map` and `flat_map` which can usually be written as a single method call"
 351 }
 352
 353 declare_clippy_lint! {
 354     /// **What it does:** Checks for usage of `_.filter_map(_).next()`.
 355     ///
 356     /// **Why is this bad?** Readability, this can be written more concisely as a
 357     /// single method call.
 358     ///
 359     /// **Known problems:** None
 360     ///
 361     /// **Example:**
 362     /// ```rust
 363     ///  (0..3).filter_map(|x| if x == 2 { Some(x) } else { None }).next();
 364     /// ```
 365     /// Can be written as
 366     ///
 367     /// ```rust
 368     ///  (0..3).find_map(|x| if x == 2 { Some(x) } else { None });
 369     /// ```
 370     pub FILTER_MAP_NEXT,
 371     pedantic,
 372     "using combination of `filter_map` and `next` which can usually be written as a single method call"
 373 }
 374
 375 declare_clippy_lint! {
 376     /// **What it does:** Checks for usage of `flat_map(|x| x)`.
 377     ///
 378     /// **Why is this bad?** Readability, this can be written more concisely by using `flatten`.
 379     ///
 380     /// **Known problems:** None
 381     ///
 382     /// **Example:**
 383     /// ```rust
 384     /// # let iter = vec![vec![0]].into_iter();
 385     /// iter.flat_map(|x| x);
 386     /// ```
 387     /// Can be written as
 388     /// ```rust
 389     /// # let iter = vec![vec![0]].into_iter();
 390     /// iter.flatten();
 391     /// ```
 392     pub FLAT_MAP_IDENTITY,
 393     complexity,
 394     "call to `flat_map` where `flatten` is sufficient"
 395 }
 396
 397 declare_clippy_lint! {
 398     /// **What it does:** Checks for usage of `_.find(_).map(_)`.
 399     ///
 400     /// **Why is this bad?** Readability, this can be written more concisely as a
 401     /// single method call.
 402     ///
 403     /// **Known problems:** Often requires a condition + Option/Iterator creation
 404     /// inside the closure.
 405     ///
 406     /// **Example:**
 407     /// ```rust
 408     ///  (0..3).find(|x| *x == 2).map(|x| x * 2);
 409     /// ```
 410     /// Can be written as
 411     /// ```rust
 412     ///  (0..3).find_map(|x| if x == 2 { Some(x * 2) } else { None });
 413     /// ```
 414     pub FIND_MAP,
 415     pedantic,
 416     "using a combination of `find` and `map` can usually be written as a single method call"
 417 }
 418
 419 declare_clippy_lint! {
 420     /// **What it does:** Checks for an iterator search (such as `find()`,
 421     /// `position()`, or `rposition()`) followed by a call to `is_some()`.
 422     ///
 423     /// **Why is this bad?** Readability, this can be written more concisely as
 424     /// `_.any(_)`.
 425     ///
 426     /// **Known problems:** None.
 427     ///
 428     /// **Example:**
 429     /// ```rust
 430     /// # let vec = vec![1];
 431     /// vec.iter().find(|x| **x == 0).is_some();
 432     /// ```
 433     /// Could be written as
 434     /// ```rust
 435     /// # let vec = vec![1];
 436     /// vec.iter().any(|x| *x == 0);
 437     /// ```
 438     pub SEARCH_IS_SOME,
 439     complexity,
 440     "using an iterator search followed by `is_some()`, which is more succinctly expressed as a call to `any()`"
 441 }
 442
 443 declare_clippy_lint! {
 444     /// **What it does:** Checks for usage of `.chars().next()` on a `str` to check
 445     /// if it starts with a given char.
 446     ///
 447     /// **Why is this bad?** Readability, this can be written more concisely as
 448     /// `_.starts_with(_)`.
 449     ///
 450     /// **Known problems:** None.
 451     ///
 452     /// **Example:**
 453     /// ```rust
 454     /// let name = "foo";
 455     /// if name.chars().next() == Some('_') {};
 456     /// ```
 457     /// Could be written as
 458     /// ```rust
 459     /// let name = "foo";
 460     /// if name.starts_with('_') {};
 461     /// ```
 462     pub CHARS_NEXT_CMP,
 463     complexity,
 464     "using `.chars().next()` to check if a string starts with a char"
 465 }
 466
 467 declare_clippy_lint! {
 468     /// **What it does:** Checks for calls to `.or(foo(..))`, `.unwrap_or(foo(..))`,
 469     /// etc., and suggests to use `or_else`, `unwrap_or_else`, etc., or
 470     /// `unwrap_or_default` instead.
 471     ///
 472     /// **Why is this bad?** The function will always be called and potentially
 473     /// allocate an object acting as the default.
 474     ///
 475     /// **Known problems:** If the function has side-effects, not calling it will
 476     /// change the semantic of the program, but you shouldn't rely on that anyway.
 477     ///
 478     /// **Example:**
 479     /// ```rust
 480     /// # let foo = Some(String::new());
 481     /// foo.unwrap_or(String::new());
 482     /// ```
 483     /// this can instead be written:
 484     /// ```rust
 485     /// # let foo = Some(String::new());
 486     /// foo.unwrap_or_else(String::new);
 487     /// ```
 488     /// or
 489     /// ```rust
 490     /// # let foo = Some(String::new());
 491     /// foo.unwrap_or_default();
 492     /// ```
 493     pub OR_FUN_CALL,
 494     perf,
 495     "using any `*or` method with a function call, which suggests `*or_else`"
 496 }
 497
 498 declare_clippy_lint! {
 499     /// **What it does:** Checks for calls to `.expect(&format!(...))`, `.expect(foo(..))`,
 500     /// etc., and suggests to use `unwrap_or_else` instead
 501     ///
 502     /// **Why is this bad?** The function will always be called.
 503     ///
 504     /// **Known problems:** If the function has side-effects, not calling it will
 505     /// change the semantics of the program, but you shouldn't rely on that anyway.
 506     ///
 507     /// **Example:**
 508     /// ```rust
 509     /// # let foo = Some(String::new());
 510     /// # let err_code = "418";
 511     /// # let err_msg = "I'm a teapot";
 512     /// foo.expect(&format!("Err {}: {}", err_code, err_msg));
 513     /// ```
 514     /// or
 515     /// ```rust
 516     /// # let foo = Some(String::new());
 517     /// # let err_code = "418";
 518     /// # let err_msg = "I'm a teapot";
 519     /// foo.expect(format!("Err {}: {}", err_code, err_msg).as_str());
 520     /// ```
 521     /// this can instead be written:
 522     /// ```rust
 523     /// # let foo = Some(String::new());
 524     /// # let err_code = "418";
 525     /// # let err_msg = "I'm a teapot";
 526     /// foo.unwrap_or_else(|| panic!("Err {}: {}", err_code, err_msg));
 527     /// ```
 528     pub EXPECT_FUN_CALL,
 529     perf,
 530     "using any `expect` method with a function call"
 531 }
 532
 533 declare_clippy_lint! {
 534     /// **What it does:** Checks for usage of `.clone()` on a `Copy` type.
 535     ///
 536     /// **Why is this bad?** The only reason `Copy` types implement `Clone` is for
 537     /// generics, not for using the `clone` method on a concrete type.
 538     ///
 539     /// **Known problems:** None.
 540     ///
 541     /// **Example:**
 542     /// ```rust
 543     /// 42u64.clone();
 544     /// ```
 545     pub CLONE_ON_COPY,
 546     complexity,
 547     "using `clone` on a `Copy` type"
 548 }
 549
 550 declare_clippy_lint! {
 551     /// **What it does:** Checks for usage of `.clone()` on a ref-counted pointer,
 552     /// (`Rc`, `Arc`, `rc::Weak`, or `sync::Weak`), and suggests calling Clone via unified
 553     /// function syntax instead (e.g., `Rc::clone(foo)`).
 554     ///
 555     /// **Why is this bad?** Calling '.clone()' on an Rc, Arc, or Weak
 556     /// can obscure the fact that only the pointer is being cloned, not the underlying
 557     /// data.
 558     ///
 559     /// **Example:**
 560     /// ```rust
 561     /// # use std::rc::Rc;
 562     /// let x = Rc::new(1);
 563     /// x.clone();
 564     /// ```
 565     pub CLONE_ON_REF_PTR,
 566     restriction,
 567     "using 'clone' on a ref-counted pointer"
 568 }
 569
 570 declare_clippy_lint! {
 571     /// **What it does:** Checks for usage of `.clone()` on an `&&T`.
 572     ///
 573     /// **Why is this bad?** Cloning an `&&T` copies the inner `&T`, instead of
 574     /// cloning the underlying `T`.
 575     ///
 576     /// **Known problems:** None.
 577     ///
 578     /// **Example:**
 579     /// ```rust
 580     /// fn main() {
 581     ///     let x = vec![1];
 582     ///     let y = &&x;
 583     ///     let z = y.clone();
 584     ///     println!("{:p} {:p}", *y, z); // prints out the same pointer
 585     /// }
 586     /// ```
 587     pub CLONE_DOUBLE_REF,
 588     correctness,
 589     "using `clone` on `&&T`"
 590 }
 591
 592 declare_clippy_lint! {
 593     /// **What it does:** Checks for `new` not returning `Self`.
 594     ///
 595     /// **Why is this bad?** As a convention, `new` methods are used to make a new
 596     /// instance of a type.
 597     ///
 598     /// **Known problems:** None.
 599     ///
 600     /// **Example:**
 601     /// ```ignore
 602     /// impl Foo {
 603     ///     fn new(..) -> NotAFoo {
 604     ///     }
 605     /// }
 606     /// ```
 607     pub NEW_RET_NO_SELF,
 608     style,
 609     "not returning `Self` in a `new` method"
 610 }
 611
 612 declare_clippy_lint! {
 613     /// **What it does:** Checks for string methods that receive a single-character
 614     /// `str` as an argument, e.g., `_.split("x")`.
 615     ///
 616     /// **Why is this bad?** Performing these methods using a `char` is faster than
 617     /// using a `str`.
 618     ///
 619     /// **Known problems:** Does not catch multi-byte unicode characters.
 620     ///
 621     /// **Example:**
 622     /// `_.split("x")` could be `_.split('x')`
 623     pub SINGLE_CHAR_PATTERN,
 624     perf,
 625     "using a single-character str where a char could be used, e.g., `_.split(\"x\")`"
 626 }
 627
 628 declare_clippy_lint! {
 629     /// **What it does:** Checks for getting the inner pointer of a temporary
 630     /// `CString`.
 631     ///
 632     /// **Why is this bad?** The inner pointer of a `CString` is only valid as long
 633     /// as the `CString` is alive.
 634     ///
 635     /// **Known problems:** None.
 636     ///
 637     /// **Example:**
 638     /// ```rust,ignore
 639     /// let c_str = CString::new("foo").unwrap().as_ptr();
 640     /// unsafe {
 641     ///     call_some_ffi_func(c_str);
 642     /// }
 643     /// ```
 644     /// Here `c_str` point to a freed address. The correct use would be:
 645     /// ```rust,ignore
 646     /// let c_str = CString::new("foo").unwrap();
 647     /// unsafe {
 648     ///     call_some_ffi_func(c_str.as_ptr());
 649     /// }
 650     /// ```
 651     pub TEMPORARY_CSTRING_AS_PTR,
 652     correctness,
 653     "getting the inner pointer of a temporary `CString`"
 654 }
 655
 656 declare_clippy_lint! {
 657     /// **What it does:** Checks for use of `.iter().nth()` (and the related
 658     /// `.iter_mut().nth()`) on standard library types with O(1) element access.
 659     ///
 660     /// **Why is this bad?** `.get()` and `.get_mut()` are more efficient and more
 661     /// readable.
 662     ///
 663     /// **Known problems:** None.
 664     ///
 665     /// **Example:**
 666     /// ```rust
 667     /// let some_vec = vec![0, 1, 2, 3];
 668     /// let bad_vec = some_vec.iter().nth(3);
 669     /// let bad_slice = &some_vec[..].iter().nth(3);
 670     /// ```
 671     /// The correct use would be:
 672     /// ```rust
 673     /// let some_vec = vec![0, 1, 2, 3];
 674     /// let bad_vec = some_vec.get(3);
 675     /// let bad_slice = &some_vec[..].get(3);
 676     /// ```
 677     pub ITER_NTH,
 678     perf,
 679     "using `.iter().nth()` on a standard library type with O(1) element access"
 680 }
 681
 682 declare_clippy_lint! {
 683     /// **What it does:** Checks for use of `.skip(x).next()` on iterators.
 684     ///
 685     /// **Why is this bad?** `.nth(x)` is cleaner
 686     ///
 687     /// **Known problems:** None.
 688     ///
 689     /// **Example:**
 690     /// ```rust
 691     /// let some_vec = vec![0, 1, 2, 3];
 692     /// let bad_vec = some_vec.iter().skip(3).next();
 693     /// let bad_slice = &some_vec[..].iter().skip(3).next();
 694     /// ```
 695     /// The correct use would be:
 696     /// ```rust
 697     /// let some_vec = vec![0, 1, 2, 3];
 698     /// let bad_vec = some_vec.iter().nth(3);
 699     /// let bad_slice = &some_vec[..].iter().nth(3);
 700     /// ```
 701     pub ITER_SKIP_NEXT,
 702     style,
 703     "using `.skip(x).next()` on an iterator"
 704 }
 705
 706 declare_clippy_lint! {
 707     /// **What it does:** Checks for use of `.get().unwrap()` (or
 708     /// `.get_mut().unwrap`) on a standard library type which implements `Index`
 709     ///
 710     /// **Why is this bad?** Using the Index trait (`[]`) is more clear and more
 711     /// concise.
 712     ///
 713     /// **Known problems:** Not a replacement for error handling: Using either
 714     /// `.unwrap()` or the Index trait (`[]`) carries the risk of causing a `panic`
 715     /// if the value being accessed is `None`. If the use of `.get().unwrap()` is a
 716     /// temporary placeholder for dealing with the `Option` type, then this does
 717     /// not mitigate the need for error handling. If there is a chance that `.get()`
 718     /// will be `None` in your program, then it is advisable that the `None` case
 719     /// is handled in a future refactor instead of using `.unwrap()` or the Index
 720     /// trait.
 721     ///
 722     /// **Example:**
 723     /// ```rust
 724     /// let mut some_vec = vec![0, 1, 2, 3];
 725     /// let last = some_vec.get(3).unwrap();
 726     /// *some_vec.get_mut(0).unwrap() = 1;
 727     /// ```
 728     /// The correct use would be:
 729     /// ```rust
 730     /// let mut some_vec = vec![0, 1, 2, 3];
 731     /// let last = some_vec[3];
 732     /// some_vec[0] = 1;
 733     /// ```
 734     pub GET_UNWRAP,
 735     restriction,
 736     "using `.get().unwrap()` or `.get_mut().unwrap()` when using `[]` would work instead"
 737 }
 738
 739 declare_clippy_lint! {
 740     /// **What it does:** Checks for the use of `.extend(s.chars())` where s is a
 741     /// `&str` or `String`.
 742     ///
 743     /// **Why is this bad?** `.push_str(s)` is clearer
 744     ///
 745     /// **Known problems:** None.
 746     ///
 747     /// **Example:**
 748     /// ```rust
 749     /// let abc = "abc";
 750     /// let def = String::from("def");
 751     /// let mut s = String::new();
 752     /// s.extend(abc.chars());
 753     /// s.extend(def.chars());
 754     /// ```
 755     /// The correct use would be:
 756     /// ```rust
 757     /// let abc = "abc";
 758     /// let def = String::from("def");
 759     /// let mut s = String::new();
 760     /// s.push_str(abc);
 761     /// s.push_str(&def);
 762     /// ```
 763     pub STRING_EXTEND_CHARS,
 764     style,
 765     "using `x.extend(s.chars())` where s is a `&str` or `String`"
 766 }
 767
 768 declare_clippy_lint! {
 769     /// **What it does:** Checks for the use of `.cloned().collect()` on slice to
 770     /// create a `Vec`.
 771     ///
 772     /// **Why is this bad?** `.to_vec()` is clearer
 773     ///
 774     /// **Known problems:** None.
 775     ///
 776     /// **Example:**
 777     /// ```rust
 778     /// let s = [1, 2, 3, 4, 5];
 779     /// let s2: Vec<isize> = s[..].iter().cloned().collect();
 780     /// ```
 781     /// The better use would be:
 782     /// ```rust
 783     /// let s = [1, 2, 3, 4, 5];
 784     /// let s2: Vec<isize> = s.to_vec();
 785     /// ```
 786     pub ITER_CLONED_COLLECT,
 787     style,
 788     "using `.cloned().collect()` on slice to create a `Vec`"
 789 }
 790
 791 declare_clippy_lint! {
 792     /// **What it does:** Checks for usage of `.chars().last()` or
 793     /// `.chars().next_back()` on a `str` to check if it ends with a given char.
 794     ///
 795     /// **Why is this bad?** Readability, this can be written more concisely as
 796     /// `_.ends_with(_)`.
 797     ///
 798     /// **Known problems:** None.
 799     ///
 800     /// **Example:**
 801     /// ```ignore
 802     /// name.chars().last() == Some('_') || name.chars().next_back() == Some('-')
 803     /// ```
 804     pub CHARS_LAST_CMP,
 805     style,
 806     "using `.chars().last()` or `.chars().next_back()` to check if a string ends with a char"
 807 }
 808
 809 declare_clippy_lint! {
 810     /// **What it does:** Checks for usage of `.as_ref()` or `.as_mut()` where the
 811     /// types before and after the call are the same.
 812     ///
 813     /// **Why is this bad?** The call is unnecessary.
 814     ///
 815     /// **Known problems:** None.
 816     ///
 817     /// **Example:**
 818     /// ```rust
 819     /// # fn do_stuff(x: &[i32]) {}
 820     /// let x: &[i32] = &[1, 2, 3, 4, 5];
 821     /// do_stuff(x.as_ref());
 822     /// ```
 823     /// The correct use would be:
 824     /// ```rust
 825     /// # fn do_stuff(x: &[i32]) {}
 826     /// let x: &[i32] = &[1, 2, 3, 4, 5];
 827     /// do_stuff(x);
 828     /// ```
 829     pub USELESS_ASREF,
 830     complexity,
 831     "using `as_ref` where the types before and after the call are the same"
 832 }
 833
 834 declare_clippy_lint! {
 835     /// **What it does:** Checks for using `fold` when a more succinct alternative exists.
 836     /// Specifically, this checks for `fold`s which could be replaced by `any`, `all`,
 837     /// `sum` or `product`.
 838     ///
 839     /// **Why is this bad?** Readability.
 840     ///
 841     /// **Known problems:** False positive in pattern guards. Will be resolved once
 842     /// non-lexical lifetimes are stable.
 843     ///
 844     /// **Example:**
 845     /// ```rust
 846     /// let _ = (0..3).fold(false, |acc, x| acc || x > 2);
 847     /// ```
 848     /// This could be written as:
 849     /// ```rust
 850     /// let _ = (0..3).any(|x| x > 2);
 851     /// ```
 852     pub UNNECESSARY_FOLD,
 853     style,
 854     "using `fold` when a more succinct alternative exists"
 855 }
 856
 857 declare_clippy_lint! {
 858     /// **What it does:** Checks for `filter_map` calls which could be replaced by `filter` or `map`.
 859     /// More specifically it checks if the closure provided is only performing one of the
 860     /// filter or map operations and suggests the appropriate option.
 861     ///
 862     /// **Why is this bad?** Complexity. The intent is also clearer if only a single
 863     /// operation is being performed.
 864     ///
 865     /// **Known problems:** None
 866     ///
 867     /// **Example:**
 868     /// ```rust
 869     /// let _ = (0..3).filter_map(|x| if x > 2 { Some(x) } else { None });
 870     /// ```
 871     /// As there is no transformation of the argument this could be written as:
 872     /// ```rust
 873     /// let _ = (0..3).filter(|&x| x > 2);
 874     /// ```
 875     ///
 876     /// ```rust
 877     /// let _ = (0..4).filter_map(i32::checked_abs);
 878     /// ```
 879     /// As there is no conditional check on the argument this could be written as:
 880     /// ```rust
 881     /// let _ = (0..4).map(i32::checked_abs);
 882     /// ```
 883     pub UNNECESSARY_FILTER_MAP,
 884     complexity,
 885     "using `filter_map` when a more succinct alternative exists"
 886 }
 887
 888 declare_clippy_lint! {
 889     /// **What it does:** Checks for `into_iter` calls on types which should be replaced by `iter` or
 890     /// `iter_mut`.
 891     ///
 892     /// **Why is this bad?** Arrays and `PathBuf` do not yet have an `into_iter` method which move out
 893     /// their content into an iterator. Auto-referencing resolves the `into_iter` call to its reference
 894     /// instead, like `<&[T; N] as IntoIterator>::into_iter`, which just iterates over item references
 895     /// like calling `iter` would. Furthermore, when the standard library actually
 896     /// [implements the `into_iter` method](https://github.com/rust-lang/rust/issues/25725) which moves
 897     /// the content out of the array, the original use of `into_iter` got inferred with the wrong type
 898     /// and the code will be broken.
 899     ///
 900     /// **Known problems:** None
 901     ///
 902     /// **Example:**
 903     ///
 904     /// ```rust
 905     /// let _ = [1, 2, 3].into_iter().map(|x| *x).collect::<Vec<u32>>();
 906     /// ```
 907     /// Could be written as:
 908     /// ```rust
 909     /// let _ = [1, 2, 3].iter().map(|x| *x).collect::<Vec<u32>>();
 910     /// ```
 911     pub INTO_ITER_ON_ARRAY,
 912     correctness,
 913     "using `.into_iter()` on an array"
 914 }
 915
 916 declare_clippy_lint! {
 917     /// **What it does:** Checks for `into_iter` calls on references which should be replaced by `iter`
 918     /// or `iter_mut`.
 919     ///
 920     /// **Why is this bad?** Readability. Calling `into_iter` on a reference will not move out its
 921     /// content into the resulting iterator, which is confusing. It is better just call `iter` or
 922     /// `iter_mut` directly.
 923     ///
 924     /// **Known problems:** None
 925     ///
 926     /// **Example:**
 927     ///
 928     /// ```rust
 929     /// let _ = (&vec![3, 4, 5]).into_iter();
 930     /// ```
 931     pub INTO_ITER_ON_REF,
 932     style,
 933     "using `.into_iter()` on a reference"
 934 }
 935
 936 declare_clippy_lint! {
 937     /// **What it does:** Checks for calls to `map` followed by a `count`.
 938     ///
 939     /// **Why is this bad?** It looks suspicious. Maybe `map` was confused with `filter`.
 940     /// If the `map` call is intentional, this should be rewritten.
 941     ///
 942     /// **Known problems:** None
 943     ///
 944     /// **Example:**
 945     ///
 946     /// ```rust
 947     /// let _ = (0..3).map(|x| x + 2).count();
 948     /// ```
 949     pub SUSPICIOUS_MAP,
 950     complexity,
 951     "suspicious usage of map"
 952 }
 953
 954 declare_clippy_lint! {
 955     /// **What it does:** Checks for `MaybeUninit::uninit().assume_init()`.
 956     ///
 957     /// **Why is this bad?** For most types, this is undefined behavior.
 958     ///
 959     /// **Known problems:** For now, we accept empty tuples and tuples / arrays
 960     /// of `MaybeUninit`. There may be other types that allow uninitialized
 961     /// data, but those are not yet rigorously defined.
 962     ///
 963     /// **Example:**
 964     ///
 965     /// ```rust
 966     /// // Beware the UB
 967     /// use std::mem::MaybeUninit;
 968     ///
 969     /// let _: usize = unsafe { MaybeUninit::uninit().assume_init() };
 970     /// ```
 971     ///
 972     /// Note that the following is OK:
 973     ///
 974     /// ```rust
 975     /// use std::mem::MaybeUninit;
 976     ///
 977     /// let _: [MaybeUninit<bool>; 5] = unsafe {
 978     ///     MaybeUninit::uninit().assume_init()
 979     /// };
 980     /// ```
 981     pub UNINIT_ASSUMED_INIT,
 982     correctness,
 983     "`MaybeUninit::uninit().assume_init()`"
 984 }
 985
 986 declare_lint_pass!(Methods => [
 987     OPTION_UNWRAP_USED,
 988     RESULT_UNWRAP_USED,
 989     SHOULD_IMPLEMENT_TRAIT,
 990     WRONG_SELF_CONVENTION,
 991     WRONG_PUB_SELF_CONVENTION,
 992     OK_EXPECT,
 993     OPTION_MAP_UNWRAP_OR,
 994     OPTION_MAP_UNWRAP_OR_ELSE,
 995     RESULT_MAP_UNWRAP_OR_ELSE,
 996     OPTION_MAP_OR_NONE,
 997     OPTION_AND_THEN_SOME,
 998     OR_FUN_CALL,
 999     EXPECT_FUN_CALL,
1000     CHARS_NEXT_CMP,
1001     CHARS_LAST_CMP,
1002     CLONE_ON_COPY,
1003     CLONE_ON_REF_PTR,
1004     CLONE_DOUBLE_REF,
1005     NEW_RET_NO_SELF,
1006     SINGLE_CHAR_PATTERN,
1007     SEARCH_IS_SOME,
1008     TEMPORARY_CSTRING_AS_PTR,
1009     FILTER_NEXT,
1010     FILTER_MAP,
1011     FILTER_MAP_NEXT,
1012     FLAT_MAP_IDENTITY,
1013     FIND_MAP,
1014     MAP_FLATTEN,
1015     ITER_NTH,
1016     ITER_SKIP_NEXT,
1017     GET_UNWRAP,
1018     STRING_EXTEND_CHARS,
1019     ITER_CLONED_COLLECT,
1020     USELESS_ASREF,
1021     UNNECESSARY_FOLD,
1022     UNNECESSARY_FILTER_MAP,
1023     INTO_ITER_ON_ARRAY,
1024     INTO_ITER_ON_REF,
1025     SUSPICIOUS_MAP,
1026     UNINIT_ASSUMED_INIT,
1027 ]);
1028
1029 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Methods {
1030     #[allow(clippy::cognitive_complexity)]
1031     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr) {
1032         if in_macro(expr.span) {
1033             return;
1034         }
1035
1036         let (method_names, arg_lists, method_spans) = method_calls(expr, 2);
1037         let method_names: Vec<LocalInternedString> = method_names.iter().map(|s| s.as_str()).collect();
1038         let method_names: Vec<&str> = method_names.iter().map(std::convert::AsRef::as_ref).collect();
1039
1040         match method_names.as_slice() {
1041             ["unwrap", "get"] => lint_get_unwrap(cx, expr, arg_lists[1], false),
1042             ["unwrap", "get_mut"] => lint_get_unwrap(cx, expr, arg_lists[1], true),
1043             ["unwrap", ..] => lint_unwrap(cx, expr, arg_lists[0]),
1044             ["expect", "ok"] => lint_ok_expect(cx, expr, arg_lists[1]),
1045             ["unwrap_or", "map"] => option_map_unwrap_or::lint(cx, expr, arg_lists[1], arg_lists[0]),
1046             ["unwrap_or_else", "map"] => lint_map_unwrap_or_else(cx, expr, arg_lists[1], arg_lists[0]),
1047             ["map_or", ..] => lint_map_or_none(cx, expr, arg_lists[0]),
1048             ["and_then", ..] => lint_option_and_then_some(cx, expr, arg_lists[0]),
1049             ["next", "filter"] => lint_filter_next(cx, expr, arg_lists[1]),
1050             ["map", "filter"] => lint_filter_map(cx, expr, arg_lists[1], arg_lists[0]),
1051             ["map", "filter_map"] => lint_filter_map_map(cx, expr, arg_lists[1], arg_lists[0]),
1052             ["next", "filter_map"] => lint_filter_map_next(cx, expr, arg_lists[1]),
1053             ["map", "find"] => lint_find_map(cx, expr, arg_lists[1], arg_lists[0]),
1054             ["flat_map", "filter"] => lint_filter_flat_map(cx, expr, arg_lists[1], arg_lists[0]),
1055             ["flat_map", "filter_map"] => lint_filter_map_flat_map(cx, expr, arg_lists[1], arg_lists[0]),
1056             ["flat_map", ..] => lint_flat_map_identity(cx, expr, arg_lists[0], method_spans[0]),
1057             ["flatten", "map"] => lint_map_flatten(cx, expr, arg_lists[1]),
1058             ["is_some", "find"] => lint_search_is_some(cx, expr, "find", arg_lists[1], arg_lists[0], method_spans[1]),
1059             ["is_some", "position"] => {
1060                 lint_search_is_some(cx, expr, "position", arg_lists[1], arg_lists[0], method_spans[1])
1061             },
1062             ["is_some", "rposition"] => {
1063                 lint_search_is_some(cx, expr, "rposition", arg_lists[1], arg_lists[0], method_spans[1])
1064             },
1065             ["extend", ..] => lint_extend(cx, expr, arg_lists[0]),
1066             ["as_ptr", "unwrap"] | ["as_ptr", "expect"] => {
1067                 lint_cstring_as_ptr(cx, expr, &arg_lists[1][0], &arg_lists[0][0])
1068             },
1069             ["nth", "iter"] => lint_iter_nth(cx, expr, arg_lists[1], false),
1070             ["nth", "iter_mut"] => lint_iter_nth(cx, expr, arg_lists[1], true),
1071             ["next", "skip"] => lint_iter_skip_next(cx, expr),
1072             ["collect", "cloned"] => lint_iter_cloned_collect(cx, expr, arg_lists[1]),
1073             ["as_ref"] => lint_asref(cx, expr, "as_ref", arg_lists[0]),
1074             ["as_mut"] => lint_asref(cx, expr, "as_mut", arg_lists[0]),
1075             ["fold", ..] => lint_unnecessary_fold(cx, expr, arg_lists[0], method_spans[0]),
1076             ["filter_map", ..] => unnecessary_filter_map::lint(cx, expr, arg_lists[0]),
1077             ["count", "map"] => lint_suspicious_map(cx, expr),
1078             ["assume_init"] => lint_maybe_uninit(cx, &arg_lists[0][0], expr),
1079             _ => {},
1080         }
1081
1082         match expr.node {
1083             hir::ExprKind::MethodCall(ref method_call, ref method_span, ref args) => {
1084                 lint_or_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
1085                 lint_expect_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
1086
1087                 let self_ty = cx.tables.expr_ty_adjusted(&args[0]);
1088                 if args.len() == 1 && method_call.ident.name == sym!(clone) {
1089                     lint_clone_on_copy(cx, expr, &args[0], self_ty);
1090                     lint_clone_on_ref_ptr(cx, expr, &args[0]);
1091                 }
1092
1093                 match self_ty.sty {
1094                     ty::Ref(_, ty, _) if ty.sty == ty::Str => {
1095                         for &(method, pos) in &PATTERN_METHODS {
1096                             if method_call.ident.name.as_str() == method && args.len() > pos {
1097                                 lint_single_char_pattern(cx, expr, &args[pos]);
1098                             }
1099                         }
1100                     },
1101                     ty::Ref(..) if method_call.ident.name == sym!(into_iter) => {
1102                         lint_into_iter(cx, expr, self_ty, *method_span);
1103                     },
1104                     _ => (),
1105                 }
1106             },
1107             hir::ExprKind::Binary(op, ref lhs, ref rhs)
1108                 if op.node == hir::BinOpKind::Eq || op.node == hir::BinOpKind::Ne =>
1109             {
1110                 let mut info = BinaryExprInfo {
1111                     expr,
1112                     chain: lhs,
1113                     other: rhs,
1114                     eq: op.node == hir::BinOpKind::Eq,
1115                 };
1116                 lint_binary_expr_with_method_call(cx, &mut info);
1117             }
1118             _ => (),
1119         }
1120     }
1121
1122     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, impl_item: &'tcx hir::ImplItem) {
1123         if in_external_macro(cx.sess(), impl_item.span) {
1124             return;
1125         }
1126         let name = impl_item.ident.name.as_str();
1127         let parent = cx.tcx.hir().get_parent_item(impl_item.hir_id);
1128         let item = cx.tcx.hir().expect_item(parent);
1129         let def_id = cx.tcx.hir().local_def_id(item.hir_id);
1130         let ty = cx.tcx.type_of(def_id);
1131         if_chain! {
1132             if let hir::ImplItemKind::Method(ref sig, id) = impl_item.node;
1133             if let Some(first_arg) = iter_input_pats(&sig.decl, cx.tcx.hir().body(id)).next();
1134             if let hir::ItemKind::Impl(_, _, _, _, None, _, _) = item.node;
1135
1136             let method_def_id = cx.tcx.hir().local_def_id(impl_item.hir_id);
1137             let method_sig = cx.tcx.fn_sig(method_def_id);
1138             let method_sig = cx.tcx.erase_late_bound_regions(&method_sig);
1139
1140             let first_arg_ty = &method_sig.inputs().iter().next();
1141
1142             // check conventions w.r.t. conversion method names and predicates
1143             if let Some(first_arg_ty) = first_arg_ty;
1144
1145             then {
1146                 if cx.access_levels.is_exported(impl_item.hir_id) {
1147                 // check missing trait implementations
1148                     for &(method_name, n_args, self_kind, out_type, trait_name) in &TRAIT_METHODS {
1149                         if name == method_name &&
1150                         sig.decl.inputs.len() == n_args &&
1151                         out_type.matches(cx, &sig.decl.output) &&
1152                         self_kind.matches(cx, ty, first_arg_ty) {
1153                             span_lint(cx, SHOULD_IMPLEMENT_TRAIT, impl_item.span, &format!(
1154                                 "defining a method called `{}` on this type; consider implementing \
1155                                 the `{}` trait or choosing a less ambiguous name", name, trait_name));
1156                         }
1157                     }
1158                 }
1159
1160                 if let Some((ref conv, self_kinds)) = &CONVENTIONS
1161                     .iter()
1162                     .find(|(ref conv, _)| conv.check(&name))
1163                 {
1164                     if !self_kinds.iter().any(|k| k.matches(cx, ty, first_arg_ty)) {
1165                         let lint = if item.vis.node.is_pub() {
1166                             WRONG_PUB_SELF_CONVENTION
1167                         } else {
1168                             WRONG_SELF_CONVENTION
1169                         };
1170
1171                         span_lint(
1172                             cx,
1173                             lint,
1174                             first_arg.pat.span,
1175                             &format!(
1176                                "methods called `{}` usually take {}; consider choosing a less \
1177                                  ambiguous name",
1178                                 conv,
1179                                 &self_kinds
1180                                     .iter()
1181                                     .map(|k| k.description())
1182                                     .collect::<Vec<_>>()
1183                                     .join(" or ")
1184                             ),
1185                         );
1186                     }
1187                 }
1188             }
1189         }
1190
1191         if let hir::ImplItemKind::Method(_, _) = impl_item.node {
1192             let ret_ty = return_ty(cx, impl_item.hir_id);
1193
1194             // walk the return type and check for Self (this does not check associated types)
1195             if ret_ty.walk().any(|inner_type| same_tys(cx, ty, inner_type)) {
1196                 return;
1197             }
1198
1199             // if return type is impl trait, check the associated types
1200             if let ty::Opaque(def_id, _) = ret_ty.sty {
1201                 // one of the associated types must be Self
1202                 for predicate in &cx.tcx.predicates_of(def_id).predicates {
1203                     match predicate {
1204                         (Predicate::Projection(poly_projection_predicate), _) => {
1205                             let binder = poly_projection_predicate.ty();
1206                             let associated_type = binder.skip_binder();
1207
1208                             // walk the associated type and check for Self
1209                             for inner_type in associated_type.walk() {
1210                                 if same_tys(cx, ty, inner_type) {
1211                                     return;
1212                                 }
1213                             }
1214                         },
1215                         (_, _) => {},
1216                     }
1217                 }
1218             }
1219
1220             if name == "new" && !same_tys(cx, ret_ty, ty) {
1221                 span_lint(
1222                     cx,
1223                     NEW_RET_NO_SELF,
1224                     impl_item.span,
1225                     "methods called `new` usually return `Self`",
1226                 );
1227             }
1228         }
1229     }
1230 }
1231
1232 /// Checks for the `OR_FUN_CALL` lint.
1233 #[allow(clippy::too_many_lines)]
1234 fn lint_or_fun_call<'a, 'tcx>(
1235     cx: &LateContext<'a, 'tcx>,
1236     expr: &hir::Expr,
1237     method_span: Span,
1238     name: &str,
1239     args: &'tcx [hir::Expr],
1240 ) {
1241     // Searches an expression for method calls or function calls that aren't ctors
1242     struct FunCallFinder<'a, 'tcx> {
1243         cx: &'a LateContext<'a, 'tcx>,
1244         found: bool,
1245     }
1246
1247     impl<'a, 'tcx> intravisit::Visitor<'tcx> for FunCallFinder<'a, 'tcx> {
1248         fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
1249             let call_found = match &expr.node {
1250                 // ignore enum and struct constructors
1251                 hir::ExprKind::Call(..) => !is_ctor_function(self.cx, expr),
1252                 hir::ExprKind::MethodCall(..) => true,
1253                 _ => false,
1254             };
1255
1256             if call_found {
1257                 // don't lint for constant values
1258                 let owner_def = self.cx.tcx.hir().get_parent_did(expr.hir_id);
1259                 let promotable = self
1260                     .cx
1261                     .tcx
1262                     .rvalue_promotable_map(owner_def)
1263                     .contains(&expr.hir_id.local_id);
1264                 if !promotable {
1265                     self.found |= true;
1266                 }
1267             }
1268
1269             if !self.found {
1270                 intravisit::walk_expr(self, expr);
1271             }
1272         }
1273
1274         fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
1275             intravisit::NestedVisitorMap::None
1276         }
1277     }
1278
1279     /// Checks for `unwrap_or(T::new())` or `unwrap_or(T::default())`.
1280     fn check_unwrap_or_default(
1281         cx: &LateContext<'_, '_>,
1282         name: &str,
1283         fun: &hir::Expr,
1284         self_expr: &hir::Expr,
1285         arg: &hir::Expr,
1286         or_has_args: bool,
1287         span: Span,
1288     ) -> bool {
1289         if_chain! {
1290             if !or_has_args;
1291             if name == "unwrap_or";
1292             if let hir::ExprKind::Path(ref qpath) = fun.node;
1293             let path = &*last_path_segment(qpath).ident.as_str();
1294             if ["default", "new"].contains(&path);
1295             let arg_ty = cx.tables.expr_ty(arg);
1296             if let Some(default_trait_id) = get_trait_def_id(cx, &paths::DEFAULT_TRAIT);
1297             if implements_trait(cx, arg_ty, default_trait_id, &[]);
1298
1299             then {
1300                 let mut applicability = Applicability::MachineApplicable;
1301                 span_lint_and_sugg(
1302                     cx,
1303                     OR_FUN_CALL,
1304                     span,
1305                     &format!("use of `{}` followed by a call to `{}`", name, path),
1306                     "try this",
1307                     format!(
1308                         "{}.unwrap_or_default()",
1309                         snippet_with_applicability(cx, self_expr.span, "_", &mut applicability)
1310                     ),
1311                     applicability,
1312                 );
1313
1314                 true
1315             } else {
1316                 false
1317             }
1318         }
1319     }
1320
1321     /// Checks for `*or(foo())`.
1322     #[allow(clippy::too_many_arguments)]
1323     fn check_general_case<'a, 'tcx>(
1324         cx: &LateContext<'a, 'tcx>,
1325         name: &str,
1326         method_span: Span,
1327         fun_span: Span,
1328         self_expr: &hir::Expr,
1329         arg: &'tcx hir::Expr,
1330         or_has_args: bool,
1331         span: Span,
1332     ) {
1333         // (path, fn_has_argument, methods, suffix)
1334         let know_types: &[(&[_], _, &[_], _)] = &[
1335             (&paths::BTREEMAP_ENTRY, false, &["or_insert"], "with"),
1336             (&paths::HASHMAP_ENTRY, false, &["or_insert"], "with"),
1337             (&paths::OPTION, false, &["map_or", "ok_or", "or", "unwrap_or"], "else"),
1338             (&paths::RESULT, true, &["or", "unwrap_or"], "else"),
1339         ];
1340
1341         if_chain! {
1342             if know_types.iter().any(|k| k.2.contains(&name));
1343
1344             let mut finder = FunCallFinder { cx: &cx, found: false };
1345             if { finder.visit_expr(&arg); finder.found };
1346
1347             let self_ty = cx.tables.expr_ty(self_expr);
1348
1349             if let Some(&(_, fn_has_arguments, poss, suffix)) =
1350                    know_types.iter().find(|&&i| match_type(cx, self_ty, i.0));
1351
1352             if poss.contains(&name);
1353
1354             then {
1355                 let sugg: Cow<'_, _> = match (fn_has_arguments, !or_has_args) {
1356                     (true, _) => format!("|_| {}", snippet_with_macro_callsite(cx, arg.span, "..")).into(),
1357                     (false, false) => format!("|| {}", snippet_with_macro_callsite(cx, arg.span, "..")).into(),
1358                     (false, true) => snippet_with_macro_callsite(cx, fun_span, ".."),
1359                 };
1360                 let span_replace_word = method_span.with_hi(span.hi());
1361                 span_lint_and_sugg(
1362                     cx,
1363                     OR_FUN_CALL,
1364                     span_replace_word,
1365                     &format!("use of `{}` followed by a function call", name),
1366                     "try this",
1367                     format!("{}_{}({})", name, suffix, sugg),
1368                     Applicability::HasPlaceholders,
1369                 );
1370             }
1371         }
1372     }
1373
1374     if args.len() == 2 {
1375         match args[1].node {
1376             hir::ExprKind::Call(ref fun, ref or_args) => {
1377                 let or_has_args = !or_args.is_empty();
1378                 if !check_unwrap_or_default(cx, name, fun, &args[0], &args[1], or_has_args, expr.span) {
1379                     check_general_case(
1380                         cx,
1381                         name,
1382                         method_span,
1383                         fun.span,
1384                         &args[0],
1385                         &args[1],
1386                         or_has_args,
1387                         expr.span,
1388                     );
1389                 }
1390             },
1391             hir::ExprKind::MethodCall(_, span, ref or_args) => check_general_case(
1392                 cx,
1393                 name,
1394                 method_span,
1395                 span,
1396                 &args[0],
1397                 &args[1],
1398                 !or_args.is_empty(),
1399                 expr.span,
1400             ),
1401             _ => {},
1402         }
1403     }
1404 }
1405
1406 /// Checks for the `EXPECT_FUN_CALL` lint.
1407 #[allow(clippy::too_many_lines)]
1408 fn lint_expect_fun_call(cx: &LateContext<'_, '_>, expr: &hir::Expr, method_span: Span, name: &str, args: &[hir::Expr]) {
1409     // Strip `&`, `as_ref()` and `as_str()` off `arg` until we're left with either a `String` or
1410     // `&str`
1411     fn get_arg_root<'a>(cx: &LateContext<'_, '_>, arg: &'a hir::Expr) -> &'a hir::Expr {
1412         let mut arg_root = arg;
1413         loop {
1414             arg_root = match &arg_root.node {
1415                 hir::ExprKind::AddrOf(_, expr) => expr,
1416                 hir::ExprKind::MethodCall(method_name, _, call_args) => {
1417                     if call_args.len() == 1
1418                         && (method_name.ident.name == sym!(as_str) || method_name.ident.name == sym!(as_ref))
1419                         && {
1420                             let arg_type = cx.tables.expr_ty(&call_args[0]);
1421                             let base_type = walk_ptrs_ty(arg_type);
1422                             base_type.sty == ty::Str || match_type(cx, base_type, &paths::STRING)
1423                         }
1424                     {
1425                         &call_args[0]
1426                     } else {
1427                         break;
1428                     }
1429                 },
1430                 _ => break,
1431             };
1432         }
1433         arg_root
1434     }
1435
1436     // Only `&'static str` or `String` can be used directly in the `panic!`. Other types should be
1437     // converted to string.
1438     fn requires_to_string(cx: &LateContext<'_, '_>, arg: &hir::Expr) -> bool {
1439         let arg_ty = cx.tables.expr_ty(arg);
1440         if match_type(cx, arg_ty, &paths::STRING) {
1441             return false;
1442         }
1443         if let ty::Ref(ty::ReStatic, ty, ..) = arg_ty.sty {
1444             if ty.sty == ty::Str {
1445                 return false;
1446             }
1447         };
1448         true
1449     }
1450
1451     fn generate_format_arg_snippet(
1452         cx: &LateContext<'_, '_>,
1453         a: &hir::Expr,
1454         applicability: &mut Applicability,
1455     ) -> Vec<String> {
1456         if_chain! {
1457             if let hir::ExprKind::AddrOf(_, ref format_arg) = a.node;
1458             if let hir::ExprKind::Match(ref format_arg_expr, _, _) = format_arg.node;
1459             if let hir::ExprKind::Tup(ref format_arg_expr_tup) = format_arg_expr.node;
1460
1461             then {
1462                 format_arg_expr_tup
1463                     .iter()
1464                     .map(|a| snippet_with_applicability(cx, a.span, "..", applicability).into_owned())
1465                     .collect()
1466             } else {
1467                 unreachable!()
1468             }
1469         }
1470     }
1471
1472     fn is_call(node: &hir::ExprKind) -> bool {
1473         match node {
1474             hir::ExprKind::AddrOf(_, expr) => {
1475                 is_call(&expr.node)
1476             },
1477             hir::ExprKind::Call(..)
1478             | hir::ExprKind::MethodCall(..)
1479             // These variants are debatable or require further examination
1480             | hir::ExprKind::Match(..)
1481             | hir::ExprKind::Block{ .. } => true,
1482             _ => false,
1483         }
1484     }
1485
1486     if args.len() != 2 || name != "expect" || !is_call(&args[1].node) {
1487         return;
1488     }
1489
1490     let receiver_type = cx.tables.expr_ty(&args[0]);
1491     let closure_args = if match_type(cx, receiver_type, &paths::OPTION) {
1492         "||"
1493     } else if match_type(cx, receiver_type, &paths::RESULT) {
1494         "|_|"
1495     } else {
1496         return;
1497     };
1498
1499     let arg_root = get_arg_root(cx, &args[1]);
1500
1501     let span_replace_word = method_span.with_hi(expr.span.hi());
1502
1503     let mut applicability = Applicability::MachineApplicable;
1504
1505     //Special handling for `format!` as arg_root
1506     if let hir::ExprKind::Call(ref inner_fun, ref inner_args) = arg_root.node {
1507         if is_expn_of(inner_fun.span, "format").is_some() && inner_args.len() == 1 {
1508             if let hir::ExprKind::Call(_, format_args) = &inner_args[0].node {
1509                 let fmt_spec = &format_args[0];
1510                 let fmt_args = &format_args[1];
1511
1512                 let mut args = vec![snippet(cx, fmt_spec.span, "..").into_owned()];
1513
1514                 args.extend(generate_format_arg_snippet(cx, fmt_args, &mut applicability));
1515
1516                 let sugg = args.join(", ");
1517
1518                 span_lint_and_sugg(
1519                     cx,
1520                     EXPECT_FUN_CALL,
1521                     span_replace_word,
1522                     &format!("use of `{}` followed by a function call", name),
1523                     "try this",
1524                     format!("unwrap_or_else({} panic!({}))", closure_args, sugg),
1525                     applicability,
1526                 );
1527
1528                 return;
1529             }
1530         }
1531     }
1532
1533     let mut arg_root_snippet: Cow<'_, _> = snippet_with_applicability(cx, arg_root.span, "..", &mut applicability);
1534     if requires_to_string(cx, arg_root) {
1535         arg_root_snippet.to_mut().push_str(".to_string()");
1536     }
1537
1538     span_lint_and_sugg(
1539         cx,
1540         EXPECT_FUN_CALL,
1541         span_replace_word,
1542         &format!("use of `{}` followed by a function call", name),
1543         "try this",
1544         format!("unwrap_or_else({} {{ panic!({}) }})", closure_args, arg_root_snippet),
1545         applicability,
1546     );
1547 }
1548
1549 /// Checks for the `CLONE_ON_COPY` lint.
1550 fn lint_clone_on_copy(cx: &LateContext<'_, '_>, expr: &hir::Expr, arg: &hir::Expr, arg_ty: Ty<'_>) {
1551     let ty = cx.tables.expr_ty(expr);
1552     if let ty::Ref(_, inner, _) = arg_ty.sty {
1553         if let ty::Ref(_, innermost, _) = inner.sty {
1554             span_lint_and_then(
1555                 cx,
1556                 CLONE_DOUBLE_REF,
1557                 expr.span,
1558                 "using `clone` on a double-reference; \
1559                  this will copy the reference instead of cloning the inner type",
1560                 |db| {
1561                     if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
1562                         let mut ty = innermost;
1563                         let mut n = 0;
1564                         while let ty::Ref(_, inner, _) = ty.sty {
1565                             ty = inner;
1566                             n += 1;
1567                         }
1568                         let refs: String = iter::repeat('&').take(n + 1).collect();
1569                         let derefs: String = iter::repeat('*').take(n).collect();
1570                         let explicit = format!("{}{}::clone({})", refs, ty, snip);
1571                         db.span_suggestion(
1572                             expr.span,
1573                             "try dereferencing it",
1574                             format!("{}({}{}).clone()", refs, derefs, snip.deref()),
1575                             Applicability::MaybeIncorrect,
1576                         );
1577                         db.span_suggestion(
1578                             expr.span,
1579                             "or try being explicit about what type to clone",
1580                             explicit,
1581                             Applicability::MaybeIncorrect,
1582                         );
1583                     }
1584                 },
1585             );
1586             return; // don't report clone_on_copy
1587         }
1588     }
1589
1590     if is_copy(cx, ty) {
1591         let snip;
1592         if let Some(snippet) = sugg::Sugg::hir_opt(cx, arg) {
1593             let parent = cx.tcx.hir().get_parent_node(expr.hir_id);
1594             match &cx.tcx.hir().get(parent) {
1595                 hir::Node::Expr(parent) => match parent.node {
1596                     // &*x is a nop, &x.clone() is not
1597                     hir::ExprKind::AddrOf(..) |
1598                     // (*x).func() is useless, x.clone().func() can work in case func borrows mutably
1599                     hir::ExprKind::MethodCall(..) => return,
1600                     _ => {},
1601                 },
1602                 hir::Node::Stmt(stmt) => {
1603                     if let hir::StmtKind::Local(ref loc) = stmt.node {
1604                         if let hir::PatKind::Ref(..) = loc.pat.node {
1605                             // let ref y = *x borrows x, let ref y = x.clone() does not
1606                             return;
1607                         }
1608                     }
1609                 },
1610                 _ => {},
1611             }
1612
1613             // x.clone() might have dereferenced x, possibly through Deref impls
1614             if cx.tables.expr_ty(arg) == ty {
1615                 snip = Some(("try removing the `clone` call", format!("{}", snippet)));
1616             } else {
1617                 let deref_count = cx
1618                     .tables
1619                     .expr_adjustments(arg)
1620                     .iter()
1621                     .filter(|adj| {
1622                         if let ty::adjustment::Adjust::Deref(_) = adj.kind {
1623                             true
1624                         } else {
1625                             false
1626                         }
1627                     })
1628                     .count();
1629                 let derefs: String = iter::repeat('*').take(deref_count).collect();
1630                 snip = Some(("try dereferencing it", format!("{}{}", derefs, snippet)));
1631             }
1632         } else {
1633             snip = None;
1634         }
1635         span_lint_and_then(cx, CLONE_ON_COPY, expr.span, "using `clone` on a `Copy` type", |db| {
1636             if let Some((text, snip)) = snip {
1637                 db.span_suggestion(expr.span, text, snip, Applicability::Unspecified);
1638             }
1639         });
1640     }
1641 }
1642
1643 fn lint_clone_on_ref_ptr(cx: &LateContext<'_, '_>, expr: &hir::Expr, arg: &hir::Expr) {
1644     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(arg));
1645
1646     if let ty::Adt(_, subst) = obj_ty.sty {
1647         let caller_type = if match_type(cx, obj_ty, &paths::RC) {
1648             "Rc"
1649         } else if match_type(cx, obj_ty, &paths::ARC) {
1650             "Arc"
1651         } else if match_type(cx, obj_ty, &paths::WEAK_RC) || match_type(cx, obj_ty, &paths::WEAK_ARC) {
1652             "Weak"
1653         } else {
1654             return;
1655         };
1656
1657         span_lint_and_sugg(
1658             cx,
1659             CLONE_ON_REF_PTR,
1660             expr.span,
1661             "using '.clone()' on a ref-counted pointer",
1662             "try this",
1663             format!(
1664                 "{}::<{}>::clone(&{})",
1665                 caller_type,
1666                 subst.type_at(0),
1667                 snippet(cx, arg.span, "_")
1668             ),
1669             Applicability::Unspecified, // Sometimes unnecessary ::<_> after Rc/Arc/Weak
1670         );
1671     }
1672 }
1673
1674 fn lint_string_extend(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
1675     let arg = &args[1];
1676     if let Some(arglists) = method_chain_args(arg, &["chars"]) {
1677         let target = &arglists[0][0];
1678         let self_ty = walk_ptrs_ty(cx.tables.expr_ty(target));
1679         let ref_str = if self_ty.sty == ty::Str {
1680             ""
1681         } else if match_type(cx, self_ty, &paths::STRING) {
1682             "&"
1683         } else {
1684             return;
1685         };
1686
1687         let mut applicability = Applicability::MachineApplicable;
1688         span_lint_and_sugg(
1689             cx,
1690             STRING_EXTEND_CHARS,
1691             expr.span,
1692             "calling `.extend(_.chars())`",
1693             "try this",
1694             format!(
1695                 "{}.push_str({}{})",
1696                 snippet_with_applicability(cx, args[0].span, "_", &mut applicability),
1697                 ref_str,
1698                 snippet_with_applicability(cx, target.span, "_", &mut applicability)
1699             ),
1700             applicability,
1701         );
1702     }
1703 }
1704
1705 fn lint_extend(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
1706     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(&args[0]));
1707     if match_type(cx, obj_ty, &paths::STRING) {
1708         lint_string_extend(cx, expr, args);
1709     }
1710 }
1711
1712 fn lint_cstring_as_ptr(cx: &LateContext<'_, '_>, expr: &hir::Expr, source: &hir::Expr, unwrap: &hir::Expr) {
1713     if_chain! {
1714         let source_type = cx.tables.expr_ty(source);
1715         if let ty::Adt(def, substs) = source_type.sty;
1716         if match_def_path(cx, def.did, &paths::RESULT);
1717         if match_type(cx, substs.type_at(0), &paths::CSTRING);
1718         then {
1719             span_lint_and_then(
1720                 cx,
1721                 TEMPORARY_CSTRING_AS_PTR,
1722                 expr.span,
1723                 "you are getting the inner pointer of a temporary `CString`",
1724                 |db| {
1725                     db.note("that pointer will be invalid outside this expression");
1726                     db.span_help(unwrap.span, "assign the `CString` to a variable to extend its lifetime");
1727                 });
1728         }
1729     }
1730 }
1731
1732 fn lint_iter_cloned_collect<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, iter_args: &'tcx [hir::Expr]) {
1733     if_chain! {
1734         if match_type(cx, cx.tables.expr_ty(expr), &paths::VEC);
1735         if let Some(slice) = derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0]));
1736         if let Some(to_replace) = expr.span.trim_start(slice.span.source_callsite());
1737
1738         then {
1739             span_lint_and_sugg(
1740                 cx,
1741                 ITER_CLONED_COLLECT,
1742                 to_replace,
1743                 "called `iter().cloned().collect()` on a slice to create a `Vec`. Calling `to_vec()` is both faster and \
1744                  more readable",
1745                 "try",
1746                 ".to_vec()".to_string(),
1747                 Applicability::MachineApplicable,
1748             );
1749         }
1750     }
1751 }
1752
1753 fn lint_unnecessary_fold(cx: &LateContext<'_, '_>, expr: &hir::Expr, fold_args: &[hir::Expr], fold_span: Span) {
1754     fn check_fold_with_op(
1755         cx: &LateContext<'_, '_>,
1756         expr: &hir::Expr,
1757         fold_args: &[hir::Expr],
1758         fold_span: Span,
1759         op: hir::BinOpKind,
1760         replacement_method_name: &str,
1761         replacement_has_args: bool,
1762     ) {
1763         if_chain! {
1764             // Extract the body of the closure passed to fold
1765             if let hir::ExprKind::Closure(_, _, body_id, _, _) = fold_args[2].node;
1766             let closure_body = cx.tcx.hir().body(body_id);
1767             let closure_expr = remove_blocks(&closure_body.value);
1768
1769             // Check if the closure body is of the form `acc <op> some_expr(x)`
1770             if let hir::ExprKind::Binary(ref bin_op, ref left_expr, ref right_expr) = closure_expr.node;
1771             if bin_op.node == op;
1772
1773             // Extract the names of the two arguments to the closure
1774             if let Some(first_arg_ident) = get_arg_name(&closure_body.params[0].pat);
1775             if let Some(second_arg_ident) = get_arg_name(&closure_body.params[1].pat);
1776
1777             if match_var(&*left_expr, first_arg_ident);
1778             if replacement_has_args || match_var(&*right_expr, second_arg_ident);
1779
1780             then {
1781                 let mut applicability = Applicability::MachineApplicable;
1782                 let sugg = if replacement_has_args {
1783                     format!(
1784                         "{replacement}(|{s}| {r})",
1785                         replacement = replacement_method_name,
1786                         s = second_arg_ident,
1787                         r = snippet_with_applicability(cx, right_expr.span, "EXPR", &mut applicability),
1788                     )
1789                 } else {
1790                     format!(
1791                         "{replacement}()",
1792                         replacement = replacement_method_name,
1793                     )
1794                 };
1795
1796                 span_lint_and_sugg(
1797                     cx,
1798                     UNNECESSARY_FOLD,
1799                     fold_span.with_hi(expr.span.hi()),
1800                     // TODO #2371 don't suggest e.g., .any(|x| f(x)) if we can suggest .any(f)
1801                     "this `.fold` can be written more succinctly using another method",
1802                     "try",
1803                     sugg,
1804                     applicability,
1805                 );
1806             }
1807         }
1808     }
1809
1810     // Check that this is a call to Iterator::fold rather than just some function called fold
1811     if !match_trait_method(cx, expr, &paths::ITERATOR) {
1812         return;
1813     }
1814
1815     assert!(
1816         fold_args.len() == 3,
1817         "Expected fold_args to have three entries - the receiver, the initial value and the closure"
1818     );
1819
1820     // Check if the first argument to .fold is a suitable literal
1821     if let hir::ExprKind::Lit(ref lit) = fold_args[1].node {
1822         match lit.node {
1823             ast::LitKind::Bool(false) => {
1824                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::Or, "any", true)
1825             },
1826             ast::LitKind::Bool(true) => {
1827                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::And, "all", true)
1828             },
1829             ast::LitKind::Int(0, _) => {
1830                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::Add, "sum", false)
1831             },
1832             ast::LitKind::Int(1, _) => {
1833                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::Mul, "product", false)
1834             },
1835             _ => (),
1836         }
1837     }
1838 }
1839
1840 fn lint_iter_nth<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, iter_args: &'tcx [hir::Expr], is_mut: bool) {
1841     let mut_str = if is_mut { "_mut" } else { "" };
1842     let caller_type = if derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0])).is_some() {
1843         "slice"
1844     } else if match_type(cx, cx.tables.expr_ty(&iter_args[0]), &paths::VEC) {
1845         "Vec"
1846     } else if match_type(cx, cx.tables.expr_ty(&iter_args[0]), &paths::VEC_DEQUE) {
1847         "VecDeque"
1848     } else {
1849         return; // caller is not a type that we want to lint
1850     };
1851
1852     span_lint(
1853         cx,
1854         ITER_NTH,
1855         expr.span,
1856         &format!(
1857             "called `.iter{0}().nth()` on a {1}. Calling `.get{0}()` is both faster and more readable",
1858             mut_str, caller_type
1859         ),
1860     );
1861 }
1862
1863 fn lint_get_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, get_args: &'tcx [hir::Expr], is_mut: bool) {
1864     // Note: we don't want to lint `get_mut().unwrap` for HashMap or BTreeMap,
1865     // because they do not implement `IndexMut`
1866     let mut applicability = Applicability::MachineApplicable;
1867     let expr_ty = cx.tables.expr_ty(&get_args[0]);
1868     let get_args_str = if get_args.len() > 1 {
1869         snippet_with_applicability(cx, get_args[1].span, "_", &mut applicability)
1870     } else {
1871         return; // not linting on a .get().unwrap() chain or variant
1872     };
1873     let mut needs_ref;
1874     let caller_type = if derefs_to_slice(cx, &get_args[0], expr_ty).is_some() {
1875         needs_ref = get_args_str.parse::<usize>().is_ok();
1876         "slice"
1877     } else if match_type(cx, expr_ty, &paths::VEC) {
1878         needs_ref = get_args_str.parse::<usize>().is_ok();
1879         "Vec"
1880     } else if match_type(cx, expr_ty, &paths::VEC_DEQUE) {
1881         needs_ref = get_args_str.parse::<usize>().is_ok();
1882         "VecDeque"
1883     } else if !is_mut && match_type(cx, expr_ty, &paths::HASHMAP) {
1884         needs_ref = true;
1885         "HashMap"
1886     } else if !is_mut && match_type(cx, expr_ty, &paths::BTREEMAP) {
1887         needs_ref = true;
1888         "BTreeMap"
1889     } else {
1890         return; // caller is not a type that we want to lint
1891     };
1892
1893     let mut span = expr.span;
1894
1895     // Handle the case where the result is immediately dereferenced
1896     // by not requiring ref and pulling the dereference into the
1897     // suggestion.
1898     if_chain! {
1899         if needs_ref;
1900         if let Some(parent) = get_parent_expr(cx, expr);
1901         if let hir::ExprKind::Unary(hir::UnOp::UnDeref, _) = parent.node;
1902         then {
1903             needs_ref = false;
1904             span = parent.span;
1905         }
1906     }
1907
1908     let mut_str = if is_mut { "_mut" } else { "" };
1909     let borrow_str = if !needs_ref {
1910         ""
1911     } else if is_mut {
1912         "&mut "
1913     } else {
1914         "&"
1915     };
1916
1917     span_lint_and_sugg(
1918         cx,
1919         GET_UNWRAP,
1920         span,
1921         &format!(
1922             "called `.get{0}().unwrap()` on a {1}. Using `[]` is more clear and more concise",
1923             mut_str, caller_type
1924         ),
1925         "try this",
1926         format!(
1927             "{}{}[{}]",
1928             borrow_str,
1929             snippet_with_applicability(cx, get_args[0].span, "_", &mut applicability),
1930             get_args_str
1931         ),
1932         applicability,
1933     );
1934 }
1935
1936 fn lint_iter_skip_next(cx: &LateContext<'_, '_>, expr: &hir::Expr) {
1937     // lint if caller of skip is an Iterator
1938     if match_trait_method(cx, expr, &paths::ITERATOR) {
1939         span_lint(
1940             cx,
1941             ITER_SKIP_NEXT,
1942             expr.span,
1943             "called `skip(x).next()` on an iterator. This is more succinctly expressed by calling `nth(x)`",
1944         );
1945     }
1946 }
1947
1948 fn derefs_to_slice<'a, 'tcx>(
1949     cx: &LateContext<'a, 'tcx>,
1950     expr: &'tcx hir::Expr,
1951     ty: Ty<'tcx>,
1952 ) -> Option<&'tcx hir::Expr> {
1953     fn may_slice<'a>(cx: &LateContext<'_, 'a>, ty: Ty<'a>) -> bool {
1954         match ty.sty {
1955             ty::Slice(_) => true,
1956             ty::Adt(def, _) if def.is_box() => may_slice(cx, ty.boxed_ty()),
1957             ty::Adt(..) => match_type(cx, ty, &paths::VEC),
1958             ty::Array(_, size) => size.eval_usize(cx.tcx, cx.param_env) < 32,
1959             ty::Ref(_, inner, _) => may_slice(cx, inner),
1960             _ => false,
1961         }
1962     }
1963
1964     if let hir::ExprKind::MethodCall(ref path, _, ref args) = expr.node {
1965         if path.ident.name == sym!(iter) && may_slice(cx, cx.tables.expr_ty(&args[0])) {
1966             Some(&args[0])
1967         } else {
1968             None
1969         }
1970     } else {
1971         match ty.sty {
1972             ty::Slice(_) => Some(expr),
1973             ty::Adt(def, _) if def.is_box() && may_slice(cx, ty.boxed_ty()) => Some(expr),
1974             ty::Ref(_, inner, _) => {
1975                 if may_slice(cx, inner) {
1976                     Some(expr)
1977                 } else {
1978                     None
1979                 }
1980             },
1981             _ => None,
1982         }
1983     }
1984 }
1985
1986 /// lint use of `unwrap()` for `Option`s and `Result`s
1987 fn lint_unwrap(cx: &LateContext<'_, '_>, expr: &hir::Expr, unwrap_args: &[hir::Expr]) {
1988     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(&unwrap_args[0]));
1989
1990     let mess = if match_type(cx, obj_ty, &paths::OPTION) {
1991         Some((OPTION_UNWRAP_USED, "an Option", "None"))
1992     } else if match_type(cx, obj_ty, &paths::RESULT) {
1993         Some((RESULT_UNWRAP_USED, "a Result", "Err"))
1994     } else {
1995         None
1996     };
1997
1998     if let Some((lint, kind, none_value)) = mess {
1999         span_lint(
2000             cx,
2001             lint,
2002             expr.span,
2003             &format!(
2004                 "used unwrap() on {} value. If you don't want to handle the {} case gracefully, consider \
2005                  using expect() to provide a better panic \
2006                  message",
2007                 kind, none_value
2008             ),
2009         );
2010     }
2011 }
2012
2013 /// lint use of `ok().expect()` for `Result`s
2014 fn lint_ok_expect(cx: &LateContext<'_, '_>, expr: &hir::Expr, ok_args: &[hir::Expr]) {
2015     if_chain! {
2016         // lint if the caller of `ok()` is a `Result`
2017         if match_type(cx, cx.tables.expr_ty(&ok_args[0]), &paths::RESULT);
2018         let result_type = cx.tables.expr_ty(&ok_args[0]);
2019         if let Some(error_type) = get_error_type(cx, result_type);
2020         if has_debug_impl(error_type, cx);
2021
2022         then {
2023             span_lint(
2024                 cx,
2025                 OK_EXPECT,
2026                 expr.span,
2027                 "called `ok().expect()` on a Result value. You can call `expect` directly on the `Result`",
2028             );
2029         }
2030     }
2031 }
2032
2033 /// lint use of `map().flatten()` for `Iterators`
2034 fn lint_map_flatten<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, map_args: &'tcx [hir::Expr]) {
2035     // lint if caller of `.map().flatten()` is an Iterator
2036     if match_trait_method(cx, expr, &paths::ITERATOR) {
2037         let msg = "called `map(..).flatten()` on an `Iterator`. \
2038                    This is more succinctly expressed by calling `.flat_map(..)`";
2039         let self_snippet = snippet(cx, map_args[0].span, "..");
2040         let func_snippet = snippet(cx, map_args[1].span, "..");
2041         let hint = format!("{0}.flat_map({1})", self_snippet, func_snippet);
2042         span_lint_and_then(cx, MAP_FLATTEN, expr.span, msg, |db| {
2043             db.span_suggestion(
2044                 expr.span,
2045                 "try using flat_map instead",
2046                 hint,
2047                 Applicability::MachineApplicable,
2048             );
2049         });
2050     }
2051 }
2052
2053 /// lint use of `map().unwrap_or_else()` for `Option`s and `Result`s
2054 fn lint_map_unwrap_or_else<'a, 'tcx>(
2055     cx: &LateContext<'a, 'tcx>,
2056     expr: &'tcx hir::Expr,
2057     map_args: &'tcx [hir::Expr],
2058     unwrap_args: &'tcx [hir::Expr],
2059 ) {
2060     // lint if the caller of `map()` is an `Option`
2061     let is_option = match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::OPTION);
2062     let is_result = match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::RESULT);
2063
2064     if is_option || is_result {
2065         // Don't make a suggestion that may fail to compile due to mutably borrowing
2066         // the same variable twice.
2067         let map_mutated_vars = mutated_variables(&map_args[0], cx);
2068         let unwrap_mutated_vars = mutated_variables(&unwrap_args[1], cx);
2069         if let (Some(map_mutated_vars), Some(unwrap_mutated_vars)) = (map_mutated_vars, unwrap_mutated_vars) {
2070             if map_mutated_vars.intersection(&unwrap_mutated_vars).next().is_some() {
2071                 return;
2072             }
2073         } else {
2074             return;
2075         }
2076
2077         // lint message
2078         let msg = if is_option {
2079             "called `map(f).unwrap_or_else(g)` on an Option value. This can be done more directly by calling \
2080              `map_or_else(g, f)` instead"
2081         } else {
2082             "called `map(f).unwrap_or_else(g)` on a Result value. This can be done more directly by calling \
2083              `ok().map_or_else(g, f)` instead"
2084         };
2085         // get snippets for args to map() and unwrap_or_else()
2086         let map_snippet = snippet(cx, map_args[1].span, "..");
2087         let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
2088         // lint, with note if neither arg is > 1 line and both map() and
2089         // unwrap_or_else() have the same span
2090         let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
2091         let same_span = map_args[1].span.ctxt() == unwrap_args[1].span.ctxt();
2092         if same_span && !multiline {
2093             span_note_and_lint(
2094                 cx,
2095                 if is_option {
2096                     OPTION_MAP_UNWRAP_OR_ELSE
2097                 } else {
2098                     RESULT_MAP_UNWRAP_OR_ELSE
2099                 },
2100                 expr.span,
2101                 msg,
2102                 expr.span,
2103                 &format!(
2104                     "replace `map({0}).unwrap_or_else({1})` with `{2}map_or_else({1}, {0})`",
2105                     map_snippet,
2106                     unwrap_snippet,
2107                     if is_result { "ok()." } else { "" }
2108                 ),
2109             );
2110         } else if same_span && multiline {
2111             span_lint(
2112                 cx,
2113                 if is_option {
2114                     OPTION_MAP_UNWRAP_OR_ELSE
2115                 } else {
2116                     RESULT_MAP_UNWRAP_OR_ELSE
2117                 },
2118                 expr.span,
2119                 msg,
2120             );
2121         };
2122     }
2123 }
2124
2125 /// lint use of `_.map_or(None, _)` for `Option`s
2126 fn lint_map_or_none<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, map_or_args: &'tcx [hir::Expr]) {
2127     if match_type(cx, cx.tables.expr_ty(&map_or_args[0]), &paths::OPTION) {
2128         // check if the first non-self argument to map_or() is None
2129         let map_or_arg_is_none = if let hir::ExprKind::Path(ref qpath) = map_or_args[1].node {
2130             match_qpath(qpath, &paths::OPTION_NONE)
2131         } else {
2132             false
2133         };
2134
2135         if map_or_arg_is_none {
2136             // lint message
2137             let msg = "called `map_or(None, f)` on an Option value. This can be done more directly by calling \
2138                        `and_then(f)` instead";
2139             let map_or_self_snippet = snippet(cx, map_or_args[0].span, "..");
2140             let map_or_func_snippet = snippet(cx, map_or_args[2].span, "..");
2141             let hint = format!("{0}.and_then({1})", map_or_self_snippet, map_or_func_snippet);
2142             span_lint_and_then(cx, OPTION_MAP_OR_NONE, expr.span, msg, |db| {
2143                 db.span_suggestion(
2144                     expr.span,
2145                     "try using and_then instead",
2146                     hint,
2147                     Applicability::MachineApplicable, // snippet
2148                 );
2149             });
2150         }
2151     }
2152 }
2153
2154 /// Lint use of `_.and_then(|x| Some(y))` for `Option`s
2155 fn lint_option_and_then_some(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
2156     const LINT_MSG: &str = "using `Option.and_then(|x| Some(y))`, which is more succinctly expressed as `map(|x| y)`";
2157     const NO_OP_MSG: &str = "using `Option.and_then(Some)`, which is a no-op";
2158
2159     // Searches an return expressions in `y` in `_.and_then(|x| Some(y))`, which we don't lint
2160     struct RetCallFinder {
2161         found: bool,
2162     }
2163
2164     impl<'tcx> intravisit::Visitor<'tcx> for RetCallFinder {
2165         fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
2166             if self.found {
2167                 return;
2168             }
2169             if let hir::ExprKind::Ret(..) = &expr.node {
2170                 self.found = true;
2171             } else {
2172                 intravisit::walk_expr(self, expr);
2173             }
2174         }
2175
2176         fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
2177             intravisit::NestedVisitorMap::None
2178         }
2179     }
2180
2181     let ty = cx.tables.expr_ty(&args[0]);
2182     if !match_type(cx, ty, &paths::OPTION) {
2183         return;
2184     }
2185
2186     match args[1].node {
2187         hir::ExprKind::Closure(_, _, body_id, closure_args_span, _) => {
2188             let closure_body = cx.tcx.hir().body(body_id);
2189             let closure_expr = remove_blocks(&closure_body.value);
2190             if_chain! {
2191                 if let hir::ExprKind::Call(ref some_expr, ref some_args) = closure_expr.node;
2192                 if let hir::ExprKind::Path(ref qpath) = some_expr.node;
2193                 if match_qpath(qpath, &paths::OPTION_SOME);
2194                 if some_args.len() == 1;
2195                 then {
2196                     let inner_expr = &some_args[0];
2197
2198                     let mut finder = RetCallFinder { found: false };
2199                     finder.visit_expr(inner_expr);
2200                     if finder.found {
2201                         return;
2202                     }
2203
2204                     let some_inner_snip = if inner_expr.span.from_expansion() {
2205                         snippet_with_macro_callsite(cx, inner_expr.span, "_")
2206                     } else {
2207                         snippet(cx, inner_expr.span, "_")
2208                     };
2209
2210                     let closure_args_snip = snippet(cx, closure_args_span, "..");
2211                     let option_snip = snippet(cx, args[0].span, "..");
2212                     let note = format!("{}.map({} {})", option_snip, closure_args_snip, some_inner_snip);
2213                     span_lint_and_sugg(
2214                         cx,
2215                         OPTION_AND_THEN_SOME,
2216                         expr.span,
2217                         LINT_MSG,
2218                         "try this",
2219                         note,
2220                         Applicability::MachineApplicable,
2221                     );
2222                 }
2223             }
2224         },
2225         // `_.and_then(Some)` case, which is no-op.
2226         hir::ExprKind::Path(ref qpath) => {
2227             if match_qpath(qpath, &paths::OPTION_SOME) {
2228                 let option_snip = snippet(cx, args[0].span, "..");
2229                 let note = format!("{}", option_snip);
2230                 span_lint_and_sugg(
2231                     cx,
2232                     OPTION_AND_THEN_SOME,
2233                     expr.span,
2234                     NO_OP_MSG,
2235                     "use the expression directly",
2236                     note,
2237                     Applicability::MachineApplicable,
2238                 );
2239             }
2240         },
2241         _ => {},
2242     }
2243 }
2244
2245 /// lint use of `filter().next()` for `Iterators`
2246 fn lint_filter_next<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, filter_args: &'tcx [hir::Expr]) {
2247     // lint if caller of `.filter().next()` is an Iterator
2248     if match_trait_method(cx, expr, &paths::ITERATOR) {
2249         let msg = "called `filter(p).next()` on an `Iterator`. This is more succinctly expressed by calling \
2250                    `.find(p)` instead.";
2251         let filter_snippet = snippet(cx, filter_args[1].span, "..");
2252         if filter_snippet.lines().count() <= 1 {
2253             // add note if not multi-line
2254             span_note_and_lint(
2255                 cx,
2256                 FILTER_NEXT,
2257                 expr.span,
2258                 msg,
2259                 expr.span,
2260                 &format!("replace `filter({0}).next()` with `find({0})`", filter_snippet),
2261             );
2262         } else {
2263             span_lint(cx, FILTER_NEXT, expr.span, msg);
2264         }
2265     }
2266 }
2267
2268 /// lint use of `filter().map()` for `Iterators`
2269 fn lint_filter_map<'a, 'tcx>(
2270     cx: &LateContext<'a, 'tcx>,
2271     expr: &'tcx hir::Expr,
2272     _filter_args: &'tcx [hir::Expr],
2273     _map_args: &'tcx [hir::Expr],
2274 ) {
2275     // lint if caller of `.filter().map()` is an Iterator
2276     if match_trait_method(cx, expr, &paths::ITERATOR) {
2277         let msg = "called `filter(p).map(q)` on an `Iterator`. \
2278                    This is more succinctly expressed by calling `.filter_map(..)` instead.";
2279         span_lint(cx, FILTER_MAP, expr.span, msg);
2280     }
2281 }
2282
2283 /// lint use of `filter_map().next()` for `Iterators`
2284 fn lint_filter_map_next<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, filter_args: &'tcx [hir::Expr]) {
2285     if match_trait_method(cx, expr, &paths::ITERATOR) {
2286         let msg = "called `filter_map(p).next()` on an `Iterator`. This is more succinctly expressed by calling \
2287                    `.find_map(p)` instead.";
2288         let filter_snippet = snippet(cx, filter_args[1].span, "..");
2289         if filter_snippet.lines().count() <= 1 {
2290             span_note_and_lint(
2291                 cx,
2292                 FILTER_MAP_NEXT,
2293                 expr.span,
2294                 msg,
2295                 expr.span,
2296                 &format!("replace `filter_map({0}).next()` with `find_map({0})`", filter_snippet),
2297             );
2298         } else {
2299             span_lint(cx, FILTER_MAP_NEXT, expr.span, msg);
2300         }
2301     }
2302 }
2303
2304 /// lint use of `find().map()` for `Iterators`
2305 fn lint_find_map<'a, 'tcx>(
2306     cx: &LateContext<'a, 'tcx>,
2307     expr: &'tcx hir::Expr,
2308     _find_args: &'tcx [hir::Expr],
2309     map_args: &'tcx [hir::Expr],
2310 ) {
2311     // lint if caller of `.filter().map()` is an Iterator
2312     if match_trait_method(cx, &map_args[0], &paths::ITERATOR) {
2313         let msg = "called `find(p).map(q)` on an `Iterator`. \
2314                    This is more succinctly expressed by calling `.find_map(..)` instead.";
2315         span_lint(cx, FIND_MAP, expr.span, msg);
2316     }
2317 }
2318
2319 /// lint use of `filter().map()` for `Iterators`
2320 fn lint_filter_map_map<'a, 'tcx>(
2321     cx: &LateContext<'a, 'tcx>,
2322     expr: &'tcx hir::Expr,
2323     _filter_args: &'tcx [hir::Expr],
2324     _map_args: &'tcx [hir::Expr],
2325 ) {
2326     // lint if caller of `.filter().map()` is an Iterator
2327     if match_trait_method(cx, expr, &paths::ITERATOR) {
2328         let msg = "called `filter_map(p).map(q)` on an `Iterator`. \
2329                    This is more succinctly expressed by only calling `.filter_map(..)` instead.";
2330         span_lint(cx, FILTER_MAP, expr.span, msg);
2331     }
2332 }
2333
2334 /// lint use of `filter().flat_map()` for `Iterators`
2335 fn lint_filter_flat_map<'a, 'tcx>(
2336     cx: &LateContext<'a, 'tcx>,
2337     expr: &'tcx hir::Expr,
2338     _filter_args: &'tcx [hir::Expr],
2339     _map_args: &'tcx [hir::Expr],
2340 ) {
2341     // lint if caller of `.filter().flat_map()` is an Iterator
2342     if match_trait_method(cx, expr, &paths::ITERATOR) {
2343         let msg = "called `filter(p).flat_map(q)` on an `Iterator`. \
2344                    This is more succinctly expressed by calling `.flat_map(..)` \
2345                    and filtering by returning an empty Iterator.";
2346         span_lint(cx, FILTER_MAP, expr.span, msg);
2347     }
2348 }
2349
2350 /// lint use of `filter_map().flat_map()` for `Iterators`
2351 fn lint_filter_map_flat_map<'a, 'tcx>(
2352     cx: &LateContext<'a, 'tcx>,
2353     expr: &'tcx hir::Expr,
2354     _filter_args: &'tcx [hir::Expr],
2355     _map_args: &'tcx [hir::Expr],
2356 ) {
2357     // lint if caller of `.filter_map().flat_map()` is an Iterator
2358     if match_trait_method(cx, expr, &paths::ITERATOR) {
2359         let msg = "called `filter_map(p).flat_map(q)` on an `Iterator`. \
2360                    This is more succinctly expressed by calling `.flat_map(..)` \
2361                    and filtering by returning an empty Iterator.";
2362         span_lint(cx, FILTER_MAP, expr.span, msg);
2363     }
2364 }
2365
2366 /// lint use of `flat_map` for `Iterators` where `flatten` would be sufficient
2367 fn lint_flat_map_identity<'a, 'tcx>(
2368     cx: &LateContext<'a, 'tcx>,
2369     expr: &'tcx hir::Expr,
2370     flat_map_args: &'tcx [hir::Expr],
2371     flat_map_span: Span,
2372 ) {
2373     if match_trait_method(cx, expr, &paths::ITERATOR) {
2374         let arg_node = &flat_map_args[1].node;
2375
2376         let apply_lint = |message: &str| {
2377             span_lint_and_sugg(
2378                 cx,
2379                 FLAT_MAP_IDENTITY,
2380                 flat_map_span.with_hi(expr.span.hi()),
2381                 message,
2382                 "try",
2383                 "flatten()".to_string(),
2384                 Applicability::MachineApplicable,
2385             );
2386         };
2387
2388         if_chain! {
2389             if let hir::ExprKind::Closure(_, _, body_id, _, _) = arg_node;
2390             let body = cx.tcx.hir().body(*body_id);
2391
2392             if let hir::PatKind::Binding(_, _, binding_ident, _) = body.params[0].pat.node;
2393             if let hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) = body.value.node;
2394
2395             if path.segments.len() == 1;
2396             if path.segments[0].ident.as_str() == binding_ident.as_str();
2397
2398             then {
2399                 apply_lint("called `flat_map(|x| x)` on an `Iterator`");
2400             }
2401         }
2402
2403         if_chain! {
2404             if let hir::ExprKind::Path(ref qpath) = arg_node;
2405
2406             if match_qpath(qpath, &paths::STD_CONVERT_IDENTITY);
2407
2408             then {
2409                 apply_lint("called `flat_map(std::convert::identity)` on an `Iterator`");
2410             }
2411         }
2412     }
2413 }
2414
2415 /// lint searching an Iterator followed by `is_some()`
2416 fn lint_search_is_some<'a, 'tcx>(
2417     cx: &LateContext<'a, 'tcx>,
2418     expr: &'tcx hir::Expr,
2419     search_method: &str,
2420     search_args: &'tcx [hir::Expr],
2421     is_some_args: &'tcx [hir::Expr],
2422     method_span: Span,
2423 ) {
2424     // lint if caller of search is an Iterator
2425     if match_trait_method(cx, &is_some_args[0], &paths::ITERATOR) {
2426         let msg = format!(
2427             "called `is_some()` after searching an `Iterator` with {}. This is more succinctly \
2428              expressed by calling `any()`.",
2429             search_method
2430         );
2431         let search_snippet = snippet(cx, search_args[1].span, "..");
2432         if search_snippet.lines().count() <= 1 {
2433             // suggest `any(|x| ..)` instead of `any(|&x| ..)` for `find(|&x| ..).is_some()`
2434             // suggest `any(|..| *..)` instead of `any(|..| **..)` for `find(|..| **..).is_some()`
2435             let any_search_snippet = if_chain! {
2436                 if search_method == "find";
2437                 if let hir::ExprKind::Closure(_, _, body_id, ..) = search_args[1].node;
2438                 let closure_body = cx.tcx.hir().body(body_id);
2439                 if let Some(closure_arg) = closure_body.params.get(0);
2440                 then {
2441                     if let hir::PatKind::Ref(..) = closure_arg.pat.node {
2442                         Some(search_snippet.replacen('&', "", 1))
2443                     } else if let Some(name) = get_arg_name(&closure_arg.pat) {
2444                         Some(search_snippet.replace(&format!("*{}", name), &name.as_str()))
2445                     } else {
2446                         None
2447                     }
2448                 } else {
2449                     None
2450                 }
2451             };
2452             // add note if not multi-line
2453             span_lint_and_sugg(
2454                 cx,
2455                 SEARCH_IS_SOME,
2456                 method_span.with_hi(expr.span.hi()),
2457                 &msg,
2458                 "try this",
2459                 format!(
2460                     "any({})",
2461                     any_search_snippet.as_ref().map_or(&*search_snippet, String::as_str)
2462                 ),
2463                 Applicability::MachineApplicable,
2464             );
2465         } else {
2466             span_lint(cx, SEARCH_IS_SOME, expr.span, &msg);
2467         }
2468     }
2469 }
2470
2471 /// Used for `lint_binary_expr_with_method_call`.
2472 #[derive(Copy, Clone)]
2473 struct BinaryExprInfo<'a> {
2474     expr: &'a hir::Expr,
2475     chain: &'a hir::Expr,
2476     other: &'a hir::Expr,
2477     eq: bool,
2478 }
2479
2480 /// Checks for the `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints.
2481 fn lint_binary_expr_with_method_call(cx: &LateContext<'_, '_>, info: &mut BinaryExprInfo<'_>) {
2482     macro_rules! lint_with_both_lhs_and_rhs {
2483         ($func:ident, $cx:expr, $info:ident) => {
2484             if !$func($cx, $info) {
2485                 ::std::mem::swap(&mut $info.chain, &mut $info.other);
2486                 if $func($cx, $info) {
2487                     return;
2488                 }
2489             }
2490         };
2491     }
2492
2493     lint_with_both_lhs_and_rhs!(lint_chars_next_cmp, cx, info);
2494     lint_with_both_lhs_and_rhs!(lint_chars_last_cmp, cx, info);
2495     lint_with_both_lhs_and_rhs!(lint_chars_next_cmp_with_unwrap, cx, info);
2496     lint_with_both_lhs_and_rhs!(lint_chars_last_cmp_with_unwrap, cx, info);
2497 }
2498
2499 /// Wrapper fn for `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints.
2500 fn lint_chars_cmp(
2501     cx: &LateContext<'_, '_>,
2502     info: &BinaryExprInfo<'_>,
2503     chain_methods: &[&str],
2504     lint: &'static Lint,
2505     suggest: &str,
2506 ) -> bool {
2507     if_chain! {
2508         if let Some(args) = method_chain_args(info.chain, chain_methods);
2509         if let hir::ExprKind::Call(ref fun, ref arg_char) = info.other.node;
2510         if arg_char.len() == 1;
2511         if let hir::ExprKind::Path(ref qpath) = fun.node;
2512         if let Some(segment) = single_segment_path(qpath);
2513         if segment.ident.name == sym!(Some);
2514         then {
2515             let mut applicability = Applicability::MachineApplicable;
2516             let self_ty = walk_ptrs_ty(cx.tables.expr_ty_adjusted(&args[0][0]));
2517
2518             if self_ty.sty != ty::Str {
2519                 return false;
2520             }
2521
2522             span_lint_and_sugg(
2523                 cx,
2524                 lint,
2525                 info.expr.span,
2526                 &format!("you should use the `{}` method", suggest),
2527                 "like this",
2528                 format!("{}{}.{}({})",
2529                         if info.eq { "" } else { "!" },
2530                         snippet_with_applicability(cx, args[0][0].span, "_", &mut applicability),
2531                         suggest,
2532                         snippet_with_applicability(cx, arg_char[0].span, "_", &mut applicability)),
2533                 applicability,
2534             );
2535
2536             return true;
2537         }
2538     }
2539
2540     false
2541 }
2542
2543 /// Checks for the `CHARS_NEXT_CMP` lint.
2544 fn lint_chars_next_cmp<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2545     lint_chars_cmp(cx, info, &["chars", "next"], CHARS_NEXT_CMP, "starts_with")
2546 }
2547
2548 /// Checks for the `CHARS_LAST_CMP` lint.
2549 fn lint_chars_last_cmp<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2550     if lint_chars_cmp(cx, info, &["chars", "last"], CHARS_LAST_CMP, "ends_with") {
2551         true
2552     } else {
2553         lint_chars_cmp(cx, info, &["chars", "next_back"], CHARS_LAST_CMP, "ends_with")
2554     }
2555 }
2556
2557 /// Wrapper fn for `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints with `unwrap()`.
2558 fn lint_chars_cmp_with_unwrap<'a, 'tcx>(
2559     cx: &LateContext<'a, 'tcx>,
2560     info: &BinaryExprInfo<'_>,
2561     chain_methods: &[&str],
2562     lint: &'static Lint,
2563     suggest: &str,
2564 ) -> bool {
2565     if_chain! {
2566         if let Some(args) = method_chain_args(info.chain, chain_methods);
2567         if let hir::ExprKind::Lit(ref lit) = info.other.node;
2568         if let ast::LitKind::Char(c) = lit.node;
2569         then {
2570             let mut applicability = Applicability::MachineApplicable;
2571             span_lint_and_sugg(
2572                 cx,
2573                 lint,
2574                 info.expr.span,
2575                 &format!("you should use the `{}` method", suggest),
2576                 "like this",
2577                 format!("{}{}.{}('{}')",
2578                         if info.eq { "" } else { "!" },
2579                         snippet_with_applicability(cx, args[0][0].span, "_", &mut applicability),
2580                         suggest,
2581                         c),
2582                 applicability,
2583             );
2584
2585             true
2586         } else {
2587             false
2588         }
2589     }
2590 }
2591
2592 /// Checks for the `CHARS_NEXT_CMP` lint with `unwrap()`.
2593 fn lint_chars_next_cmp_with_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2594     lint_chars_cmp_with_unwrap(cx, info, &["chars", "next", "unwrap"], CHARS_NEXT_CMP, "starts_with")
2595 }
2596
2597 /// Checks for the `CHARS_LAST_CMP` lint with `unwrap()`.
2598 fn lint_chars_last_cmp_with_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2599     if lint_chars_cmp_with_unwrap(cx, info, &["chars", "last", "unwrap"], CHARS_LAST_CMP, "ends_with") {
2600         true
2601     } else {
2602         lint_chars_cmp_with_unwrap(cx, info, &["chars", "next_back", "unwrap"], CHARS_LAST_CMP, "ends_with")
2603     }
2604 }
2605
2606 /// lint for length-1 `str`s for methods in `PATTERN_METHODS`
2607 fn lint_single_char_pattern<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, _expr: &'tcx hir::Expr, arg: &'tcx hir::Expr) {
2608     if_chain! {
2609         if let hir::ExprKind::Lit(lit) = &arg.node;
2610         if let ast::LitKind::Str(r, style) = lit.node;
2611         if r.as_str().len() == 1;
2612         then {
2613             let mut applicability = Applicability::MachineApplicable;
2614             let snip = snippet_with_applicability(cx, arg.span, "..", &mut applicability);
2615             let ch = if let ast::StrStyle::Raw(nhash) = style {
2616                 let nhash = nhash as usize;
2617                 // for raw string: r##"a"##
2618                 &snip[(nhash + 2)..(snip.len() - 1 - nhash)]
2619             } else {
2620                 // for regular string: "a"
2621                 &snip[1..(snip.len() - 1)]
2622             };
2623             let hint = format!("'{}'", if ch == "'" { "\\'" } else { ch });
2624             span_lint_and_sugg(
2625                 cx,
2626                 SINGLE_CHAR_PATTERN,
2627                 arg.span,
2628                 "single-character string constant used as pattern",
2629                 "try using a char instead",
2630                 hint,
2631                 applicability,
2632             );
2633         }
2634     }
2635 }
2636
2637 /// Checks for the `USELESS_ASREF` lint.
2638 fn lint_asref(cx: &LateContext<'_, '_>, expr: &hir::Expr, call_name: &str, as_ref_args: &[hir::Expr]) {
2639     // when we get here, we've already checked that the call name is "as_ref" or "as_mut"
2640     // check if the call is to the actual `AsRef` or `AsMut` trait
2641     if match_trait_method(cx, expr, &paths::ASREF_TRAIT) || match_trait_method(cx, expr, &paths::ASMUT_TRAIT) {
2642         // check if the type after `as_ref` or `as_mut` is the same as before
2643         let recvr = &as_ref_args[0];
2644         let rcv_ty = cx.tables.expr_ty(recvr);
2645         let res_ty = cx.tables.expr_ty(expr);
2646         let (base_res_ty, res_depth) = walk_ptrs_ty_depth(res_ty);
2647         let (base_rcv_ty, rcv_depth) = walk_ptrs_ty_depth(rcv_ty);
2648         if base_rcv_ty == base_res_ty && rcv_depth >= res_depth {
2649             // allow the `as_ref` or `as_mut` if it is followed by another method call
2650             if_chain! {
2651                 if let Some(parent) = get_parent_expr(cx, expr);
2652                 if let hir::ExprKind::MethodCall(_, ref span, _) = parent.node;
2653                 if span != &expr.span;
2654                 then {
2655                     return;
2656                 }
2657             }
2658
2659             let mut applicability = Applicability::MachineApplicable;
2660             span_lint_and_sugg(
2661                 cx,
2662                 USELESS_ASREF,
2663                 expr.span,
2664                 &format!("this call to `{}` does nothing", call_name),
2665                 "try this",
2666                 snippet_with_applicability(cx, recvr.span, "_", &mut applicability).to_string(),
2667                 applicability,
2668             );
2669         }
2670     }
2671 }
2672
2673 fn ty_has_iter_method(
2674     cx: &LateContext<'_, '_>,
2675     self_ref_ty: Ty<'_>,
2676 ) -> Option<(&'static Lint, &'static str, &'static str)> {
2677     has_iter_method(cx, self_ref_ty).map(|ty_name| {
2678         let lint = if ty_name == "array" || ty_name == "PathBuf" {
2679             INTO_ITER_ON_ARRAY
2680         } else {
2681             INTO_ITER_ON_REF
2682         };
2683         let mutbl = match self_ref_ty.sty {
2684             ty::Ref(_, _, mutbl) => mutbl,
2685             _ => unreachable!(),
2686         };
2687         let method_name = match mutbl {
2688             hir::MutImmutable => "iter",
2689             hir::MutMutable => "iter_mut",
2690         };
2691         (lint, ty_name, method_name)
2692     })
2693 }
2694
2695 fn lint_into_iter(cx: &LateContext<'_, '_>, expr: &hir::Expr, self_ref_ty: Ty<'_>, method_span: Span) {
2696     if !match_trait_method(cx, expr, &paths::INTO_ITERATOR) {
2697         return;
2698     }
2699     if let Some((lint, kind, method_name)) = ty_has_iter_method(cx, self_ref_ty) {
2700         span_lint_and_sugg(
2701             cx,
2702             lint,
2703             method_span,
2704             &format!(
2705                 "this .into_iter() call is equivalent to .{}() and will not move the {}",
2706                 method_name, kind,
2707             ),
2708             "call directly",
2709             method_name.to_string(),
2710             Applicability::MachineApplicable,
2711         );
2712     }
2713 }
2714
2715 /// lint for `MaybeUninit::uninit().assume_init()` (we already have the latter)
2716 fn lint_maybe_uninit(cx: &LateContext<'_, '_>, expr: &hir::Expr, outer: &hir::Expr) {
2717     if_chain! {
2718         if let hir::ExprKind::Call(ref callee, ref args) = expr.node;
2719         if args.is_empty();
2720         if let hir::ExprKind::Path(ref path) = callee.node;
2721         if match_qpath(path, &paths::MEM_MAYBEUNINIT_UNINIT);
2722         if !is_maybe_uninit_ty_valid(cx, cx.tables.expr_ty_adjusted(outer));
2723         then {
2724             span_lint(
2725                 cx,
2726                 UNINIT_ASSUMED_INIT,
2727                 outer.span,
2728                 "this call for this type may be undefined behavior"
2729             );
2730         }
2731     }
2732 }
2733
2734 fn is_maybe_uninit_ty_valid(cx: &LateContext<'_, '_>, ty: Ty<'_>) -> bool {
2735     match ty.sty {
2736         ty::Array(ref component, _) => is_maybe_uninit_ty_valid(cx, component),
2737         ty::Tuple(ref types) => types.types().all(|ty| is_maybe_uninit_ty_valid(cx, ty)),
2738         ty::Adt(ref adt, _) => {
2739             // needs to be a MaybeUninit
2740             match_def_path(cx, adt.did, &paths::MEM_MAYBEUNINIT)
2741         },
2742         _ => false,
2743     }
2744 }
2745
2746 fn lint_suspicious_map(cx: &LateContext<'_, '_>, expr: &hir::Expr) {
2747     span_help_and_lint(
2748         cx,
2749         SUSPICIOUS_MAP,
2750         expr.span,
2751         "this call to `map()` won't have an effect on the call to `count()`",
2752         "make sure you did not confuse `map` with `filter`",
2753     );
2754 }
2755
2756 /// Given a `Result<T, E>` type, return its error type (`E`).
2757 fn get_error_type<'a>(cx: &LateContext<'_, '_>, ty: Ty<'a>) -> Option<Ty<'a>> {
2758     match ty.sty {
2759         ty::Adt(_, substs) if match_type(cx, ty, &paths::RESULT) => substs.types().nth(1),
2760         _ => None,
2761     }
2762 }
2763
2764 /// This checks whether a given type is known to implement Debug.
2765 fn has_debug_impl<'a, 'b>(ty: Ty<'a>, cx: &LateContext<'b, 'a>) -> bool {
2766     match cx.tcx.get_diagnostic_item(sym::debug_trait) {
2767         Some(debug) => implements_trait(cx, ty, debug, &[]),
2768         None => false,
2769     }
2770 }
2771
2772 enum Convention {
2773     Eq(&'static str),
2774     StartsWith(&'static str),
2775 }
2776
2777 #[rustfmt::skip]
2778 const CONVENTIONS: [(Convention, &[SelfKind]); 7] = [
2779     (Convention::Eq("new"), &[SelfKind::No]),
2780     (Convention::StartsWith("as_"), &[SelfKind::Ref, SelfKind::RefMut]),
2781     (Convention::StartsWith("from_"), &[SelfKind::No]),
2782     (Convention::StartsWith("into_"), &[SelfKind::Value]),
2783     (Convention::StartsWith("is_"), &[SelfKind::Ref, SelfKind::No]),
2784     (Convention::Eq("to_mut"), &[SelfKind::RefMut]),
2785     (Convention::StartsWith("to_"), &[SelfKind::Ref]),
2786 ];
2787
2788 #[rustfmt::skip]
2789 const TRAIT_METHODS: [(&str, usize, SelfKind, OutType, &str); 30] = [
2790     ("add", 2, SelfKind::Value, OutType::Any, "std::ops::Add"),
2791     ("as_mut", 1, SelfKind::RefMut, OutType::Ref, "std::convert::AsMut"),
2792     ("as_ref", 1, SelfKind::Ref, OutType::Ref, "std::convert::AsRef"),
2793     ("bitand", 2, SelfKind::Value, OutType::Any, "std::ops::BitAnd"),
2794     ("bitor", 2, SelfKind::Value, OutType::Any, "std::ops::BitOr"),
2795     ("bitxor", 2, SelfKind::Value, OutType::Any, "std::ops::BitXor"),
2796     ("borrow", 1, SelfKind::Ref, OutType::Ref, "std::borrow::Borrow"),
2797     ("borrow_mut", 1, SelfKind::RefMut, OutType::Ref, "std::borrow::BorrowMut"),
2798     ("clone", 1, SelfKind::Ref, OutType::Any, "std::clone::Clone"),
2799     ("cmp", 2, SelfKind::Ref, OutType::Any, "std::cmp::Ord"),
2800     ("default", 0, SelfKind::No, OutType::Any, "std::default::Default"),
2801     ("deref", 1, SelfKind::Ref, OutType::Ref, "std::ops::Deref"),
2802     ("deref_mut", 1, SelfKind::RefMut, OutType::Ref, "std::ops::DerefMut"),
2803     ("div", 2, SelfKind::Value, OutType::Any, "std::ops::Div"),
2804     ("drop", 1, SelfKind::RefMut, OutType::Unit, "std::ops::Drop"),
2805     ("eq", 2, SelfKind::Ref, OutType::Bool, "std::cmp::PartialEq"),
2806     ("from_iter", 1, SelfKind::No, OutType::Any, "std::iter::FromIterator"),
2807     ("from_str", 1, SelfKind::No, OutType::Any, "std::str::FromStr"),
2808     ("hash", 2, SelfKind::Ref, OutType::Unit, "std::hash::Hash"),
2809     ("index", 2, SelfKind::Ref, OutType::Ref, "std::ops::Index"),
2810     ("index_mut", 2, SelfKind::RefMut, OutType::Ref, "std::ops::IndexMut"),
2811     ("into_iter", 1, SelfKind::Value, OutType::Any, "std::iter::IntoIterator"),
2812     ("mul", 2, SelfKind::Value, OutType::Any, "std::ops::Mul"),
2813     ("neg", 1, SelfKind::Value, OutType::Any, "std::ops::Neg"),
2814     ("next", 1, SelfKind::RefMut, OutType::Any, "std::iter::Iterator"),
2815     ("not", 1, SelfKind::Value, OutType::Any, "std::ops::Not"),
2816     ("rem", 2, SelfKind::Value, OutType::Any, "std::ops::Rem"),
2817     ("shl", 2, SelfKind::Value, OutType::Any, "std::ops::Shl"),
2818     ("shr", 2, SelfKind::Value, OutType::Any, "std::ops::Shr"),
2819     ("sub", 2, SelfKind::Value, OutType::Any, "std::ops::Sub"),
2820 ];
2821
2822 #[rustfmt::skip]
2823 const PATTERN_METHODS: [(&str, usize); 17] = [
2824     ("contains", 1),
2825     ("starts_with", 1),
2826     ("ends_with", 1),
2827     ("find", 1),
2828     ("rfind", 1),
2829     ("split", 1),
2830     ("rsplit", 1),
2831     ("split_terminator", 1),
2832     ("rsplit_terminator", 1),
2833     ("splitn", 2),
2834     ("rsplitn", 2),
2835     ("matches", 1),
2836     ("rmatches", 1),
2837     ("match_indices", 1),
2838     ("rmatch_indices", 1),
2839     ("trim_start_matches", 1),
2840     ("trim_end_matches", 1),
2841 ];
2842
2843 #[derive(Clone, Copy, PartialEq, Debug)]
2844 enum SelfKind {
2845     Value,
2846     Ref,
2847     RefMut,
2848     No,
2849 }
2850
2851 impl SelfKind {
2852     fn matches<'a>(self, cx: &LateContext<'_, 'a>, parent_ty: Ty<'a>, ty: Ty<'a>) -> bool {
2853         fn matches_value(parent_ty: Ty<'_>, ty: Ty<'_>) -> bool {
2854             if ty == parent_ty {
2855                 true
2856             } else if ty.is_box() {
2857                 ty.boxed_ty() == parent_ty
2858             } else if ty.is_rc() || ty.is_arc() {
2859                 if let ty::Adt(_, substs) = ty.sty {
2860                     substs.types().next().map_or(false, |t| t == parent_ty)
2861                 } else {
2862                     false
2863                 }
2864             } else {
2865                 false
2866             }
2867         }
2868
2869         fn matches_ref<'a>(
2870             cx: &LateContext<'_, 'a>,
2871             mutability: hir::Mutability,
2872             parent_ty: Ty<'a>,
2873             ty: Ty<'a>,
2874         ) -> bool {
2875             if let ty::Ref(_, t, m) = ty.sty {
2876                 return m == mutability && t == parent_ty;
2877             }
2878
2879             let trait_path = match mutability {
2880                 hir::Mutability::MutImmutable => &paths::ASREF_TRAIT,
2881                 hir::Mutability::MutMutable => &paths::ASMUT_TRAIT,
2882             };
2883
2884             let trait_def_id = match get_trait_def_id(cx, trait_path) {
2885                 Some(did) => did,
2886                 None => return false,
2887             };
2888             implements_trait(cx, ty, trait_def_id, &[parent_ty.into()])
2889         }
2890
2891         match self {
2892             Self::Value => matches_value(parent_ty, ty),
2893             Self::Ref => {
2894                 matches_ref(cx, hir::Mutability::MutImmutable, parent_ty, ty) || ty == parent_ty && is_copy(cx, ty)
2895             },
2896             Self::RefMut => matches_ref(cx, hir::Mutability::MutMutable, parent_ty, ty),
2897             Self::No => ty != parent_ty,
2898         }
2899     }
2900
2901     fn description(self) -> &'static str {
2902         match self {
2903             Self::Value => "self by value",
2904             Self::Ref => "self by reference",
2905             Self::RefMut => "self by mutable reference",
2906             Self::No => "no self",
2907         }
2908     }
2909 }
2910
2911 impl Convention {
2912     fn check(&self, other: &str) -> bool {
2913         match *self {
2914             Self::Eq(this) => this == other,
2915             Self::StartsWith(this) => other.starts_with(this) && this != other,
2916         }
2917     }
2918 }
2919
2920 impl fmt::Display for Convention {
2921     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
2922         match *self {
2923             Self::Eq(this) => this.fmt(f),
2924             Self::StartsWith(this) => this.fmt(f).and_then(|_| '*'.fmt(f)),
2925         }
2926     }
2927 }
2928
2929 #[derive(Clone, Copy)]
2930 enum OutType {
2931     Unit,
2932     Bool,
2933     Any,
2934     Ref,
2935 }
2936
2937 impl OutType {
2938     fn matches(self, cx: &LateContext<'_, '_>, ty: &hir::FunctionRetTy) -> bool {
2939         let is_unit = |ty: &hir::Ty| SpanlessEq::new(cx).eq_ty_kind(&ty.node, &hir::TyKind::Tup(vec![].into()));
2940         match (self, ty) {
2941             (Self::Unit, &hir::DefaultReturn(_)) => true,
2942             (Self::Unit, &hir::Return(ref ty)) if is_unit(ty) => true,
2943             (Self::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
2944             (Self::Any, &hir::Return(ref ty)) if !is_unit(ty) => true,
2945             (Self::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyKind::Rptr(_, _)),
2946             _ => false,
2947         }
2948     }
2949 }
2950
2951 fn is_bool(ty: &hir::Ty) -> bool {
2952     if let hir::TyKind::Path(ref p) = ty.node {
2953         match_qpath(p, &["bool"])
2954     } else {
2955         false
2956     }
2957 }