clippy_lints/src/methods/mod.rs

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