clippy_lints/src/methods/mod.rs

   1 mod manual_saturating_arithmetic;
   2 mod option_map_unwrap_or;
   3 mod unnecessary_filter_map;
   4
   5 use std::borrow::Cow;
   6 use std::fmt;
   7 use std::iter;
   8
   9 use if_chain::if_chain;
  10 use matches::matches;
  11 use rustc::hir;
  12 use rustc::hir::intravisit::{self, Visitor};
  13 use rustc::lint::{in_external_macro, LateContext, LateLintPass, Lint, LintArray, LintContext, LintPass};
  14 use rustc::ty::{self, Predicate, Ty};
  15 use rustc::{declare_lint_pass, declare_tool_lint};
  16 use rustc_errors::Applicability;
  17 use syntax::ast;
  18 use syntax::source_map::Span;
  19 use syntax::symbol::{sym, Symbol, LocalInternedString};
  20
  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, is_type_diagnostic_item, iter_input_pats, last_path_segment, match_def_path,
  25     match_qpath, match_trait_method, match_type, match_var, method_calls, method_chain_args, remove_blocks,
  26     return_ty, same_tys, single_segment_path, snippet, snippet_with_applicability, snippet_with_macro_callsite,
  27     span_lint, span_lint_and_sugg, span_lint_and_then, span_note_and_lint, walk_ptrs_ty, walk_ptrs_ty_depth,
  28     SpanlessEq, sugg, paths, span_help_and_lint
  29 };
  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_clippy_lint! {
 987     /// **What it does:** Checks for `.checked_add/sub(x).unwrap_or(MAX/MIN)`.
 988     ///
 989     /// **Why is this bad?** These can be written simply with `saturating_add/sub` methods.
 990     ///
 991     /// **Example:**
 992     ///
 993     /// ```rust
 994     /// # let y: u32 = 0;
 995     /// # let x: u32 = 100;
 996     /// let add = x.checked_add(y).unwrap_or(u32::max_value());
 997     /// let sub = x.checked_sub(y).unwrap_or(u32::min_value());
 998     /// ```
 999     ///
1000     /// can be written using dedicated methods for saturating addition/subtraction as:
1001     ///
1002     /// ```rust
1003     /// # let y: u32 = 0;
1004     /// # let x: u32 = 100;
1005     /// let add = x.saturating_add(y);
1006     /// let sub = x.saturating_sub(y);
1007     /// ```
1008     pub MANUAL_SATURATING_ARITHMETIC,
1009     style,
1010     "`.chcked_add/sub(x).unwrap_or(MAX/MIN)`"
1011 }
1012
1013 declare_lint_pass!(Methods => [
1014     OPTION_UNWRAP_USED,
1015     RESULT_UNWRAP_USED,
1016     SHOULD_IMPLEMENT_TRAIT,
1017     WRONG_SELF_CONVENTION,
1018     WRONG_PUB_SELF_CONVENTION,
1019     OK_EXPECT,
1020     OPTION_MAP_UNWRAP_OR,
1021     OPTION_MAP_UNWRAP_OR_ELSE,
1022     RESULT_MAP_UNWRAP_OR_ELSE,
1023     OPTION_MAP_OR_NONE,
1024     OPTION_AND_THEN_SOME,
1025     OR_FUN_CALL,
1026     EXPECT_FUN_CALL,
1027     CHARS_NEXT_CMP,
1028     CHARS_LAST_CMP,
1029     CLONE_ON_COPY,
1030     CLONE_ON_REF_PTR,
1031     CLONE_DOUBLE_REF,
1032     NEW_RET_NO_SELF,
1033     SINGLE_CHAR_PATTERN,
1034     SEARCH_IS_SOME,
1035     TEMPORARY_CSTRING_AS_PTR,
1036     FILTER_NEXT,
1037     FILTER_MAP,
1038     FILTER_MAP_NEXT,
1039     FLAT_MAP_IDENTITY,
1040     FIND_MAP,
1041     MAP_FLATTEN,
1042     ITER_NTH,
1043     ITER_SKIP_NEXT,
1044     GET_UNWRAP,
1045     STRING_EXTEND_CHARS,
1046     ITER_CLONED_COLLECT,
1047     USELESS_ASREF,
1048     UNNECESSARY_FOLD,
1049     UNNECESSARY_FILTER_MAP,
1050     INTO_ITER_ON_ARRAY,
1051     INTO_ITER_ON_REF,
1052     SUSPICIOUS_MAP,
1053     UNINIT_ASSUMED_INIT,
1054     MANUAL_SATURATING_ARITHMETIC,
1055 ]);
1056
1057 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Methods {
1058     #[allow(clippy::cognitive_complexity)]
1059     fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr) {
1060         if in_macro(expr.span) {
1061             return;
1062         }
1063
1064         let (method_names, arg_lists, method_spans) = method_calls(expr, 2);
1065         let method_names: Vec<LocalInternedString> = method_names.iter().map(|s| s.as_str()).collect();
1066         let method_names: Vec<&str> = method_names.iter().map(std::convert::AsRef::as_ref).collect();
1067
1068         match method_names.as_slice() {
1069             ["unwrap", "get"] => lint_get_unwrap(cx, expr, arg_lists[1], false),
1070             ["unwrap", "get_mut"] => lint_get_unwrap(cx, expr, arg_lists[1], true),
1071             ["unwrap", ..] => lint_unwrap(cx, expr, arg_lists[0]),
1072             ["expect", "ok"] => lint_ok_expect(cx, expr, arg_lists[1]),
1073             ["unwrap_or", "map"] => option_map_unwrap_or::lint(cx, expr, arg_lists[1], arg_lists[0]),
1074             ["unwrap_or_else", "map"] => lint_map_unwrap_or_else(cx, expr, arg_lists[1], arg_lists[0]),
1075             ["map_or", ..] => lint_map_or_none(cx, expr, arg_lists[0]),
1076             ["and_then", ..] => lint_option_and_then_some(cx, expr, arg_lists[0]),
1077             ["next", "filter"] => lint_filter_next(cx, expr, arg_lists[1]),
1078             ["map", "filter"] => lint_filter_map(cx, expr, arg_lists[1], arg_lists[0]),
1079             ["map", "filter_map"] => lint_filter_map_map(cx, expr, arg_lists[1], arg_lists[0]),
1080             ["next", "filter_map"] => lint_filter_map_next(cx, expr, arg_lists[1]),
1081             ["map", "find"] => lint_find_map(cx, expr, arg_lists[1], arg_lists[0]),
1082             ["flat_map", "filter"] => lint_filter_flat_map(cx, expr, arg_lists[1], arg_lists[0]),
1083             ["flat_map", "filter_map"] => lint_filter_map_flat_map(cx, expr, arg_lists[1], arg_lists[0]),
1084             ["flat_map", ..] => lint_flat_map_identity(cx, expr, arg_lists[0], method_spans[0]),
1085             ["flatten", "map"] => lint_map_flatten(cx, expr, arg_lists[1]),
1086             ["is_some", "find"] => lint_search_is_some(cx, expr, "find", arg_lists[1], arg_lists[0], method_spans[1]),
1087             ["is_some", "position"] => {
1088                 lint_search_is_some(cx, expr, "position", arg_lists[1], arg_lists[0], method_spans[1])
1089             },
1090             ["is_some", "rposition"] => {
1091                 lint_search_is_some(cx, expr, "rposition", arg_lists[1], arg_lists[0], method_spans[1])
1092             },
1093             ["extend", ..] => lint_extend(cx, expr, arg_lists[0]),
1094             ["as_ptr", "unwrap"] | ["as_ptr", "expect"] => {
1095                 lint_cstring_as_ptr(cx, expr, &arg_lists[1][0], &arg_lists[0][0])
1096             },
1097             ["nth", "iter"] => lint_iter_nth(cx, expr, arg_lists[1], false),
1098             ["nth", "iter_mut"] => lint_iter_nth(cx, expr, arg_lists[1], true),
1099             ["next", "skip"] => lint_iter_skip_next(cx, expr),
1100             ["collect", "cloned"] => lint_iter_cloned_collect(cx, expr, arg_lists[1]),
1101             ["as_ref"] => lint_asref(cx, expr, "as_ref", arg_lists[0]),
1102             ["as_mut"] => lint_asref(cx, expr, "as_mut", arg_lists[0]),
1103             ["fold", ..] => lint_unnecessary_fold(cx, expr, arg_lists[0], method_spans[0]),
1104             ["filter_map", ..] => unnecessary_filter_map::lint(cx, expr, arg_lists[0]),
1105             ["count", "map"] => lint_suspicious_map(cx, expr),
1106             ["assume_init"] => lint_maybe_uninit(cx, &arg_lists[0][0], expr),
1107             ["unwrap_or", arith @ "checked_add"]
1108             | ["unwrap_or", arith @ "checked_sub"]
1109             | ["unwrap_or", arith @ "checked_mul"] => {
1110                 manual_saturating_arithmetic::lint(cx, expr, &arg_lists, &arith["checked_".len()..])
1111             },
1112             _ => {},
1113         }
1114
1115         match expr.node {
1116             hir::ExprKind::MethodCall(ref method_call, ref method_span, ref args) => {
1117                 lint_or_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
1118                 lint_expect_fun_call(cx, expr, *method_span, &method_call.ident.as_str(), args);
1119
1120                 let self_ty = cx.tables.expr_ty_adjusted(&args[0]);
1121                 if args.len() == 1 && method_call.ident.name == sym!(clone) {
1122                     lint_clone_on_copy(cx, expr, &args[0], self_ty);
1123                     lint_clone_on_ref_ptr(cx, expr, &args[0]);
1124                 }
1125
1126                 match self_ty.sty {
1127                     ty::Ref(_, ty, _) if ty.sty == ty::Str => {
1128                         for &(method, pos) in &PATTERN_METHODS {
1129                             if method_call.ident.name.as_str() == method && args.len() > pos {
1130                                 lint_single_char_pattern(cx, expr, &args[pos]);
1131                             }
1132                         }
1133                     },
1134                     ty::Ref(..) if method_call.ident.name == sym!(into_iter) => {
1135                         lint_into_iter(cx, expr, self_ty, *method_span);
1136                     },
1137                     _ => (),
1138                 }
1139             },
1140             hir::ExprKind::Binary(op, ref lhs, ref rhs)
1141                 if op.node == hir::BinOpKind::Eq || op.node == hir::BinOpKind::Ne =>
1142             {
1143                 let mut info = BinaryExprInfo {
1144                     expr,
1145                     chain: lhs,
1146                     other: rhs,
1147                     eq: op.node == hir::BinOpKind::Eq,
1148                 };
1149                 lint_binary_expr_with_method_call(cx, &mut info);
1150             }
1151             _ => (),
1152         }
1153     }
1154
1155     fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, impl_item: &'tcx hir::ImplItem) {
1156         if in_external_macro(cx.sess(), impl_item.span) {
1157             return;
1158         }
1159         let name = impl_item.ident.name.as_str();
1160         let parent = cx.tcx.hir().get_parent_item(impl_item.hir_id);
1161         let item = cx.tcx.hir().expect_item(parent);
1162         let def_id = cx.tcx.hir().local_def_id(item.hir_id);
1163         let ty = cx.tcx.type_of(def_id);
1164         if_chain! {
1165             if let hir::ImplItemKind::Method(ref sig, id) = impl_item.node;
1166             if let Some(first_arg) = iter_input_pats(&sig.decl, cx.tcx.hir().body(id)).next();
1167             if let hir::ItemKind::Impl(_, _, _, _, None, _, _) = item.node;
1168
1169             let method_def_id = cx.tcx.hir().local_def_id(impl_item.hir_id);
1170             let method_sig = cx.tcx.fn_sig(method_def_id);
1171             let method_sig = cx.tcx.erase_late_bound_regions(&method_sig);
1172
1173             let first_arg_ty = &method_sig.inputs().iter().next();
1174
1175             // check conventions w.r.t. conversion method names and predicates
1176             if let Some(first_arg_ty) = first_arg_ty;
1177
1178             then {
1179                 if cx.access_levels.is_exported(impl_item.hir_id) {
1180                 // check missing trait implementations
1181                     for &(method_name, n_args, self_kind, out_type, trait_name) in &TRAIT_METHODS {
1182                         if name == method_name &&
1183                         sig.decl.inputs.len() == n_args &&
1184                         out_type.matches(cx, &sig.decl.output) &&
1185                         self_kind.matches(cx, ty, first_arg_ty) {
1186                             span_lint(cx, SHOULD_IMPLEMENT_TRAIT, impl_item.span, &format!(
1187                                 "defining a method called `{}` on this type; consider implementing \
1188                                 the `{}` trait or choosing a less ambiguous name", name, trait_name));
1189                         }
1190                     }
1191                 }
1192
1193                 if let Some((ref conv, self_kinds)) = &CONVENTIONS
1194                     .iter()
1195                     .find(|(ref conv, _)| conv.check(&name))
1196                 {
1197                     if !self_kinds.iter().any(|k| k.matches(cx, ty, first_arg_ty)) {
1198                         let lint = if item.vis.node.is_pub() {
1199                             WRONG_PUB_SELF_CONVENTION
1200                         } else {
1201                             WRONG_SELF_CONVENTION
1202                         };
1203
1204                         span_lint(
1205                             cx,
1206                             lint,
1207                             first_arg.pat.span,
1208                             &format!(
1209                                "methods called `{}` usually take {}; consider choosing a less \
1210                                  ambiguous name",
1211                                 conv,
1212                                 &self_kinds
1213                                     .iter()
1214                                     .map(|k| k.description())
1215                                     .collect::<Vec<_>>()
1216                                     .join(" or ")
1217                             ),
1218                         );
1219                     }
1220                 }
1221             }
1222         }
1223
1224         if let hir::ImplItemKind::Method(_, _) = impl_item.node {
1225             let ret_ty = return_ty(cx, impl_item.hir_id);
1226
1227             // walk the return type and check for Self (this does not check associated types)
1228             if ret_ty.walk().any(|inner_type| same_tys(cx, ty, inner_type)) {
1229                 return;
1230             }
1231
1232             // if return type is impl trait, check the associated types
1233             if let ty::Opaque(def_id, _) = ret_ty.sty {
1234                 // one of the associated types must be Self
1235                 for predicate in &cx.tcx.predicates_of(def_id).predicates {
1236                     match predicate {
1237                         (Predicate::Projection(poly_projection_predicate), _) => {
1238                             let binder = poly_projection_predicate.ty();
1239                             let associated_type = binder.skip_binder();
1240
1241                             // walk the associated type and check for Self
1242                             for inner_type in associated_type.walk() {
1243                                 if same_tys(cx, ty, inner_type) {
1244                                     return;
1245                                 }
1246                             }
1247                         },
1248                         (_, _) => {},
1249                     }
1250                 }
1251             }
1252
1253             if name == "new" && !same_tys(cx, ret_ty, ty) {
1254                 span_lint(
1255                     cx,
1256                     NEW_RET_NO_SELF,
1257                     impl_item.span,
1258                     "methods called `new` usually return `Self`",
1259                 );
1260             }
1261         }
1262     }
1263 }
1264
1265 /// Checks for the `OR_FUN_CALL` lint.
1266 #[allow(clippy::too_many_lines)]
1267 fn lint_or_fun_call<'a, 'tcx>(
1268     cx: &LateContext<'a, 'tcx>,
1269     expr: &hir::Expr,
1270     method_span: Span,
1271     name: &str,
1272     args: &'tcx [hir::Expr],
1273 ) {
1274     // Searches an expression for method calls or function calls that aren't ctors
1275     struct FunCallFinder<'a, 'tcx> {
1276         cx: &'a LateContext<'a, 'tcx>,
1277         found: bool,
1278     }
1279
1280     impl<'a, 'tcx> intravisit::Visitor<'tcx> for FunCallFinder<'a, 'tcx> {
1281         fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
1282             let call_found = match &expr.node {
1283                 // ignore enum and struct constructors
1284                 hir::ExprKind::Call(..) => !is_ctor_function(self.cx, expr),
1285                 hir::ExprKind::MethodCall(..) => true,
1286                 _ => false,
1287             };
1288
1289             if call_found {
1290                 // don't lint for constant values
1291                 let owner_def = self.cx.tcx.hir().get_parent_did(expr.hir_id);
1292                 let promotable = self
1293                     .cx
1294                     .tcx
1295                     .rvalue_promotable_map(owner_def)
1296                     .contains(&expr.hir_id.local_id);
1297                 if !promotable {
1298                     self.found |= true;
1299                 }
1300             }
1301
1302             if !self.found {
1303                 intravisit::walk_expr(self, expr);
1304             }
1305         }
1306
1307         fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
1308             intravisit::NestedVisitorMap::None
1309         }
1310     }
1311
1312     /// Checks for `unwrap_or(T::new())` or `unwrap_or(T::default())`.
1313     fn check_unwrap_or_default(
1314         cx: &LateContext<'_, '_>,
1315         name: &str,
1316         fun: &hir::Expr,
1317         self_expr: &hir::Expr,
1318         arg: &hir::Expr,
1319         or_has_args: bool,
1320         span: Span,
1321     ) -> bool {
1322         if_chain! {
1323             if !or_has_args;
1324             if name == "unwrap_or";
1325             if let hir::ExprKind::Path(ref qpath) = fun.node;
1326             let path = &*last_path_segment(qpath).ident.as_str();
1327             if ["default", "new"].contains(&path);
1328             let arg_ty = cx.tables.expr_ty(arg);
1329             if let Some(default_trait_id) = get_trait_def_id(cx, &paths::DEFAULT_TRAIT);
1330             if implements_trait(cx, arg_ty, default_trait_id, &[]);
1331
1332             then {
1333                 let mut applicability = Applicability::MachineApplicable;
1334                 span_lint_and_sugg(
1335                     cx,
1336                     OR_FUN_CALL,
1337                     span,
1338                     &format!("use of `{}` followed by a call to `{}`", name, path),
1339                     "try this",
1340                     format!(
1341                         "{}.unwrap_or_default()",
1342                         snippet_with_applicability(cx, self_expr.span, "_", &mut applicability)
1343                     ),
1344                     applicability,
1345                 );
1346
1347                 true
1348             } else {
1349                 false
1350             }
1351         }
1352     }
1353
1354     /// Checks for `*or(foo())`.
1355     #[allow(clippy::too_many_arguments)]
1356     fn check_general_case<'a, 'tcx>(
1357         cx: &LateContext<'a, 'tcx>,
1358         name: &str,
1359         method_span: Span,
1360         fun_span: Span,
1361         self_expr: &hir::Expr,
1362         arg: &'tcx hir::Expr,
1363         or_has_args: bool,
1364         span: Span,
1365     ) {
1366         // (path, fn_has_argument, methods, suffix)
1367         let know_types: &[(&[_], _, &[_], _)] = &[
1368             (&paths::BTREEMAP_ENTRY, false, &["or_insert"], "with"),
1369             (&paths::HASHMAP_ENTRY, false, &["or_insert"], "with"),
1370             (&paths::OPTION, false, &["map_or", "ok_or", "or", "unwrap_or"], "else"),
1371             (&paths::RESULT, true, &["or", "unwrap_or"], "else"),
1372         ];
1373
1374         if_chain! {
1375             if know_types.iter().any(|k| k.2.contains(&name));
1376
1377             let mut finder = FunCallFinder { cx: &cx, found: false };
1378             if { finder.visit_expr(&arg); finder.found };
1379             if !contains_return(&arg);
1380
1381             let self_ty = cx.tables.expr_ty(self_expr);
1382
1383             if let Some(&(_, fn_has_arguments, poss, suffix)) =
1384                    know_types.iter().find(|&&i| match_type(cx, self_ty, i.0));
1385
1386             if poss.contains(&name);
1387
1388             then {
1389                 let sugg: Cow<'_, _> = match (fn_has_arguments, !or_has_args) {
1390                     (true, _) => format!("|_| {}", snippet_with_macro_callsite(cx, arg.span, "..")).into(),
1391                     (false, false) => format!("|| {}", snippet_with_macro_callsite(cx, arg.span, "..")).into(),
1392                     (false, true) => snippet_with_macro_callsite(cx, fun_span, ".."),
1393                 };
1394                 let span_replace_word = method_span.with_hi(span.hi());
1395                 span_lint_and_sugg(
1396                     cx,
1397                     OR_FUN_CALL,
1398                     span_replace_word,
1399                     &format!("use of `{}` followed by a function call", name),
1400                     "try this",
1401                     format!("{}_{}({})", name, suffix, sugg),
1402                     Applicability::HasPlaceholders,
1403                 );
1404             }
1405         }
1406     }
1407
1408     if args.len() == 2 {
1409         match args[1].node {
1410             hir::ExprKind::Call(ref fun, ref or_args) => {
1411                 let or_has_args = !or_args.is_empty();
1412                 if !check_unwrap_or_default(cx, name, fun, &args[0], &args[1], or_has_args, expr.span) {
1413                     check_general_case(
1414                         cx,
1415                         name,
1416                         method_span,
1417                         fun.span,
1418                         &args[0],
1419                         &args[1],
1420                         or_has_args,
1421                         expr.span,
1422                     );
1423                 }
1424             },
1425             hir::ExprKind::MethodCall(_, span, ref or_args) => check_general_case(
1426                 cx,
1427                 name,
1428                 method_span,
1429                 span,
1430                 &args[0],
1431                 &args[1],
1432                 !or_args.is_empty(),
1433                 expr.span,
1434             ),
1435             _ => {},
1436         }
1437     }
1438 }
1439
1440 /// Checks for the `EXPECT_FUN_CALL` lint.
1441 #[allow(clippy::too_many_lines)]
1442 fn lint_expect_fun_call(cx: &LateContext<'_, '_>, expr: &hir::Expr, method_span: Span, name: &str, args: &[hir::Expr]) {
1443     // Strip `&`, `as_ref()` and `as_str()` off `arg` until we're left with either a `String` or
1444     // `&str`
1445     fn get_arg_root<'a>(cx: &LateContext<'_, '_>, arg: &'a hir::Expr) -> &'a hir::Expr {
1446         let mut arg_root = arg;
1447         loop {
1448             arg_root = match &arg_root.node {
1449                 hir::ExprKind::AddrOf(_, expr) => expr,
1450                 hir::ExprKind::MethodCall(method_name, _, call_args) => {
1451                     if call_args.len() == 1
1452                         && (method_name.ident.name == sym!(as_str) || method_name.ident.name == sym!(as_ref))
1453                         && {
1454                             let arg_type = cx.tables.expr_ty(&call_args[0]);
1455                             let base_type = walk_ptrs_ty(arg_type);
1456                             base_type.sty == ty::Str || match_type(cx, base_type, &paths::STRING)
1457                         }
1458                     {
1459                         &call_args[0]
1460                     } else {
1461                         break;
1462                     }
1463                 },
1464                 _ => break,
1465             };
1466         }
1467         arg_root
1468     }
1469
1470     // Only `&'static str` or `String` can be used directly in the `panic!`. Other types should be
1471     // converted to string.
1472     fn requires_to_string(cx: &LateContext<'_, '_>, arg: &hir::Expr) -> bool {
1473         let arg_ty = cx.tables.expr_ty(arg);
1474         if match_type(cx, arg_ty, &paths::STRING) {
1475             return false;
1476         }
1477         if let ty::Ref(ty::ReStatic, ty, ..) = arg_ty.sty {
1478             if ty.sty == ty::Str {
1479                 return false;
1480             }
1481         };
1482         true
1483     }
1484
1485     fn generate_format_arg_snippet(
1486         cx: &LateContext<'_, '_>,
1487         a: &hir::Expr,
1488         applicability: &mut Applicability,
1489     ) -> Vec<String> {
1490         if_chain! {
1491             if let hir::ExprKind::AddrOf(_, ref format_arg) = a.node;
1492             if let hir::ExprKind::Match(ref format_arg_expr, _, _) = format_arg.node;
1493             if let hir::ExprKind::Tup(ref format_arg_expr_tup) = format_arg_expr.node;
1494
1495             then {
1496                 format_arg_expr_tup
1497                     .iter()
1498                     .map(|a| snippet_with_applicability(cx, a.span, "..", applicability).into_owned())
1499                     .collect()
1500             } else {
1501                 unreachable!()
1502             }
1503         }
1504     }
1505
1506     fn is_call(node: &hir::ExprKind) -> bool {
1507         match node {
1508             hir::ExprKind::AddrOf(_, expr) => {
1509                 is_call(&expr.node)
1510             },
1511             hir::ExprKind::Call(..)
1512             | hir::ExprKind::MethodCall(..)
1513             // These variants are debatable or require further examination
1514             | hir::ExprKind::Match(..)
1515             | hir::ExprKind::Block{ .. } => true,
1516             _ => false,
1517         }
1518     }
1519
1520     if args.len() != 2 || name != "expect" || !is_call(&args[1].node) {
1521         return;
1522     }
1523
1524     let receiver_type = cx.tables.expr_ty(&args[0]);
1525     let closure_args = if match_type(cx, receiver_type, &paths::OPTION) {
1526         "||"
1527     } else if match_type(cx, receiver_type, &paths::RESULT) {
1528         "|_|"
1529     } else {
1530         return;
1531     };
1532
1533     let arg_root = get_arg_root(cx, &args[1]);
1534
1535     let span_replace_word = method_span.with_hi(expr.span.hi());
1536
1537     let mut applicability = Applicability::MachineApplicable;
1538
1539     //Special handling for `format!` as arg_root
1540     if let hir::ExprKind::Call(ref inner_fun, ref inner_args) = arg_root.node {
1541         if is_expn_of(inner_fun.span, "format").is_some() && inner_args.len() == 1 {
1542             if let hir::ExprKind::Call(_, format_args) = &inner_args[0].node {
1543                 let fmt_spec = &format_args[0];
1544                 let fmt_args = &format_args[1];
1545
1546                 let mut args = vec![snippet(cx, fmt_spec.span, "..").into_owned()];
1547
1548                 args.extend(generate_format_arg_snippet(cx, fmt_args, &mut applicability));
1549
1550                 let sugg = args.join(", ");
1551
1552                 span_lint_and_sugg(
1553                     cx,
1554                     EXPECT_FUN_CALL,
1555                     span_replace_word,
1556                     &format!("use of `{}` followed by a function call", name),
1557                     "try this",
1558                     format!("unwrap_or_else({} panic!({}))", closure_args, sugg),
1559                     applicability,
1560                 );
1561
1562                 return;
1563             }
1564         }
1565     }
1566
1567     let mut arg_root_snippet: Cow<'_, _> = snippet_with_applicability(cx, arg_root.span, "..", &mut applicability);
1568     if requires_to_string(cx, arg_root) {
1569         arg_root_snippet.to_mut().push_str(".to_string()");
1570     }
1571
1572     span_lint_and_sugg(
1573         cx,
1574         EXPECT_FUN_CALL,
1575         span_replace_word,
1576         &format!("use of `{}` followed by a function call", name),
1577         "try this",
1578         format!("unwrap_or_else({} {{ panic!({}) }})", closure_args, arg_root_snippet),
1579         applicability,
1580     );
1581 }
1582
1583 /// Checks for the `CLONE_ON_COPY` lint.
1584 fn lint_clone_on_copy(cx: &LateContext<'_, '_>, expr: &hir::Expr, arg: &hir::Expr, arg_ty: Ty<'_>) {
1585     let ty = cx.tables.expr_ty(expr);
1586     if let ty::Ref(_, inner, _) = arg_ty.sty {
1587         if let ty::Ref(_, innermost, _) = inner.sty {
1588             span_lint_and_then(
1589                 cx,
1590                 CLONE_DOUBLE_REF,
1591                 expr.span,
1592                 "using `clone` on a double-reference; \
1593                  this will copy the reference instead of cloning the inner type",
1594                 |db| {
1595                     if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
1596                         let mut ty = innermost;
1597                         let mut n = 0;
1598                         while let ty::Ref(_, inner, _) = ty.sty {
1599                             ty = inner;
1600                             n += 1;
1601                         }
1602                         let refs: String = iter::repeat('&').take(n + 1).collect();
1603                         let derefs: String = iter::repeat('*').take(n).collect();
1604                         let explicit = format!("{}{}::clone({})", refs, ty, snip);
1605                         db.span_suggestion(
1606                             expr.span,
1607                             "try dereferencing it",
1608                             format!("{}({}{}).clone()", refs, derefs, snip.deref()),
1609                             Applicability::MaybeIncorrect,
1610                         );
1611                         db.span_suggestion(
1612                             expr.span,
1613                             "or try being explicit about what type to clone",
1614                             explicit,
1615                             Applicability::MaybeIncorrect,
1616                         );
1617                     }
1618                 },
1619             );
1620             return; // don't report clone_on_copy
1621         }
1622     }
1623
1624     if is_copy(cx, ty) {
1625         let snip;
1626         if let Some(snippet) = sugg::Sugg::hir_opt(cx, arg) {
1627             let parent = cx.tcx.hir().get_parent_node(expr.hir_id);
1628             match &cx.tcx.hir().get(parent) {
1629                 hir::Node::Expr(parent) => match parent.node {
1630                     // &*x is a nop, &x.clone() is not
1631                     hir::ExprKind::AddrOf(..) |
1632                     // (*x).func() is useless, x.clone().func() can work in case func borrows mutably
1633                     hir::ExprKind::MethodCall(..) => return,
1634                     _ => {},
1635                 },
1636                 hir::Node::Stmt(stmt) => {
1637                     if let hir::StmtKind::Local(ref loc) = stmt.node {
1638                         if let hir::PatKind::Ref(..) = loc.pat.node {
1639                             // let ref y = *x borrows x, let ref y = x.clone() does not
1640                             return;
1641                         }
1642                     }
1643                 },
1644                 _ => {},
1645             }
1646
1647             // x.clone() might have dereferenced x, possibly through Deref impls
1648             if cx.tables.expr_ty(arg) == ty {
1649                 snip = Some(("try removing the `clone` call", format!("{}", snippet)));
1650             } else {
1651                 let deref_count = cx
1652                     .tables
1653                     .expr_adjustments(arg)
1654                     .iter()
1655                     .filter(|adj| {
1656                         if let ty::adjustment::Adjust::Deref(_) = adj.kind {
1657                             true
1658                         } else {
1659                             false
1660                         }
1661                     })
1662                     .count();
1663                 let derefs: String = iter::repeat('*').take(deref_count).collect();
1664                 snip = Some(("try dereferencing it", format!("{}{}", derefs, snippet)));
1665             }
1666         } else {
1667             snip = None;
1668         }
1669         span_lint_and_then(cx, CLONE_ON_COPY, expr.span, "using `clone` on a `Copy` type", |db| {
1670             if let Some((text, snip)) = snip {
1671                 db.span_suggestion(expr.span, text, snip, Applicability::Unspecified);
1672             }
1673         });
1674     }
1675 }
1676
1677 fn lint_clone_on_ref_ptr(cx: &LateContext<'_, '_>, expr: &hir::Expr, arg: &hir::Expr) {
1678     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(arg));
1679
1680     if let ty::Adt(_, subst) = obj_ty.sty {
1681         let caller_type = if match_type(cx, obj_ty, &paths::RC) {
1682             "Rc"
1683         } else if match_type(cx, obj_ty, &paths::ARC) {
1684             "Arc"
1685         } else if match_type(cx, obj_ty, &paths::WEAK_RC) || match_type(cx, obj_ty, &paths::WEAK_ARC) {
1686             "Weak"
1687         } else {
1688             return;
1689         };
1690
1691         span_lint_and_sugg(
1692             cx,
1693             CLONE_ON_REF_PTR,
1694             expr.span,
1695             "using '.clone()' on a ref-counted pointer",
1696             "try this",
1697             format!(
1698                 "{}::<{}>::clone(&{})",
1699                 caller_type,
1700                 subst.type_at(0),
1701                 snippet(cx, arg.span, "_")
1702             ),
1703             Applicability::Unspecified, // Sometimes unnecessary ::<_> after Rc/Arc/Weak
1704         );
1705     }
1706 }
1707
1708 fn lint_string_extend(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
1709     let arg = &args[1];
1710     if let Some(arglists) = method_chain_args(arg, &["chars"]) {
1711         let target = &arglists[0][0];
1712         let self_ty = walk_ptrs_ty(cx.tables.expr_ty(target));
1713         let ref_str = if self_ty.sty == ty::Str {
1714             ""
1715         } else if match_type(cx, self_ty, &paths::STRING) {
1716             "&"
1717         } else {
1718             return;
1719         };
1720
1721         let mut applicability = Applicability::MachineApplicable;
1722         span_lint_and_sugg(
1723             cx,
1724             STRING_EXTEND_CHARS,
1725             expr.span,
1726             "calling `.extend(_.chars())`",
1727             "try this",
1728             format!(
1729                 "{}.push_str({}{})",
1730                 snippet_with_applicability(cx, args[0].span, "_", &mut applicability),
1731                 ref_str,
1732                 snippet_with_applicability(cx, target.span, "_", &mut applicability)
1733             ),
1734             applicability,
1735         );
1736     }
1737 }
1738
1739 fn lint_extend(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
1740     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(&args[0]));
1741     if match_type(cx, obj_ty, &paths::STRING) {
1742         lint_string_extend(cx, expr, args);
1743     }
1744 }
1745
1746 fn lint_cstring_as_ptr(cx: &LateContext<'_, '_>, expr: &hir::Expr, source: &hir::Expr, unwrap: &hir::Expr) {
1747     if_chain! {
1748         let source_type = cx.tables.expr_ty(source);
1749         if let ty::Adt(def, substs) = source_type.sty;
1750         if match_def_path(cx, def.did, &paths::RESULT);
1751         if match_type(cx, substs.type_at(0), &paths::CSTRING);
1752         then {
1753             span_lint_and_then(
1754                 cx,
1755                 TEMPORARY_CSTRING_AS_PTR,
1756                 expr.span,
1757                 "you are getting the inner pointer of a temporary `CString`",
1758                 |db| {
1759                     db.note("that pointer will be invalid outside this expression");
1760                     db.span_help(unwrap.span, "assign the `CString` to a variable to extend its lifetime");
1761                 });
1762         }
1763     }
1764 }
1765
1766 fn lint_iter_cloned_collect<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, iter_args: &'tcx [hir::Expr]) {
1767     if_chain! {
1768         if is_type_diagnostic_item(cx, cx.tables.expr_ty(expr), Symbol::intern("vec_type"));
1769         if let Some(slice) = derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0]));
1770         if let Some(to_replace) = expr.span.trim_start(slice.span.source_callsite());
1771
1772         then {
1773             span_lint_and_sugg(
1774                 cx,
1775                 ITER_CLONED_COLLECT,
1776                 to_replace,
1777                 "called `iter().cloned().collect()` on a slice to create a `Vec`. Calling `to_vec()` is both faster and \
1778                  more readable",
1779                 "try",
1780                 ".to_vec()".to_string(),
1781                 Applicability::MachineApplicable,
1782             );
1783         }
1784     }
1785 }
1786
1787 fn lint_unnecessary_fold(cx: &LateContext<'_, '_>, expr: &hir::Expr, fold_args: &[hir::Expr], fold_span: Span) {
1788     fn check_fold_with_op(
1789         cx: &LateContext<'_, '_>,
1790         expr: &hir::Expr,
1791         fold_args: &[hir::Expr],
1792         fold_span: Span,
1793         op: hir::BinOpKind,
1794         replacement_method_name: &str,
1795         replacement_has_args: bool,
1796     ) {
1797         if_chain! {
1798             // Extract the body of the closure passed to fold
1799             if let hir::ExprKind::Closure(_, _, body_id, _, _) = fold_args[2].node;
1800             let closure_body = cx.tcx.hir().body(body_id);
1801             let closure_expr = remove_blocks(&closure_body.value);
1802
1803             // Check if the closure body is of the form `acc <op> some_expr(x)`
1804             if let hir::ExprKind::Binary(ref bin_op, ref left_expr, ref right_expr) = closure_expr.node;
1805             if bin_op.node == op;
1806
1807             // Extract the names of the two arguments to the closure
1808             if let Some(first_arg_ident) = get_arg_name(&closure_body.params[0].pat);
1809             if let Some(second_arg_ident) = get_arg_name(&closure_body.params[1].pat);
1810
1811             if match_var(&*left_expr, first_arg_ident);
1812             if replacement_has_args || match_var(&*right_expr, second_arg_ident);
1813
1814             then {
1815                 let mut applicability = Applicability::MachineApplicable;
1816                 let sugg = if replacement_has_args {
1817                     format!(
1818                         "{replacement}(|{s}| {r})",
1819                         replacement = replacement_method_name,
1820                         s = second_arg_ident,
1821                         r = snippet_with_applicability(cx, right_expr.span, "EXPR", &mut applicability),
1822                     )
1823                 } else {
1824                     format!(
1825                         "{replacement}()",
1826                         replacement = replacement_method_name,
1827                     )
1828                 };
1829
1830                 span_lint_and_sugg(
1831                     cx,
1832                     UNNECESSARY_FOLD,
1833                     fold_span.with_hi(expr.span.hi()),
1834                     // TODO #2371 don't suggest e.g., .any(|x| f(x)) if we can suggest .any(f)
1835                     "this `.fold` can be written more succinctly using another method",
1836                     "try",
1837                     sugg,
1838                     applicability,
1839                 );
1840             }
1841         }
1842     }
1843
1844     // Check that this is a call to Iterator::fold rather than just some function called fold
1845     if !match_trait_method(cx, expr, &paths::ITERATOR) {
1846         return;
1847     }
1848
1849     assert!(
1850         fold_args.len() == 3,
1851         "Expected fold_args to have three entries - the receiver, the initial value and the closure"
1852     );
1853
1854     // Check if the first argument to .fold is a suitable literal
1855     if let hir::ExprKind::Lit(ref lit) = fold_args[1].node {
1856         match lit.node {
1857             ast::LitKind::Bool(false) => {
1858                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::Or, "any", true)
1859             },
1860             ast::LitKind::Bool(true) => {
1861                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::And, "all", true)
1862             },
1863             ast::LitKind::Int(0, _) => {
1864                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::Add, "sum", false)
1865             },
1866             ast::LitKind::Int(1, _) => {
1867                 check_fold_with_op(cx, expr, fold_args, fold_span, hir::BinOpKind::Mul, "product", false)
1868             },
1869             _ => (),
1870         }
1871     }
1872 }
1873
1874 fn lint_iter_nth<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, iter_args: &'tcx [hir::Expr], is_mut: bool) {
1875     let mut_str = if is_mut { "_mut" } else { "" };
1876     let caller_type = if derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0])).is_some() {
1877         "slice"
1878     } else if is_type_diagnostic_item(cx, cx.tables.expr_ty(&iter_args[0]), Symbol::intern("vec_type")) {
1879         "Vec"
1880     } else if match_type(cx, cx.tables.expr_ty(&iter_args[0]), &paths::VEC_DEQUE) {
1881         "VecDeque"
1882     } else {
1883         return; // caller is not a type that we want to lint
1884     };
1885
1886     span_lint(
1887         cx,
1888         ITER_NTH,
1889         expr.span,
1890         &format!(
1891             "called `.iter{0}().nth()` on a {1}. Calling `.get{0}()` is both faster and more readable",
1892             mut_str, caller_type
1893         ),
1894     );
1895 }
1896
1897 fn lint_get_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &hir::Expr, get_args: &'tcx [hir::Expr], is_mut: bool) {
1898     // Note: we don't want to lint `get_mut().unwrap` for HashMap or BTreeMap,
1899     // because they do not implement `IndexMut`
1900     let mut applicability = Applicability::MachineApplicable;
1901     let expr_ty = cx.tables.expr_ty(&get_args[0]);
1902     let get_args_str = if get_args.len() > 1 {
1903         snippet_with_applicability(cx, get_args[1].span, "_", &mut applicability)
1904     } else {
1905         return; // not linting on a .get().unwrap() chain or variant
1906     };
1907     let mut needs_ref;
1908     let caller_type = if derefs_to_slice(cx, &get_args[0], expr_ty).is_some() {
1909         needs_ref = get_args_str.parse::<usize>().is_ok();
1910         "slice"
1911     } else if is_type_diagnostic_item(cx, expr_ty, Symbol::intern("vec_type")) {
1912         needs_ref = get_args_str.parse::<usize>().is_ok();
1913         "Vec"
1914     } else if match_type(cx, expr_ty, &paths::VEC_DEQUE) {
1915         needs_ref = get_args_str.parse::<usize>().is_ok();
1916         "VecDeque"
1917     } else if !is_mut && match_type(cx, expr_ty, &paths::HASHMAP) {
1918         needs_ref = true;
1919         "HashMap"
1920     } else if !is_mut && match_type(cx, expr_ty, &paths::BTREEMAP) {
1921         needs_ref = true;
1922         "BTreeMap"
1923     } else {
1924         return; // caller is not a type that we want to lint
1925     };
1926
1927     let mut span = expr.span;
1928
1929     // Handle the case where the result is immediately dereferenced
1930     // by not requiring ref and pulling the dereference into the
1931     // suggestion.
1932     if_chain! {
1933         if needs_ref;
1934         if let Some(parent) = get_parent_expr(cx, expr);
1935         if let hir::ExprKind::Unary(hir::UnOp::UnDeref, _) = parent.node;
1936         then {
1937             needs_ref = false;
1938             span = parent.span;
1939         }
1940     }
1941
1942     let mut_str = if is_mut { "_mut" } else { "" };
1943     let borrow_str = if !needs_ref {
1944         ""
1945     } else if is_mut {
1946         "&mut "
1947     } else {
1948         "&"
1949     };
1950
1951     span_lint_and_sugg(
1952         cx,
1953         GET_UNWRAP,
1954         span,
1955         &format!(
1956             "called `.get{0}().unwrap()` on a {1}. Using `[]` is more clear and more concise",
1957             mut_str, caller_type
1958         ),
1959         "try this",
1960         format!(
1961             "{}{}[{}]",
1962             borrow_str,
1963             snippet_with_applicability(cx, get_args[0].span, "_", &mut applicability),
1964             get_args_str
1965         ),
1966         applicability,
1967     );
1968 }
1969
1970 fn lint_iter_skip_next(cx: &LateContext<'_, '_>, expr: &hir::Expr) {
1971     // lint if caller of skip is an Iterator
1972     if match_trait_method(cx, expr, &paths::ITERATOR) {
1973         span_lint(
1974             cx,
1975             ITER_SKIP_NEXT,
1976             expr.span,
1977             "called `skip(x).next()` on an iterator. This is more succinctly expressed by calling `nth(x)`",
1978         );
1979     }
1980 }
1981
1982 fn derefs_to_slice<'a, 'tcx>(
1983     cx: &LateContext<'a, 'tcx>,
1984     expr: &'tcx hir::Expr,
1985     ty: Ty<'tcx>,
1986 ) -> Option<&'tcx hir::Expr> {
1987     fn may_slice<'a>(cx: &LateContext<'_, 'a>, ty: Ty<'a>) -> bool {
1988         match ty.sty {
1989             ty::Slice(_) => true,
1990             ty::Adt(def, _) if def.is_box() => may_slice(cx, ty.boxed_ty()),
1991             ty::Adt(..) => is_type_diagnostic_item(cx, ty, Symbol::intern("vec_type")),
1992             ty::Array(_, size) => size.eval_usize(cx.tcx, cx.param_env) < 32,
1993             ty::Ref(_, inner, _) => may_slice(cx, inner),
1994             _ => false,
1995         }
1996     }
1997
1998     if let hir::ExprKind::MethodCall(ref path, _, ref args) = expr.node {
1999         if path.ident.name == sym!(iter) && may_slice(cx, cx.tables.expr_ty(&args[0])) {
2000             Some(&args[0])
2001         } else {
2002             None
2003         }
2004     } else {
2005         match ty.sty {
2006             ty::Slice(_) => Some(expr),
2007             ty::Adt(def, _) if def.is_box() && may_slice(cx, ty.boxed_ty()) => Some(expr),
2008             ty::Ref(_, inner, _) => {
2009                 if may_slice(cx, inner) {
2010                     Some(expr)
2011                 } else {
2012                     None
2013                 }
2014             },
2015             _ => None,
2016         }
2017     }
2018 }
2019
2020 /// lint use of `unwrap()` for `Option`s and `Result`s
2021 fn lint_unwrap(cx: &LateContext<'_, '_>, expr: &hir::Expr, unwrap_args: &[hir::Expr]) {
2022     let obj_ty = walk_ptrs_ty(cx.tables.expr_ty(&unwrap_args[0]));
2023
2024     let mess = if match_type(cx, obj_ty, &paths::OPTION) {
2025         Some((OPTION_UNWRAP_USED, "an Option", "None"))
2026     } else if match_type(cx, obj_ty, &paths::RESULT) {
2027         Some((RESULT_UNWRAP_USED, "a Result", "Err"))
2028     } else {
2029         None
2030     };
2031
2032     if let Some((lint, kind, none_value)) = mess {
2033         span_lint(
2034             cx,
2035             lint,
2036             expr.span,
2037             &format!(
2038                 "used unwrap() on {} value. If you don't want to handle the {} case gracefully, consider \
2039                  using expect() to provide a better panic \
2040                  message",
2041                 kind, none_value
2042             ),
2043         );
2044     }
2045 }
2046
2047 /// lint use of `ok().expect()` for `Result`s
2048 fn lint_ok_expect(cx: &LateContext<'_, '_>, expr: &hir::Expr, ok_args: &[hir::Expr]) {
2049     if_chain! {
2050         // lint if the caller of `ok()` is a `Result`
2051         if match_type(cx, cx.tables.expr_ty(&ok_args[0]), &paths::RESULT);
2052         let result_type = cx.tables.expr_ty(&ok_args[0]);
2053         if let Some(error_type) = get_error_type(cx, result_type);
2054         if has_debug_impl(error_type, cx);
2055
2056         then {
2057             span_lint(
2058                 cx,
2059                 OK_EXPECT,
2060                 expr.span,
2061                 "called `ok().expect()` on a Result value. You can call `expect` directly on the `Result`",
2062             );
2063         }
2064     }
2065 }
2066
2067 /// lint use of `map().flatten()` for `Iterators`
2068 fn lint_map_flatten<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, map_args: &'tcx [hir::Expr]) {
2069     // lint if caller of `.map().flatten()` is an Iterator
2070     if match_trait_method(cx, expr, &paths::ITERATOR) {
2071         let msg = "called `map(..).flatten()` on an `Iterator`. \
2072                    This is more succinctly expressed by calling `.flat_map(..)`";
2073         let self_snippet = snippet(cx, map_args[0].span, "..");
2074         let func_snippet = snippet(cx, map_args[1].span, "..");
2075         let hint = format!("{0}.flat_map({1})", self_snippet, func_snippet);
2076         span_lint_and_then(cx, MAP_FLATTEN, expr.span, msg, |db| {
2077             db.span_suggestion(
2078                 expr.span,
2079                 "try using flat_map instead",
2080                 hint,
2081                 Applicability::MachineApplicable,
2082             );
2083         });
2084     }
2085 }
2086
2087 /// lint use of `map().unwrap_or_else()` for `Option`s and `Result`s
2088 fn lint_map_unwrap_or_else<'a, 'tcx>(
2089     cx: &LateContext<'a, 'tcx>,
2090     expr: &'tcx hir::Expr,
2091     map_args: &'tcx [hir::Expr],
2092     unwrap_args: &'tcx [hir::Expr],
2093 ) {
2094     // lint if the caller of `map()` is an `Option`
2095     let is_option = match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::OPTION);
2096     let is_result = match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::RESULT);
2097
2098     if is_option || is_result {
2099         // Don't make a suggestion that may fail to compile due to mutably borrowing
2100         // the same variable twice.
2101         let map_mutated_vars = mutated_variables(&map_args[0], cx);
2102         let unwrap_mutated_vars = mutated_variables(&unwrap_args[1], cx);
2103         if let (Some(map_mutated_vars), Some(unwrap_mutated_vars)) = (map_mutated_vars, unwrap_mutated_vars) {
2104             if map_mutated_vars.intersection(&unwrap_mutated_vars).next().is_some() {
2105                 return;
2106             }
2107         } else {
2108             return;
2109         }
2110
2111         // lint message
2112         let msg = if is_option {
2113             "called `map(f).unwrap_or_else(g)` on an Option value. This can be done more directly by calling \
2114              `map_or_else(g, f)` instead"
2115         } else {
2116             "called `map(f).unwrap_or_else(g)` on a Result value. This can be done more directly by calling \
2117              `ok().map_or_else(g, f)` instead"
2118         };
2119         // get snippets for args to map() and unwrap_or_else()
2120         let map_snippet = snippet(cx, map_args[1].span, "..");
2121         let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
2122         // lint, with note if neither arg is > 1 line and both map() and
2123         // unwrap_or_else() have the same span
2124         let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
2125         let same_span = map_args[1].span.ctxt() == unwrap_args[1].span.ctxt();
2126         if same_span && !multiline {
2127             span_note_and_lint(
2128                 cx,
2129                 if is_option {
2130                     OPTION_MAP_UNWRAP_OR_ELSE
2131                 } else {
2132                     RESULT_MAP_UNWRAP_OR_ELSE
2133                 },
2134                 expr.span,
2135                 msg,
2136                 expr.span,
2137                 &format!(
2138                     "replace `map({0}).unwrap_or_else({1})` with `{2}map_or_else({1}, {0})`",
2139                     map_snippet,
2140                     unwrap_snippet,
2141                     if is_result { "ok()." } else { "" }
2142                 ),
2143             );
2144         } else if same_span && multiline {
2145             span_lint(
2146                 cx,
2147                 if is_option {
2148                     OPTION_MAP_UNWRAP_OR_ELSE
2149                 } else {
2150                     RESULT_MAP_UNWRAP_OR_ELSE
2151                 },
2152                 expr.span,
2153                 msg,
2154             );
2155         };
2156     }
2157 }
2158
2159 /// lint use of `_.map_or(None, _)` for `Option`s
2160 fn lint_map_or_none<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, map_or_args: &'tcx [hir::Expr]) {
2161     if match_type(cx, cx.tables.expr_ty(&map_or_args[0]), &paths::OPTION) {
2162         // check if the first non-self argument to map_or() is None
2163         let map_or_arg_is_none = if let hir::ExprKind::Path(ref qpath) = map_or_args[1].node {
2164             match_qpath(qpath, &paths::OPTION_NONE)
2165         } else {
2166             false
2167         };
2168
2169         if map_or_arg_is_none {
2170             // lint message
2171             let msg = "called `map_or(None, f)` on an Option value. This can be done more directly by calling \
2172                        `and_then(f)` instead";
2173             let map_or_self_snippet = snippet(cx, map_or_args[0].span, "..");
2174             let map_or_func_snippet = snippet(cx, map_or_args[2].span, "..");
2175             let hint = format!("{0}.and_then({1})", map_or_self_snippet, map_or_func_snippet);
2176             span_lint_and_then(cx, OPTION_MAP_OR_NONE, expr.span, msg, |db| {
2177                 db.span_suggestion(
2178                     expr.span,
2179                     "try using and_then instead",
2180                     hint,
2181                     Applicability::MachineApplicable, // snippet
2182                 );
2183             });
2184         }
2185     }
2186 }
2187
2188 /// Lint use of `_.and_then(|x| Some(y))` for `Option`s
2189 fn lint_option_and_then_some(cx: &LateContext<'_, '_>, expr: &hir::Expr, args: &[hir::Expr]) {
2190     const LINT_MSG: &str = "using `Option.and_then(|x| Some(y))`, which is more succinctly expressed as `map(|x| y)`";
2191     const NO_OP_MSG: &str = "using `Option.and_then(Some)`, which is a no-op";
2192
2193     let ty = cx.tables.expr_ty(&args[0]);
2194     if !match_type(cx, ty, &paths::OPTION) {
2195         return;
2196     }
2197
2198     match args[1].node {
2199         hir::ExprKind::Closure(_, _, body_id, closure_args_span, _) => {
2200             let closure_body = cx.tcx.hir().body(body_id);
2201             let closure_expr = remove_blocks(&closure_body.value);
2202             if_chain! {
2203                 if let hir::ExprKind::Call(ref some_expr, ref some_args) = closure_expr.node;
2204                 if let hir::ExprKind::Path(ref qpath) = some_expr.node;
2205                 if match_qpath(qpath, &paths::OPTION_SOME);
2206                 if some_args.len() == 1;
2207                 then {
2208                     let inner_expr = &some_args[0];
2209
2210                     if contains_return(inner_expr) {
2211                         return;
2212                     }
2213
2214                     let some_inner_snip = if inner_expr.span.from_expansion() {
2215                         snippet_with_macro_callsite(cx, inner_expr.span, "_")
2216                     } else {
2217                         snippet(cx, inner_expr.span, "_")
2218                     };
2219
2220                     let closure_args_snip = snippet(cx, closure_args_span, "..");
2221                     let option_snip = snippet(cx, args[0].span, "..");
2222                     let note = format!("{}.map({} {})", option_snip, closure_args_snip, some_inner_snip);
2223                     span_lint_and_sugg(
2224                         cx,
2225                         OPTION_AND_THEN_SOME,
2226                         expr.span,
2227                         LINT_MSG,
2228                         "try this",
2229                         note,
2230                         Applicability::MachineApplicable,
2231                     );
2232                 }
2233             }
2234         },
2235         // `_.and_then(Some)` case, which is no-op.
2236         hir::ExprKind::Path(ref qpath) => {
2237             if match_qpath(qpath, &paths::OPTION_SOME) {
2238                 let option_snip = snippet(cx, args[0].span, "..");
2239                 let note = format!("{}", option_snip);
2240                 span_lint_and_sugg(
2241                     cx,
2242                     OPTION_AND_THEN_SOME,
2243                     expr.span,
2244                     NO_OP_MSG,
2245                     "use the expression directly",
2246                     note,
2247                     Applicability::MachineApplicable,
2248                 );
2249             }
2250         },
2251         _ => {},
2252     }
2253 }
2254
2255 /// lint use of `filter().next()` for `Iterators`
2256 fn lint_filter_next<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, filter_args: &'tcx [hir::Expr]) {
2257     // lint if caller of `.filter().next()` is an Iterator
2258     if match_trait_method(cx, expr, &paths::ITERATOR) {
2259         let msg = "called `filter(p).next()` on an `Iterator`. This is more succinctly expressed by calling \
2260                    `.find(p)` instead.";
2261         let filter_snippet = snippet(cx, filter_args[1].span, "..");
2262         if filter_snippet.lines().count() <= 1 {
2263             // add note if not multi-line
2264             span_note_and_lint(
2265                 cx,
2266                 FILTER_NEXT,
2267                 expr.span,
2268                 msg,
2269                 expr.span,
2270                 &format!("replace `filter({0}).next()` with `find({0})`", filter_snippet),
2271             );
2272         } else {
2273             span_lint(cx, FILTER_NEXT, expr.span, msg);
2274         }
2275     }
2276 }
2277
2278 /// lint use of `filter().map()` for `Iterators`
2279 fn lint_filter_map<'a, 'tcx>(
2280     cx: &LateContext<'a, 'tcx>,
2281     expr: &'tcx hir::Expr,
2282     _filter_args: &'tcx [hir::Expr],
2283     _map_args: &'tcx [hir::Expr],
2284 ) {
2285     // lint if caller of `.filter().map()` is an Iterator
2286     if match_trait_method(cx, expr, &paths::ITERATOR) {
2287         let msg = "called `filter(p).map(q)` on an `Iterator`. \
2288                    This is more succinctly expressed by calling `.filter_map(..)` instead.";
2289         span_lint(cx, FILTER_MAP, expr.span, msg);
2290     }
2291 }
2292
2293 /// lint use of `filter_map().next()` for `Iterators`
2294 fn lint_filter_map_next<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr, filter_args: &'tcx [hir::Expr]) {
2295     if match_trait_method(cx, expr, &paths::ITERATOR) {
2296         let msg = "called `filter_map(p).next()` on an `Iterator`. This is more succinctly expressed by calling \
2297                    `.find_map(p)` instead.";
2298         let filter_snippet = snippet(cx, filter_args[1].span, "..");
2299         if filter_snippet.lines().count() <= 1 {
2300             span_note_and_lint(
2301                 cx,
2302                 FILTER_MAP_NEXT,
2303                 expr.span,
2304                 msg,
2305                 expr.span,
2306                 &format!("replace `filter_map({0}).next()` with `find_map({0})`", filter_snippet),
2307             );
2308         } else {
2309             span_lint(cx, FILTER_MAP_NEXT, expr.span, msg);
2310         }
2311     }
2312 }
2313
2314 /// lint use of `find().map()` for `Iterators`
2315 fn lint_find_map<'a, 'tcx>(
2316     cx: &LateContext<'a, 'tcx>,
2317     expr: &'tcx hir::Expr,
2318     _find_args: &'tcx [hir::Expr],
2319     map_args: &'tcx [hir::Expr],
2320 ) {
2321     // lint if caller of `.filter().map()` is an Iterator
2322     if match_trait_method(cx, &map_args[0], &paths::ITERATOR) {
2323         let msg = "called `find(p).map(q)` on an `Iterator`. \
2324                    This is more succinctly expressed by calling `.find_map(..)` instead.";
2325         span_lint(cx, FIND_MAP, expr.span, msg);
2326     }
2327 }
2328
2329 /// lint use of `filter().map()` for `Iterators`
2330 fn lint_filter_map_map<'a, 'tcx>(
2331     cx: &LateContext<'a, 'tcx>,
2332     expr: &'tcx hir::Expr,
2333     _filter_args: &'tcx [hir::Expr],
2334     _map_args: &'tcx [hir::Expr],
2335 ) {
2336     // lint if caller of `.filter().map()` is an Iterator
2337     if match_trait_method(cx, expr, &paths::ITERATOR) {
2338         let msg = "called `filter_map(p).map(q)` on an `Iterator`. \
2339                    This is more succinctly expressed by only calling `.filter_map(..)` instead.";
2340         span_lint(cx, FILTER_MAP, expr.span, msg);
2341     }
2342 }
2343
2344 /// lint use of `filter().flat_map()` for `Iterators`
2345 fn lint_filter_flat_map<'a, 'tcx>(
2346     cx: &LateContext<'a, 'tcx>,
2347     expr: &'tcx hir::Expr,
2348     _filter_args: &'tcx [hir::Expr],
2349     _map_args: &'tcx [hir::Expr],
2350 ) {
2351     // lint if caller of `.filter().flat_map()` is an Iterator
2352     if match_trait_method(cx, expr, &paths::ITERATOR) {
2353         let msg = "called `filter(p).flat_map(q)` on an `Iterator`. \
2354                    This is more succinctly expressed by calling `.flat_map(..)` \
2355                    and filtering by returning an empty Iterator.";
2356         span_lint(cx, FILTER_MAP, expr.span, msg);
2357     }
2358 }
2359
2360 /// lint use of `filter_map().flat_map()` for `Iterators`
2361 fn lint_filter_map_flat_map<'a, 'tcx>(
2362     cx: &LateContext<'a, 'tcx>,
2363     expr: &'tcx hir::Expr,
2364     _filter_args: &'tcx [hir::Expr],
2365     _map_args: &'tcx [hir::Expr],
2366 ) {
2367     // lint if caller of `.filter_map().flat_map()` is an Iterator
2368     if match_trait_method(cx, expr, &paths::ITERATOR) {
2369         let msg = "called `filter_map(p).flat_map(q)` on an `Iterator`. \
2370                    This is more succinctly expressed by calling `.flat_map(..)` \
2371                    and filtering by returning an empty Iterator.";
2372         span_lint(cx, FILTER_MAP, expr.span, msg);
2373     }
2374 }
2375
2376 /// lint use of `flat_map` for `Iterators` where `flatten` would be sufficient
2377 fn lint_flat_map_identity<'a, 'tcx>(
2378     cx: &LateContext<'a, 'tcx>,
2379     expr: &'tcx hir::Expr,
2380     flat_map_args: &'tcx [hir::Expr],
2381     flat_map_span: Span,
2382 ) {
2383     if match_trait_method(cx, expr, &paths::ITERATOR) {
2384         let arg_node = &flat_map_args[1].node;
2385
2386         let apply_lint = |message: &str| {
2387             span_lint_and_sugg(
2388                 cx,
2389                 FLAT_MAP_IDENTITY,
2390                 flat_map_span.with_hi(expr.span.hi()),
2391                 message,
2392                 "try",
2393                 "flatten()".to_string(),
2394                 Applicability::MachineApplicable,
2395             );
2396         };
2397
2398         if_chain! {
2399             if let hir::ExprKind::Closure(_, _, body_id, _, _) = arg_node;
2400             let body = cx.tcx.hir().body(*body_id);
2401
2402             if let hir::PatKind::Binding(_, _, binding_ident, _) = body.params[0].pat.node;
2403             if let hir::ExprKind::Path(hir::QPath::Resolved(_, ref path)) = body.value.node;
2404
2405             if path.segments.len() == 1;
2406             if path.segments[0].ident.as_str() == binding_ident.as_str();
2407
2408             then {
2409                 apply_lint("called `flat_map(|x| x)` on an `Iterator`");
2410             }
2411         }
2412
2413         if_chain! {
2414             if let hir::ExprKind::Path(ref qpath) = arg_node;
2415
2416             if match_qpath(qpath, &paths::STD_CONVERT_IDENTITY);
2417
2418             then {
2419                 apply_lint("called `flat_map(std::convert::identity)` on an `Iterator`");
2420             }
2421         }
2422     }
2423 }
2424
2425 /// lint searching an Iterator followed by `is_some()`
2426 fn lint_search_is_some<'a, 'tcx>(
2427     cx: &LateContext<'a, 'tcx>,
2428     expr: &'tcx hir::Expr,
2429     search_method: &str,
2430     search_args: &'tcx [hir::Expr],
2431     is_some_args: &'tcx [hir::Expr],
2432     method_span: Span,
2433 ) {
2434     // lint if caller of search is an Iterator
2435     if match_trait_method(cx, &is_some_args[0], &paths::ITERATOR) {
2436         let msg = format!(
2437             "called `is_some()` after searching an `Iterator` with {}. This is more succinctly \
2438              expressed by calling `any()`.",
2439             search_method
2440         );
2441         let search_snippet = snippet(cx, search_args[1].span, "..");
2442         if search_snippet.lines().count() <= 1 {
2443             // suggest `any(|x| ..)` instead of `any(|&x| ..)` for `find(|&x| ..).is_some()`
2444             // suggest `any(|..| *..)` instead of `any(|..| **..)` for `find(|..| **..).is_some()`
2445             let any_search_snippet = if_chain! {
2446                 if search_method == "find";
2447                 if let hir::ExprKind::Closure(_, _, body_id, ..) = search_args[1].node;
2448                 let closure_body = cx.tcx.hir().body(body_id);
2449                 if let Some(closure_arg) = closure_body.params.get(0);
2450                 then {
2451                     if let hir::PatKind::Ref(..) = closure_arg.pat.node {
2452                         Some(search_snippet.replacen('&', "", 1))
2453                     } else if let Some(name) = get_arg_name(&closure_arg.pat) {
2454                         Some(search_snippet.replace(&format!("*{}", name), &name.as_str()))
2455                     } else {
2456                         None
2457                     }
2458                 } else {
2459                     None
2460                 }
2461             };
2462             // add note if not multi-line
2463             span_lint_and_sugg(
2464                 cx,
2465                 SEARCH_IS_SOME,
2466                 method_span.with_hi(expr.span.hi()),
2467                 &msg,
2468                 "try this",
2469                 format!(
2470                     "any({})",
2471                     any_search_snippet.as_ref().map_or(&*search_snippet, String::as_str)
2472                 ),
2473                 Applicability::MachineApplicable,
2474             );
2475         } else {
2476             span_lint(cx, SEARCH_IS_SOME, expr.span, &msg);
2477         }
2478     }
2479 }
2480
2481 /// Used for `lint_binary_expr_with_method_call`.
2482 #[derive(Copy, Clone)]
2483 struct BinaryExprInfo<'a> {
2484     expr: &'a hir::Expr,
2485     chain: &'a hir::Expr,
2486     other: &'a hir::Expr,
2487     eq: bool,
2488 }
2489
2490 /// Checks for the `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints.
2491 fn lint_binary_expr_with_method_call(cx: &LateContext<'_, '_>, info: &mut BinaryExprInfo<'_>) {
2492     macro_rules! lint_with_both_lhs_and_rhs {
2493         ($func:ident, $cx:expr, $info:ident) => {
2494             if !$func($cx, $info) {
2495                 ::std::mem::swap(&mut $info.chain, &mut $info.other);
2496                 if $func($cx, $info) {
2497                     return;
2498                 }
2499             }
2500         };
2501     }
2502
2503     lint_with_both_lhs_and_rhs!(lint_chars_next_cmp, cx, info);
2504     lint_with_both_lhs_and_rhs!(lint_chars_last_cmp, cx, info);
2505     lint_with_both_lhs_and_rhs!(lint_chars_next_cmp_with_unwrap, cx, info);
2506     lint_with_both_lhs_and_rhs!(lint_chars_last_cmp_with_unwrap, cx, info);
2507 }
2508
2509 /// Wrapper fn for `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints.
2510 fn lint_chars_cmp(
2511     cx: &LateContext<'_, '_>,
2512     info: &BinaryExprInfo<'_>,
2513     chain_methods: &[&str],
2514     lint: &'static Lint,
2515     suggest: &str,
2516 ) -> bool {
2517     if_chain! {
2518         if let Some(args) = method_chain_args(info.chain, chain_methods);
2519         if let hir::ExprKind::Call(ref fun, ref arg_char) = info.other.node;
2520         if arg_char.len() == 1;
2521         if let hir::ExprKind::Path(ref qpath) = fun.node;
2522         if let Some(segment) = single_segment_path(qpath);
2523         if segment.ident.name == sym!(Some);
2524         then {
2525             let mut applicability = Applicability::MachineApplicable;
2526             let self_ty = walk_ptrs_ty(cx.tables.expr_ty_adjusted(&args[0][0]));
2527
2528             if self_ty.sty != ty::Str {
2529                 return false;
2530             }
2531
2532             span_lint_and_sugg(
2533                 cx,
2534                 lint,
2535                 info.expr.span,
2536                 &format!("you should use the `{}` method", suggest),
2537                 "like this",
2538                 format!("{}{}.{}({})",
2539                         if info.eq { "" } else { "!" },
2540                         snippet_with_applicability(cx, args[0][0].span, "_", &mut applicability),
2541                         suggest,
2542                         snippet_with_applicability(cx, arg_char[0].span, "_", &mut applicability)),
2543                 applicability,
2544             );
2545
2546             return true;
2547         }
2548     }
2549
2550     false
2551 }
2552
2553 /// Checks for the `CHARS_NEXT_CMP` lint.
2554 fn lint_chars_next_cmp<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2555     lint_chars_cmp(cx, info, &["chars", "next"], CHARS_NEXT_CMP, "starts_with")
2556 }
2557
2558 /// Checks for the `CHARS_LAST_CMP` lint.
2559 fn lint_chars_last_cmp<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2560     if lint_chars_cmp(cx, info, &["chars", "last"], CHARS_LAST_CMP, "ends_with") {
2561         true
2562     } else {
2563         lint_chars_cmp(cx, info, &["chars", "next_back"], CHARS_LAST_CMP, "ends_with")
2564     }
2565 }
2566
2567 /// Wrapper fn for `CHARS_NEXT_CMP` and `CHARS_LAST_CMP` lints with `unwrap()`.
2568 fn lint_chars_cmp_with_unwrap<'a, 'tcx>(
2569     cx: &LateContext<'a, 'tcx>,
2570     info: &BinaryExprInfo<'_>,
2571     chain_methods: &[&str],
2572     lint: &'static Lint,
2573     suggest: &str,
2574 ) -> bool {
2575     if_chain! {
2576         if let Some(args) = method_chain_args(info.chain, chain_methods);
2577         if let hir::ExprKind::Lit(ref lit) = info.other.node;
2578         if let ast::LitKind::Char(c) = lit.node;
2579         then {
2580             let mut applicability = Applicability::MachineApplicable;
2581             span_lint_and_sugg(
2582                 cx,
2583                 lint,
2584                 info.expr.span,
2585                 &format!("you should use the `{}` method", suggest),
2586                 "like this",
2587                 format!("{}{}.{}('{}')",
2588                         if info.eq { "" } else { "!" },
2589                         snippet_with_applicability(cx, args[0][0].span, "_", &mut applicability),
2590                         suggest,
2591                         c),
2592                 applicability,
2593             );
2594
2595             true
2596         } else {
2597             false
2598         }
2599     }
2600 }
2601
2602 /// Checks for the `CHARS_NEXT_CMP` lint with `unwrap()`.
2603 fn lint_chars_next_cmp_with_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2604     lint_chars_cmp_with_unwrap(cx, info, &["chars", "next", "unwrap"], CHARS_NEXT_CMP, "starts_with")
2605 }
2606
2607 /// Checks for the `CHARS_LAST_CMP` lint with `unwrap()`.
2608 fn lint_chars_last_cmp_with_unwrap<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, info: &BinaryExprInfo<'_>) -> bool {
2609     if lint_chars_cmp_with_unwrap(cx, info, &["chars", "last", "unwrap"], CHARS_LAST_CMP, "ends_with") {
2610         true
2611     } else {
2612         lint_chars_cmp_with_unwrap(cx, info, &["chars", "next_back", "unwrap"], CHARS_LAST_CMP, "ends_with")
2613     }
2614 }
2615
2616 /// lint for length-1 `str`s for methods in `PATTERN_METHODS`
2617 fn lint_single_char_pattern<'a, 'tcx>(cx: &LateContext<'a, 'tcx>, _expr: &'tcx hir::Expr, arg: &'tcx hir::Expr) {
2618     if_chain! {
2619         if let hir::ExprKind::Lit(lit) = &arg.node;
2620         if let ast::LitKind::Str(r, style) = lit.node;
2621         if r.as_str().len() == 1;
2622         then {
2623             let mut applicability = Applicability::MachineApplicable;
2624             let snip = snippet_with_applicability(cx, arg.span, "..", &mut applicability);
2625             let ch = if let ast::StrStyle::Raw(nhash) = style {
2626                 let nhash = nhash as usize;
2627                 // for raw string: r##"a"##
2628                 &snip[(nhash + 2)..(snip.len() - 1 - nhash)]
2629             } else {
2630                 // for regular string: "a"
2631                 &snip[1..(snip.len() - 1)]
2632             };
2633             let hint = format!("'{}'", if ch == "'" { "\\'" } else { ch });
2634             span_lint_and_sugg(
2635                 cx,
2636                 SINGLE_CHAR_PATTERN,
2637                 arg.span,
2638                 "single-character string constant used as pattern",
2639                 "try using a char instead",
2640                 hint,
2641                 applicability,
2642             );
2643         }
2644     }
2645 }
2646
2647 /// Checks for the `USELESS_ASREF` lint.
2648 fn lint_asref(cx: &LateContext<'_, '_>, expr: &hir::Expr, call_name: &str, as_ref_args: &[hir::Expr]) {
2649     // when we get here, we've already checked that the call name is "as_ref" or "as_mut"
2650     // check if the call is to the actual `AsRef` or `AsMut` trait
2651     if match_trait_method(cx, expr, &paths::ASREF_TRAIT) || match_trait_method(cx, expr, &paths::ASMUT_TRAIT) {
2652         // check if the type after `as_ref` or `as_mut` is the same as before
2653         let recvr = &as_ref_args[0];
2654         let rcv_ty = cx.tables.expr_ty(recvr);
2655         let res_ty = cx.tables.expr_ty(expr);
2656         let (base_res_ty, res_depth) = walk_ptrs_ty_depth(res_ty);
2657         let (base_rcv_ty, rcv_depth) = walk_ptrs_ty_depth(rcv_ty);
2658         if base_rcv_ty == base_res_ty && rcv_depth >= res_depth {
2659             // allow the `as_ref` or `as_mut` if it is followed by another method call
2660             if_chain! {
2661                 if let Some(parent) = get_parent_expr(cx, expr);
2662                 if let hir::ExprKind::MethodCall(_, ref span, _) = parent.node;
2663                 if span != &expr.span;
2664                 then {
2665                     return;
2666                 }
2667             }
2668
2669             let mut applicability = Applicability::MachineApplicable;
2670             span_lint_and_sugg(
2671                 cx,
2672                 USELESS_ASREF,
2673                 expr.span,
2674                 &format!("this call to `{}` does nothing", call_name),
2675                 "try this",
2676                 snippet_with_applicability(cx, recvr.span, "_", &mut applicability).to_string(),
2677                 applicability,
2678             );
2679         }
2680     }
2681 }
2682
2683 fn ty_has_iter_method(
2684     cx: &LateContext<'_, '_>,
2685     self_ref_ty: Ty<'_>,
2686 ) -> Option<(&'static Lint, &'static str, &'static str)> {
2687     has_iter_method(cx, self_ref_ty).map(|ty_name| {
2688         let lint = if ty_name == "array" || ty_name == "PathBuf" {
2689             INTO_ITER_ON_ARRAY
2690         } else {
2691             INTO_ITER_ON_REF
2692         };
2693         let mutbl = match self_ref_ty.sty {
2694             ty::Ref(_, _, mutbl) => mutbl,
2695             _ => unreachable!(),
2696         };
2697         let method_name = match mutbl {
2698             hir::MutImmutable => "iter",
2699             hir::MutMutable => "iter_mut",
2700         };
2701         (lint, ty_name, method_name)
2702     })
2703 }
2704
2705 fn lint_into_iter(cx: &LateContext<'_, '_>, expr: &hir::Expr, self_ref_ty: Ty<'_>, method_span: Span) {
2706     if !match_trait_method(cx, expr, &paths::INTO_ITERATOR) {
2707         return;
2708     }
2709     if let Some((lint, kind, method_name)) = ty_has_iter_method(cx, self_ref_ty) {
2710         span_lint_and_sugg(
2711             cx,
2712             lint,
2713             method_span,
2714             &format!(
2715                 "this .into_iter() call is equivalent to .{}() and will not move the {}",
2716                 method_name, kind,
2717             ),
2718             "call directly",
2719             method_name.to_string(),
2720             Applicability::MachineApplicable,
2721         );
2722     }
2723 }
2724
2725 /// lint for `MaybeUninit::uninit().assume_init()` (we already have the latter)
2726 fn lint_maybe_uninit(cx: &LateContext<'_, '_>, expr: &hir::Expr, outer: &hir::Expr) {
2727     if_chain! {
2728         if let hir::ExprKind::Call(ref callee, ref args) = expr.node;
2729         if args.is_empty();
2730         if let hir::ExprKind::Path(ref path) = callee.node;
2731         if match_qpath(path, &paths::MEM_MAYBEUNINIT_UNINIT);
2732         if !is_maybe_uninit_ty_valid(cx, cx.tables.expr_ty_adjusted(outer));
2733         then {
2734             span_lint(
2735                 cx,
2736                 UNINIT_ASSUMED_INIT,
2737                 outer.span,
2738                 "this call for this type may be undefined behavior"
2739             );
2740         }
2741     }
2742 }
2743
2744 fn is_maybe_uninit_ty_valid(cx: &LateContext<'_, '_>, ty: Ty<'_>) -> bool {
2745     match ty.sty {
2746         ty::Array(ref component, _) => is_maybe_uninit_ty_valid(cx, component),
2747         ty::Tuple(ref types) => types.types().all(|ty| is_maybe_uninit_ty_valid(cx, ty)),
2748         ty::Adt(ref adt, _) => {
2749             // needs to be a MaybeUninit
2750             match_def_path(cx, adt.did, &paths::MEM_MAYBEUNINIT)
2751         },
2752         _ => false,
2753     }
2754 }
2755
2756 fn lint_suspicious_map(cx: &LateContext<'_, '_>, expr: &hir::Expr) {
2757     span_help_and_lint(
2758         cx,
2759         SUSPICIOUS_MAP,
2760         expr.span,
2761         "this call to `map()` won't have an effect on the call to `count()`",
2762         "make sure you did not confuse `map` with `filter`",
2763     );
2764 }
2765
2766 /// Given a `Result<T, E>` type, return its error type (`E`).
2767 fn get_error_type<'a>(cx: &LateContext<'_, '_>, ty: Ty<'a>) -> Option<Ty<'a>> {
2768     match ty.sty {
2769         ty::Adt(_, substs) if match_type(cx, ty, &paths::RESULT) => substs.types().nth(1),
2770         _ => None,
2771     }
2772 }
2773
2774 /// This checks whether a given type is known to implement Debug.
2775 fn has_debug_impl<'a, 'b>(ty: Ty<'a>, cx: &LateContext<'b, 'a>) -> bool {
2776     cx.tcx
2777         .get_diagnostic_item(sym::debug_trait)
2778         .map_or(false, |debug| implements_trait(cx, ty, debug, &[]))
2779 }
2780
2781 enum Convention {
2782     Eq(&'static str),
2783     StartsWith(&'static str),
2784 }
2785
2786 #[rustfmt::skip]
2787 const CONVENTIONS: [(Convention, &[SelfKind]); 7] = [
2788     (Convention::Eq("new"), &[SelfKind::No]),
2789     (Convention::StartsWith("as_"), &[SelfKind::Ref, SelfKind::RefMut]),
2790     (Convention::StartsWith("from_"), &[SelfKind::No]),
2791     (Convention::StartsWith("into_"), &[SelfKind::Value]),
2792     (Convention::StartsWith("is_"), &[SelfKind::Ref, SelfKind::No]),
2793     (Convention::Eq("to_mut"), &[SelfKind::RefMut]),
2794     (Convention::StartsWith("to_"), &[SelfKind::Ref]),
2795 ];
2796
2797 #[rustfmt::skip]
2798 const TRAIT_METHODS: [(&str, usize, SelfKind, OutType, &str); 30] = [
2799     ("add", 2, SelfKind::Value, OutType::Any, "std::ops::Add"),
2800     ("as_mut", 1, SelfKind::RefMut, OutType::Ref, "std::convert::AsMut"),
2801     ("as_ref", 1, SelfKind::Ref, OutType::Ref, "std::convert::AsRef"),
2802     ("bitand", 2, SelfKind::Value, OutType::Any, "std::ops::BitAnd"),
2803     ("bitor", 2, SelfKind::Value, OutType::Any, "std::ops::BitOr"),
2804     ("bitxor", 2, SelfKind::Value, OutType::Any, "std::ops::BitXor"),
2805     ("borrow", 1, SelfKind::Ref, OutType::Ref, "std::borrow::Borrow"),
2806     ("borrow_mut", 1, SelfKind::RefMut, OutType::Ref, "std::borrow::BorrowMut"),
2807     ("clone", 1, SelfKind::Ref, OutType::Any, "std::clone::Clone"),
2808     ("cmp", 2, SelfKind::Ref, OutType::Any, "std::cmp::Ord"),
2809     ("default", 0, SelfKind::No, OutType::Any, "std::default::Default"),
2810     ("deref", 1, SelfKind::Ref, OutType::Ref, "std::ops::Deref"),
2811     ("deref_mut", 1, SelfKind::RefMut, OutType::Ref, "std::ops::DerefMut"),
2812     ("div", 2, SelfKind::Value, OutType::Any, "std::ops::Div"),
2813     ("drop", 1, SelfKind::RefMut, OutType::Unit, "std::ops::Drop"),
2814     ("eq", 2, SelfKind::Ref, OutType::Bool, "std::cmp::PartialEq"),
2815     ("from_iter", 1, SelfKind::No, OutType::Any, "std::iter::FromIterator"),
2816     ("from_str", 1, SelfKind::No, OutType::Any, "std::str::FromStr"),
2817     ("hash", 2, SelfKind::Ref, OutType::Unit, "std::hash::Hash"),
2818     ("index", 2, SelfKind::Ref, OutType::Ref, "std::ops::Index"),
2819     ("index_mut", 2, SelfKind::RefMut, OutType::Ref, "std::ops::IndexMut"),
2820     ("into_iter", 1, SelfKind::Value, OutType::Any, "std::iter::IntoIterator"),
2821     ("mul", 2, SelfKind::Value, OutType::Any, "std::ops::Mul"),
2822     ("neg", 1, SelfKind::Value, OutType::Any, "std::ops::Neg"),
2823     ("next", 1, SelfKind::RefMut, OutType::Any, "std::iter::Iterator"),
2824     ("not", 1, SelfKind::Value, OutType::Any, "std::ops::Not"),
2825     ("rem", 2, SelfKind::Value, OutType::Any, "std::ops::Rem"),
2826     ("shl", 2, SelfKind::Value, OutType::Any, "std::ops::Shl"),
2827     ("shr", 2, SelfKind::Value, OutType::Any, "std::ops::Shr"),
2828     ("sub", 2, SelfKind::Value, OutType::Any, "std::ops::Sub"),
2829 ];
2830
2831 #[rustfmt::skip]
2832 const PATTERN_METHODS: [(&str, usize); 17] = [
2833     ("contains", 1),
2834     ("starts_with", 1),
2835     ("ends_with", 1),
2836     ("find", 1),
2837     ("rfind", 1),
2838     ("split", 1),
2839     ("rsplit", 1),
2840     ("split_terminator", 1),
2841     ("rsplit_terminator", 1),
2842     ("splitn", 2),
2843     ("rsplitn", 2),
2844     ("matches", 1),
2845     ("rmatches", 1),
2846     ("match_indices", 1),
2847     ("rmatch_indices", 1),
2848     ("trim_start_matches", 1),
2849     ("trim_end_matches", 1),
2850 ];
2851
2852 #[derive(Clone, Copy, PartialEq, Debug)]
2853 enum SelfKind {
2854     Value,
2855     Ref,
2856     RefMut,
2857     No,
2858 }
2859
2860 impl SelfKind {
2861     fn matches<'a>(self, cx: &LateContext<'_, 'a>, parent_ty: Ty<'a>, ty: Ty<'a>) -> bool {
2862         fn matches_value(parent_ty: Ty<'_>, ty: Ty<'_>) -> bool {
2863             if ty == parent_ty {
2864                 true
2865             } else if ty.is_box() {
2866                 ty.boxed_ty() == parent_ty
2867             } else if ty.is_rc() || ty.is_arc() {
2868                 if let ty::Adt(_, substs) = ty.sty {
2869                     substs.types().next().map_or(false, |t| t == parent_ty)
2870                 } else {
2871                     false
2872                 }
2873             } else {
2874                 false
2875             }
2876         }
2877
2878         fn matches_ref<'a>(
2879             cx: &LateContext<'_, 'a>,
2880             mutability: hir::Mutability,
2881             parent_ty: Ty<'a>,
2882             ty: Ty<'a>,
2883         ) -> bool {
2884             if let ty::Ref(_, t, m) = ty.sty {
2885                 return m == mutability && t == parent_ty;
2886             }
2887
2888             let trait_path = match mutability {
2889                 hir::Mutability::MutImmutable => &paths::ASREF_TRAIT,
2890                 hir::Mutability::MutMutable => &paths::ASMUT_TRAIT,
2891             };
2892
2893             let trait_def_id = match get_trait_def_id(cx, trait_path) {
2894                 Some(did) => did,
2895                 None => return false,
2896             };
2897             implements_trait(cx, ty, trait_def_id, &[parent_ty.into()])
2898         }
2899
2900         match self {
2901             Self::Value => matches_value(parent_ty, ty),
2902             Self::Ref => {
2903                 matches_ref(cx, hir::Mutability::MutImmutable, parent_ty, ty) || ty == parent_ty && is_copy(cx, ty)
2904             },
2905             Self::RefMut => matches_ref(cx, hir::Mutability::MutMutable, parent_ty, ty),
2906             Self::No => ty != parent_ty,
2907         }
2908     }
2909
2910     fn description(self) -> &'static str {
2911         match self {
2912             Self::Value => "self by value",
2913             Self::Ref => "self by reference",
2914             Self::RefMut => "self by mutable reference",
2915             Self::No => "no self",
2916         }
2917     }
2918 }
2919
2920 impl Convention {
2921     fn check(&self, other: &str) -> bool {
2922         match *self {
2923             Self::Eq(this) => this == other,
2924             Self::StartsWith(this) => other.starts_with(this) && this != other,
2925         }
2926     }
2927 }
2928
2929 impl fmt::Display for Convention {
2930     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> Result<(), fmt::Error> {
2931         match *self {
2932             Self::Eq(this) => this.fmt(f),
2933             Self::StartsWith(this) => this.fmt(f).and_then(|_| '*'.fmt(f)),
2934         }
2935     }
2936 }
2937
2938 #[derive(Clone, Copy)]
2939 enum OutType {
2940     Unit,
2941     Bool,
2942     Any,
2943     Ref,
2944 }
2945
2946 impl OutType {
2947     fn matches(self, cx: &LateContext<'_, '_>, ty: &hir::FunctionRetTy) -> bool {
2948         let is_unit = |ty: &hir::Ty| SpanlessEq::new(cx).eq_ty_kind(&ty.node, &hir::TyKind::Tup(vec![].into()));
2949         match (self, ty) {
2950             (Self::Unit, &hir::DefaultReturn(_)) => true,
2951             (Self::Unit, &hir::Return(ref ty)) if is_unit(ty) => true,
2952             (Self::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
2953             (Self::Any, &hir::Return(ref ty)) if !is_unit(ty) => true,
2954             (Self::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyKind::Rptr(_, _)),
2955             _ => false,
2956         }
2957     }
2958 }
2959
2960 fn is_bool(ty: &hir::Ty) -> bool {
2961     if let hir::TyKind::Path(ref p) = ty.node {
2962         match_qpath(p, &["bool"])
2963     } else {
2964         false
2965     }
2966 }
2967
2968 // Returns `true` if `expr` contains a return expression
2969 fn contains_return(expr: &hir::Expr) -> bool {
2970     struct RetCallFinder {
2971         found: bool,
2972     }
2973
2974     impl<'tcx> intravisit::Visitor<'tcx> for RetCallFinder {
2975         fn visit_expr(&mut self, expr: &'tcx hir::Expr) {
2976             if self.found {
2977                 return;
2978             }
2979             if let hir::ExprKind::Ret(..) = &expr.node {
2980                 self.found = true;
2981             } else {
2982                 intravisit::walk_expr(self, expr);
2983             }
2984         }
2985
2986         fn nested_visit_map<'this>(&'this mut self) -> intravisit::NestedVisitorMap<'this, 'tcx> {
2987             intravisit::NestedVisitorMap::None
2988         }
2989     }
2990
2991     let mut visitor = RetCallFinder{ found: false };
2992     visitor.visit_expr(expr);
2993     visitor.found
2994 }