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