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