clippy_lints/src/methods/mod.rs

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