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