clippy_lints/src/methods/mod.rs

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