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