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