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