clippy_lints/src/methods/mod.rs

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