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