3 use rustc::middle::const_val::ConstVal;
5 use rustc::hir::def::Def;
6 use rustc_const_eval::EvalHint::ExprTypeChecked;
7 use rustc_const_eval::ConstContext;
10 use syntax::codemap::Span;
11 use utils::{get_trait_def_id, implements_trait, in_external_macro, in_macro, is_copy, match_path, match_trait_method,
12 match_type, method_chain_args, return_ty, same_tys, snippet, span_lint, span_lint_and_then,
13 span_note_and_lint, walk_ptrs_ty, walk_ptrs_ty_depth, last_path_segment, single_segment_path,
14 match_def_path, is_self, is_self_ty, iter_input_pats};
21 /// **What it does:** Checks for `.unwrap()` calls on `Option`s.
23 /// **Why is this bad?** Usually it is better to handle the `None` case, or to
24 /// at least call `.expect(_)` with a more helpful message. Still, for a lot of
25 /// quick-and-dirty code, `unwrap` is a good choice, which is why this lint is
26 /// `Allow` by default.
28 /// **Known problems:** None.
35 pub OPTION_UNWRAP_USED,
37 "using `Option.unwrap()`, which should at least get a better message using `expect()`"
40 /// **What it does:** Checks for `.unwrap()` calls on `Result`s.
42 /// **Why is this bad?** `result.unwrap()` will let the thread panic on `Err`
43 /// values. Normally, you want to implement more sophisticated error handling,
44 /// and propagate errors upwards with `try!`.
46 /// Even if you want to panic on errors, not all `Error`s implement good
47 /// messages on display. Therefore it may be beneficial to look at the places
48 /// where they may get displayed. Activate this lint to do just that.
50 /// **Known problems:** None.
57 pub RESULT_UNWRAP_USED,
59 "using `Result.unwrap()`, which might be better handled"
62 /// **What it does:** Checks for methods that should live in a trait
63 /// implementation of a `std` trait (see [llogiq's blog
64 /// post](http://llogiq.github.io/2015/07/30/traits.html) for further
65 /// information) instead of an inherent implementation.
67 /// **Why is this bad?** Implementing the traits improve ergonomics for users of
68 /// the code, often with very little cost. Also people seeing a `mul(...)` method
69 /// may expect `*` to work equally, so you should have good reason to disappoint
72 /// **Known problems:** None.
78 /// fn add(&self, other: &X) -> X { .. }
82 pub SHOULD_IMPLEMENT_TRAIT,
84 "defining a method that should be implementing a std trait"
87 /// **What it does:** Checks for methods with certain name prefixes and which
88 /// doesn't match how self is taken. The actual rules are:
90 /// |Prefix |`self` taken |
91 /// |-------|----------------------|
92 /// |`as_` |`&self` or `&mut self`|
95 /// |`is_` |`&self` or none |
98 /// **Why is this bad?** Consistency breeds readability. If you follow the
99 /// conventions, your users won't be surprised that they, e.g., need to supply a
100 /// mutable reference to a `as_..` function.
102 /// **Known problems:** None.
107 /// fn as_str(self) -> &str { .. }
111 pub WRONG_SELF_CONVENTION,
113 "defining a method named with an established prefix (like \"into_\") that takes \
114 `self` with the wrong convention"
117 /// **What it does:** This is the same as
118 /// [`wrong_self_convention`](#wrong_self_convention), but for public items.
120 /// **Why is this bad?** See [`wrong_self_convention`](#wrong_self_convention).
122 /// **Known problems:** Actually *renaming* the function may break clients if
123 /// the function is part of the public interface. In that case, be mindful of
124 /// the stability guarantees you've given your users.
129 /// pub fn as_str(self) -> &str { .. }
133 pub WRONG_PUB_SELF_CONVENTION,
135 "defining a public method named with an established prefix (like \"into_\") that takes \
136 `self` with the wrong convention"
139 /// **What it does:** Checks for usage of `ok().expect(..)`.
141 /// **Why is this bad?** Because you usually call `expect()` on the `Result`
142 /// directly to get a better error message.
144 /// **Known problems:** None.
148 /// x.ok().expect("why did I do this again?")
153 "using `ok().expect()`, which gives worse error messages than \
154 calling `expect` directly on the Result"
157 /// **What it does:** Checks for usage of `_.map(_).unwrap_or(_)`.
159 /// **Why is this bad?** Readability, this can be written more concisely as
160 /// `_.map_or(_, _)`.
162 /// **Known problems:** None.
166 /// x.map(|a| a + 1).unwrap_or(0)
169 pub OPTION_MAP_UNWRAP_OR,
171 "using `Option.map(f).unwrap_or(a)`, which is more succinctly expressed as \
175 /// **What it does:** Checks for usage of `_.map(_).unwrap_or_else(_)`.
177 /// **Why is this bad?** Readability, this can be written more concisely as
178 /// `_.map_or_else(_, _)`.
180 /// **Known problems:** None.
184 /// x.map(|a| a + 1).unwrap_or_else(some_function)
187 pub OPTION_MAP_UNWRAP_OR_ELSE,
189 "using `Option.map(f).unwrap_or_else(g)`, which is more succinctly expressed as \
193 /// **What it does:** Checks for usage of `_.filter(_).next()`.
195 /// **Why is this bad?** Readability, this can be written more concisely as
198 /// **Known problems:** None.
202 /// iter.filter(|x| x == 0).next()
207 "using `filter(p).next()`, which is more succinctly expressed as `.find(p)`"
210 /// **What it does:** Checks for usage of `_.filter(_).map(_)`,
211 /// `_.filter(_).flat_map(_)`, `_.filter_map(_).flat_map(_)` and similar.
213 /// **Why is this bad?** Readability, this can be written more concisely as a
214 /// single method call.
216 /// **Known problems:** Often requires a condition + Option/Iterator creation
217 /// inside the closure.
221 /// iter.filter(|x| x == 0).map(|x| x * 2)
226 "using combinations of `filter`, `map`, `filter_map` and `flat_map` which can \
227 usually be written as a single method call"
230 /// **What it does:** Checks for an iterator search (such as `find()`,
231 /// `position()`, or `rposition()`) followed by a call to `is_some()`.
233 /// **Why is this bad?** Readability, this can be written more concisely as
236 /// **Known problems:** None.
240 /// iter.find(|x| x == 0).is_some()
245 "using an iterator search followed by `is_some()`, which is more succinctly \
246 expressed as a call to `any()`"
249 /// **What it does:** Checks for usage of `.chars().next()` on a `str` to check
250 /// if it starts with a given char.
252 /// **Why is this bad?** Readability, this can be written more concisely as
253 /// `_.starts_with(_)`.
255 /// **Known problems:** None.
259 /// name.chars().next() == Some('_')
264 "using `.chars().next()` to check if a string starts with a char"
267 /// **What it does:** Checks for calls to `.or(foo(..))`, `.unwrap_or(foo(..))`,
268 /// etc., and suggests to use `or_else`, `unwrap_or_else`, etc., or
269 /// `unwrap_or_default` instead.
271 /// **Why is this bad?** The function will always be called and potentially
272 /// allocate an object acting as the default.
274 /// **Known problems:** If the function has side-effects, not calling it will
275 /// change the semantic of the program, but you shouldn't rely on that anyway.
279 /// foo.unwrap_or(String::new())
281 /// this can instead be written:
283 /// foo.unwrap_or_else(String::new)
287 /// foo.unwrap_or_default()
292 "using any `*or` method with a function call, which suggests `*or_else`"
295 /// **What it does:** Checks for usage of `.clone()` on a `Copy` type.
297 /// **Why is this bad?** The only reason `Copy` types implement `Clone` is for
298 /// generics, not for using the `clone` method on a concrete type.
300 /// **Known problems:** None.
309 "using `clone` on a `Copy` type"
312 /// **What it does:** Checks for usage of `.clone()` on an `&&T`.
314 /// **Why is this bad?** Cloning an `&&T` copies the inner `&T`, instead of
315 /// cloning the underlying `T`.
317 /// **Known problems:** None.
324 /// let z = y.clone();
325 /// println!("{:p} {:p}",*y, z); // prints out the same pointer
329 pub CLONE_DOUBLE_REF,
331 "using `clone` on `&&T`"
334 /// **What it does:** Checks for `new` not returning `Self`.
336 /// **Why is this bad?** As a convention, `new` methods are used to make a new
337 /// instance of a type.
339 /// **Known problems:** None.
344 /// fn new(..) -> NotAFoo {
351 "not returning `Self` in a `new` method"
354 /// **What it does:** Checks for string methods that receive a single-character
355 /// `str` as an argument, e.g. `_.split("x")`.
357 /// **Why is this bad?** Performing these methods using a `char` is faster than
360 /// **Known problems:** Does not catch multi-byte unicode characters.
363 /// `_.split("x")` could be `_.split('x')
365 pub SINGLE_CHAR_PATTERN,
367 "using a single-character str where a char could be used, e.g. \
371 /// **What it does:** Checks for getting the inner pointer of a temporary `CString`.
373 /// **Why is this bad?** The inner pointer of a `CString` is only valid as long
374 /// as the `CString` is alive.
376 /// **Known problems:** None.
380 /// let c_str = CString::new("foo").unwrap().as_ptr();
382 /// call_some_ffi_func(c_str);
385 /// Here `c_str` point to a freed address. The correct use would be:
387 /// let c_str = CString::new("foo").unwrap();
389 /// call_some_ffi_func(c_str.as_ptr());
393 pub TEMPORARY_CSTRING_AS_PTR,
395 "getting the inner pointer of a temporary `CString`"
398 /// **What it does:** Checks for use of `.iter().nth()` (and the related
399 /// `.iter_mut().nth()`) on standard library types with O(1) element access.
401 /// **Why is this bad?** `.get()` and `.get_mut()` are more efficient and more
404 /// **Known problems:** None.
408 /// let some_vec = vec![0, 1, 2, 3];
409 /// let bad_vec = some_vec.iter().nth(3);
410 /// let bad_slice = &some_vec[..].iter().nth(3);
412 /// The correct use would be:
414 /// let some_vec = vec![0, 1, 2, 3];
415 /// let bad_vec = some_vec.get(3);
416 /// let bad_slice = &some_vec[..].get(3);
421 "using `.iter().nth()` on a standard library type with O(1) element access"
424 /// **What it does:** Checks for use of `.skip(x).next()` on iterators.
426 /// **Why is this bad?** `.nth(x)` is cleaner
428 /// **Known problems:** None.
432 /// let some_vec = vec![0, 1, 2, 3];
433 /// let bad_vec = some_vec.iter().skip(3).next();
434 /// let bad_slice = &some_vec[..].iter().skip(3).next();
436 /// The correct use would be:
438 /// let some_vec = vec![0, 1, 2, 3];
439 /// let bad_vec = some_vec.iter().nth(3);
440 /// let bad_slice = &some_vec[..].iter().nth(3);
445 "using `.skip(x).next()` on an iterator"
448 /// **What it does:** Checks for use of `.get().unwrap()` (or
449 /// `.get_mut().unwrap`) on a standard library type which implements `Index`
451 /// **Why is this bad?** Using the Index trait (`[]`) is more clear and more
454 /// **Known problems:** None.
458 /// let some_vec = vec![0, 1, 2, 3];
459 /// let last = some_vec.get(3).unwrap();
460 /// *some_vec.get_mut(0).unwrap() = 1;
462 /// The correct use would be:
464 /// let some_vec = vec![0, 1, 2, 3];
465 /// let last = some_vec[3];
471 "using `.get().unwrap()` or `.get_mut().unwrap()` when using `[]` would work instead"
474 /// **What it does:** Checks for the use of `.extend(s.chars())` where s is a
475 /// `&str` or `String`.
477 /// **Why is this bad?** `.push_str(s)` is clearer
479 /// **Known problems:** None.
484 /// let def = String::from("def");
485 /// let mut s = String::new();
486 /// s.extend(abc.chars());
487 /// s.extend(def.chars());
489 /// The correct use would be:
492 /// let def = String::from("def");
493 /// let mut s = String::new();
495 /// s.push_str(&def));
498 pub STRING_EXTEND_CHARS,
500 "using `x.extend(s.chars())` where s is a `&str` or `String`"
503 /// **What it does:** Checks for the use of `.cloned().collect()` on slice to create a `Vec`.
505 /// **Why is this bad?** `.to_vec()` is clearer
507 /// **Known problems:** None.
511 /// let s = [1,2,3,4,5];
512 /// let s2 : Vec<isize> = s[..].iter().cloned().collect();
514 /// The better use would be:
516 /// let s = [1,2,3,4,5];
517 /// let s2 : Vec<isize> = s.to_vec();
520 pub ITER_CLONED_COLLECT,
522 "using `.cloned().collect()` on slice to create a `Vec`"
525 impl LintPass for Pass {
526 fn get_lints(&self) -> LintArray {
527 lint_array!(OPTION_UNWRAP_USED,
529 SHOULD_IMPLEMENT_TRAIT,
530 WRONG_SELF_CONVENTION,
531 WRONG_PUB_SELF_CONVENTION,
533 OPTION_MAP_UNWRAP_OR,
534 OPTION_MAP_UNWRAP_OR_ELSE,
542 TEMPORARY_CSTRING_AS_PTR,
553 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for Pass {
554 #[allow(unused_attributes)]
555 // ^ required because `cyclomatic_complexity` attribute shows up as unused
556 #[cyclomatic_complexity = "30"]
557 fn check_expr(&mut self, cx: &LateContext<'a, 'tcx>, expr: &'tcx hir::Expr) {
558 if in_macro(cx, expr.span) {
563 hir::ExprMethodCall(name, _, ref args) => {
565 // GET_UNWRAP needs to be checked before general `UNWRAP` lints
566 if let Some(arglists) = method_chain_args(expr, &["get", "unwrap"]) {
567 lint_get_unwrap(cx, expr, arglists[0], false);
568 } else if let Some(arglists) = method_chain_args(expr, &["get_mut", "unwrap"]) {
569 lint_get_unwrap(cx, expr, arglists[0], true);
570 } else if let Some(arglists) = method_chain_args(expr, &["unwrap"]) {
571 lint_unwrap(cx, expr, arglists[0]);
572 } else if let Some(arglists) = method_chain_args(expr, &["ok", "expect"]) {
573 lint_ok_expect(cx, expr, arglists[0]);
574 } else if let Some(arglists) = method_chain_args(expr, &["map", "unwrap_or"]) {
575 lint_map_unwrap_or(cx, expr, arglists[0], arglists[1]);
576 } else if let Some(arglists) = method_chain_args(expr, &["map", "unwrap_or_else"]) {
577 lint_map_unwrap_or_else(cx, expr, arglists[0], arglists[1]);
578 } else if let Some(arglists) = method_chain_args(expr, &["filter", "next"]) {
579 lint_filter_next(cx, expr, arglists[0]);
580 } else if let Some(arglists) = method_chain_args(expr, &["filter", "map"]) {
581 lint_filter_map(cx, expr, arglists[0], arglists[1]);
582 } else if let Some(arglists) = method_chain_args(expr, &["filter_map", "map"]) {
583 lint_filter_map_map(cx, expr, arglists[0], arglists[1]);
584 } else if let Some(arglists) = method_chain_args(expr, &["filter", "flat_map"]) {
585 lint_filter_flat_map(cx, expr, arglists[0], arglists[1]);
586 } else if let Some(arglists) = method_chain_args(expr, &["filter_map", "flat_map"]) {
587 lint_filter_map_flat_map(cx, expr, arglists[0], arglists[1]);
588 } else if let Some(arglists) = method_chain_args(expr, &["find", "is_some"]) {
589 lint_search_is_some(cx, expr, "find", arglists[0], arglists[1]);
590 } else if let Some(arglists) = method_chain_args(expr, &["position", "is_some"]) {
591 lint_search_is_some(cx, expr, "position", arglists[0], arglists[1]);
592 } else if let Some(arglists) = method_chain_args(expr, &["rposition", "is_some"]) {
593 lint_search_is_some(cx, expr, "rposition", arglists[0], arglists[1]);
594 } else if let Some(arglists) = method_chain_args(expr, &["extend"]) {
595 lint_extend(cx, expr, arglists[0]);
596 } else if let Some(arglists) = method_chain_args(expr, &["unwrap", "as_ptr"]) {
597 lint_cstring_as_ptr(cx, expr, &arglists[0][0], &arglists[1][0]);
598 } else if let Some(arglists) = method_chain_args(expr, &["iter", "nth"]) {
599 lint_iter_nth(cx, expr, arglists[0], false);
600 } else if let Some(arglists) = method_chain_args(expr, &["iter_mut", "nth"]) {
601 lint_iter_nth(cx, expr, arglists[0], true);
602 } else if method_chain_args(expr, &["skip", "next"]).is_some() {
603 lint_iter_skip_next(cx, expr);
604 } else if let Some(arglists) = method_chain_args(expr, &["cloned", "collect"]) {
605 lint_iter_cloned_collect(cx, expr, arglists[0]);
608 lint_or_fun_call(cx, expr, &name.node.as_str(), args);
610 let self_ty = cx.tables.expr_ty_adjusted(&args[0]);
611 if args.len() == 1 && &*name.node.as_str() == "clone" {
612 lint_clone_on_copy(cx, expr, &args[0], self_ty);
616 ty::TyRef(_, ty) if ty.ty.sty == ty::TyStr => {
617 for &(method, pos) in &PATTERN_METHODS {
618 if &*name.node.as_str() == method && args.len() > pos {
619 lint_single_char_pattern(cx, expr, &args[pos]);
626 hir::ExprBinary(op, ref lhs, ref rhs) if op.node == hir::BiEq || op.node == hir::BiNe => {
627 if !lint_chars_next(cx, expr, lhs, rhs, op.node == hir::BiEq) {
628 lint_chars_next(cx, expr, rhs, lhs, op.node == hir::BiEq);
635 fn check_impl_item(&mut self, cx: &LateContext<'a, 'tcx>, implitem: &'tcx hir::ImplItem) {
636 if in_external_macro(cx, implitem.span) {
639 let name = implitem.name;
640 let parent = cx.tcx.hir.get_parent(implitem.id);
641 let item = cx.tcx.hir.expect_item(parent);
643 let hir::ImplItemKind::Method(ref sig, id) = implitem.node,
644 let Some(first_arg_ty) = sig.decl.inputs.get(0),
645 let Some(first_arg) = iter_input_pats(&sig.decl, cx.tcx.hir.body(id)).next(),
646 let hir::ItemImpl(_, _, _, None, ref self_ty, _) = item.node,
648 // check missing trait implementations
649 for &(method_name, n_args, self_kind, out_type, trait_name) in &TRAIT_METHODS {
650 if &*name.as_str() == method_name &&
651 sig.decl.inputs.len() == n_args &&
652 out_type.matches(&sig.decl.output) &&
653 self_kind.matches(&first_arg_ty, &first_arg, &self_ty, false) {
654 span_lint(cx, SHOULD_IMPLEMENT_TRAIT, implitem.span, &format!(
655 "defining a method called `{}` on this type; consider implementing \
656 the `{}` trait or choosing a less ambiguous name", name, trait_name));
660 // check conventions w.r.t. conversion method names and predicates
661 let ty = cx.tcx.item_type(cx.tcx.hir.local_def_id(item.id));
662 let is_copy = is_copy(cx, ty, item.id);
663 for &(ref conv, self_kinds) in &CONVENTIONS {
665 conv.check(&name.as_str()),
666 !self_kinds.iter().any(|k| k.matches(&first_arg_ty, &first_arg, &self_ty, is_copy)),
668 let lint = if item.vis == hir::Visibility::Public {
669 WRONG_PUB_SELF_CONVENTION
671 WRONG_SELF_CONVENTION
676 &format!("methods called `{}` usually take {}; consider choosing a less \
680 .map(|k| k.description())
686 let ret_ty = return_ty(cx, implitem.id);
687 if &*name.as_str() == "new" &&
688 !ret_ty.walk().any(|t| same_tys(cx, t, ty, implitem.id)) {
692 "methods called `new` usually return `Self`");
698 /// Checks for the `OR_FUN_CALL` lint.
699 fn lint_or_fun_call(cx: &LateContext, expr: &hir::Expr, name: &str, args: &[hir::Expr]) {
700 /// Check for `unwrap_or(T::new())` or `unwrap_or(T::default())`.
701 fn check_unwrap_or_default(
705 self_expr: &hir::Expr,
714 if name == "unwrap_or" {
715 if let hir::ExprPath(ref qpath) = fun.node {
716 let path: &str = &*last_path_segment(qpath).name.as_str();
718 if ["default", "new"].contains(&path) {
719 let arg_ty = cx.tables.expr_ty(arg);
720 let default_trait_id = if let Some(default_trait_id) =
721 get_trait_def_id(cx, &paths::DEFAULT_TRAIT) {
727 if implements_trait(cx, arg_ty, default_trait_id, Vec::new()) {
728 span_lint_and_then(cx,
731 &format!("use of `{}` followed by a call to `{}`", name, path),
733 db.span_suggestion(span,
735 format!("{}.unwrap_or_default()", snippet(cx, self_expr.span, "_")));
746 /// Check for `*or(foo())`.
747 fn check_general_case(
751 self_expr: &hir::Expr,
756 // don't lint for constant values
757 // FIXME: can we `expect` here instead of match?
758 let promotable = cx.tcx
759 .rvalue_promotable_to_static
768 // (path, fn_has_argument, methods, suffix)
769 let know_types: &[(&[_], _, &[_], _)] =
770 &[(&paths::BTREEMAP_ENTRY, false, &["or_insert"], "with"),
771 (&paths::HASHMAP_ENTRY, false, &["or_insert"], "with"),
772 (&paths::OPTION, false, &["map_or", "ok_or", "or", "unwrap_or"], "else"),
773 (&paths::RESULT, true, &["or", "unwrap_or"], "else")];
775 let self_ty = cx.tables.expr_ty(self_expr);
777 let (fn_has_arguments, poss, suffix) = if let Some(&(_, fn_has_arguments, poss, suffix)) =
778 know_types.iter().find(|&&i| match_type(cx, self_ty, i.0)) {
779 (fn_has_arguments, poss, suffix)
784 if !poss.contains(&name) {
788 let sugg: Cow<_> = match (fn_has_arguments, !or_has_args) {
789 (true, _) => format!("|_| {}", snippet(cx, arg.span, "..")).into(),
790 (false, false) => format!("|| {}", snippet(cx, arg.span, "..")).into(),
791 (false, true) => snippet(cx, fun_span, ".."),
794 span_lint_and_then(cx,
797 &format!("use of `{}` followed by a function call", name),
799 db.span_suggestion(span,
801 format!("{}.{}_{}({})", snippet(cx, self_expr.span, "_"), name, suffix, sugg));
807 hir::ExprCall(ref fun, ref or_args) => {
808 let or_has_args = !or_args.is_empty();
809 if !check_unwrap_or_default(cx, name, fun, &args[0], &args[1], or_has_args, expr.span) {
810 check_general_case(cx, name, fun.span, &args[0], &args[1], or_has_args, expr.span);
813 hir::ExprMethodCall(fun, _, ref or_args) => {
814 check_general_case(cx, name, fun.span, &args[0], &args[1], !or_args.is_empty(), expr.span)
821 /// Checks for the `CLONE_ON_COPY` lint.
822 fn lint_clone_on_copy(cx: &LateContext, expr: &hir::Expr, arg: &hir::Expr, arg_ty: ty::Ty) {
823 let ty = cx.tables.expr_ty(expr);
824 let parent = cx.tcx.hir.get_parent(expr.id);
825 let parameter_environment = ty::ParameterEnvironment::for_item(cx.tcx, parent);
826 if let ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) = arg_ty.sty {
827 if let ty::TyRef(..) = inner.sty {
828 span_lint_and_then(cx,
831 "using `clone` on a double-reference; \
832 this will copy the reference instead of cloning the inner type",
833 |db| if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
834 db.span_suggestion(expr.span,
835 "try dereferencing it",
836 format!("({}).clone()", snip.deref()));
838 return; // don't report clone_on_copy
842 if !ty.moves_by_default(cx.tcx.global_tcx(), ¶meter_environment, expr.span) {
843 span_lint_and_then(cx,
846 "using `clone` on a `Copy` type",
847 |db| if let Some(snip) = sugg::Sugg::hir_opt(cx, arg) {
848 if let ty::TyRef(..) = cx.tables.expr_ty(arg).sty {
849 db.span_suggestion(expr.span, "try dereferencing it", format!("{}", snip.deref()));
851 db.span_suggestion(expr.span, "try removing the `clone` call", format!("{}", snip));
857 fn lint_string_extend(cx: &LateContext, expr: &hir::Expr, args: &[hir::Expr]) {
859 if let Some(arglists) = method_chain_args(arg, &["chars"]) {
860 let target = &arglists[0][0];
861 let (self_ty, _) = walk_ptrs_ty_depth(cx.tables.expr_ty(target));
862 let ref_str = if self_ty.sty == ty::TyStr {
864 } else if match_type(cx, self_ty, &paths::STRING) {
870 span_lint_and_then(cx, STRING_EXTEND_CHARS, expr.span, "calling `.extend(_.chars())`", |db| {
871 db.span_suggestion(expr.span,
873 format!("{}.push_str({}{})",
874 snippet(cx, args[0].span, "_"),
876 snippet(cx, target.span, "_")));
881 fn lint_extend(cx: &LateContext, expr: &hir::Expr, args: &[hir::Expr]) {
882 let (obj_ty, _) = walk_ptrs_ty_depth(cx.tables.expr_ty(&args[0]));
883 if match_type(cx, obj_ty, &paths::STRING) {
884 lint_string_extend(cx, expr, args);
888 fn lint_cstring_as_ptr(cx: &LateContext, expr: &hir::Expr, new: &hir::Expr, unwrap: &hir::Expr) {
890 let hir::ExprCall(ref fun, ref args) = new.node,
892 let hir::ExprPath(ref path) = fun.node,
893 let Def::Method(did) = cx.tables.qpath_def(path, fun.id),
894 match_def_path(cx.tcx, did, &paths::CSTRING_NEW)
896 span_lint_and_then(cx, TEMPORARY_CSTRING_AS_PTR, expr.span,
897 "you are getting the inner pointer of a temporary `CString`",
899 db.note("that pointer will be invalid outside this expression");
900 db.span_help(unwrap.span, "assign the `CString` to a variable to extend its lifetime");
905 fn lint_iter_cloned_collect(cx: &LateContext, expr: &hir::Expr, iter_args: &[hir::Expr]) {
906 if match_type(cx, cx.tables.expr_ty(expr), &paths::VEC) &&
907 derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0])).is_some() {
911 "called `cloned().collect()` on a slice to create a `Vec`. Calling `to_vec()` is both faster and more readable");
915 fn lint_iter_nth(cx: &LateContext, expr: &hir::Expr, iter_args: &[hir::Expr], is_mut: bool) {
916 let mut_str = if is_mut { "_mut" } else { "" };
917 let caller_type = if derefs_to_slice(cx, &iter_args[0], cx.tables.expr_ty(&iter_args[0])).is_some() {
919 } else if match_type(cx, cx.tables.expr_ty(&iter_args[0]), &paths::VEC) {
921 } else if match_type(cx, cx.tables.expr_ty(&iter_args[0]), &paths::VEC_DEQUE) {
924 return; // caller is not a type that we want to lint
930 &format!("called `.iter{0}().nth()` on a {1}. Calling `.get{0}()` is both faster and more readable",
935 fn lint_get_unwrap(cx: &LateContext, expr: &hir::Expr, get_args: &[hir::Expr], is_mut: bool) {
936 // Note: we don't want to lint `get_mut().unwrap` for HashMap or BTreeMap,
937 // because they do not implement `IndexMut`
938 let expr_ty = cx.tables.expr_ty(&get_args[0]);
939 let caller_type = if derefs_to_slice(cx, &get_args[0], expr_ty).is_some() {
941 } else if match_type(cx, expr_ty, &paths::VEC) {
943 } else if match_type(cx, expr_ty, &paths::VEC_DEQUE) {
945 } else if !is_mut && match_type(cx, expr_ty, &paths::HASHMAP) {
947 } else if !is_mut && match_type(cx, expr_ty, &paths::BTREEMAP) {
950 return; // caller is not a type that we want to lint
953 let mut_str = if is_mut { "_mut" } else { "" };
954 let borrow_str = if is_mut { "&mut " } else { "&" };
955 span_lint_and_then(cx,
958 &format!("called `.get{0}().unwrap()` on a {1}. Using `[]` is more clear and more concise",
962 db.span_suggestion(expr.span,
966 snippet(cx, get_args[0].span, "_"),
967 snippet(cx, get_args[1].span, "_")));
971 fn lint_iter_skip_next(cx: &LateContext, expr: &hir::Expr) {
972 // lint if caller of skip is an Iterator
973 if match_trait_method(cx, expr, &paths::ITERATOR) {
977 "called `skip(x).next()` on an iterator. This is more succinctly expressed by calling `nth(x)`");
981 fn derefs_to_slice(cx: &LateContext, expr: &hir::Expr, ty: ty::Ty) -> Option<sugg::Sugg<'static>> {
982 fn may_slice(cx: &LateContext, ty: ty::Ty) -> bool {
984 ty::TySlice(_) => true,
985 ty::TyAdt(def, _) if def.is_box() => may_slice(cx, ty.boxed_ty()),
986 ty::TyAdt(..) => match_type(cx, ty, &paths::VEC),
987 ty::TyArray(_, size) => size < 32,
988 ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) => may_slice(cx, inner),
993 if let hir::ExprMethodCall(name, _, ref args) = expr.node {
994 if &*name.node.as_str() == "iter" && may_slice(cx, cx.tables.expr_ty(&args[0])) {
995 sugg::Sugg::hir_opt(cx, &args[0]).map(|sugg| sugg.addr())
1001 ty::TySlice(_) => sugg::Sugg::hir_opt(cx, expr),
1002 ty::TyAdt(def, _) if def.is_box() && may_slice(cx, ty.boxed_ty()) => sugg::Sugg::hir_opt(cx, expr),
1003 ty::TyRef(_, ty::TypeAndMut { ty: inner, .. }) => {
1004 if may_slice(cx, inner) {
1005 sugg::Sugg::hir_opt(cx, expr)
1015 /// lint use of `unwrap()` for `Option`s and `Result`s
1016 fn lint_unwrap(cx: &LateContext, expr: &hir::Expr, unwrap_args: &[hir::Expr]) {
1017 let (obj_ty, _) = walk_ptrs_ty_depth(cx.tables.expr_ty(&unwrap_args[0]));
1019 let mess = if match_type(cx, obj_ty, &paths::OPTION) {
1020 Some((OPTION_UNWRAP_USED, "an Option", "None"))
1021 } else if match_type(cx, obj_ty, &paths::RESULT) {
1022 Some((RESULT_UNWRAP_USED, "a Result", "Err"))
1027 if let Some((lint, kind, none_value)) = mess {
1031 &format!("used unwrap() on {} value. If you don't want to handle the {} case gracefully, consider \
1032 using expect() to provide a better panic \
1039 /// lint use of `ok().expect()` for `Result`s
1040 fn lint_ok_expect(cx: &LateContext, expr: &hir::Expr, ok_args: &[hir::Expr]) {
1041 // lint if the caller of `ok()` is a `Result`
1042 if match_type(cx, cx.tables.expr_ty(&ok_args[0]), &paths::RESULT) {
1043 let result_type = cx.tables.expr_ty(&ok_args[0]);
1044 if let Some(error_type) = get_error_type(cx, result_type) {
1045 if has_debug_impl(error_type, cx) {
1049 "called `ok().expect()` on a Result value. You can call `expect` directly on the `Result`");
1055 /// lint use of `map().unwrap_or()` for `Option`s
1056 fn lint_map_unwrap_or(cx: &LateContext, expr: &hir::Expr, map_args: &[hir::Expr], unwrap_args: &[hir::Expr]) {
1057 // lint if the caller of `map()` is an `Option`
1058 if match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::OPTION) {
1060 let msg = "called `map(f).unwrap_or(a)` on an Option value. This can be done more directly by calling \
1061 `map_or(a, f)` instead";
1062 // get snippets for args to map() and unwrap_or()
1063 let map_snippet = snippet(cx, map_args[1].span, "..");
1064 let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
1065 // lint, with note if neither arg is > 1 line and both map() and
1066 // unwrap_or() have the same span
1067 let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
1068 let same_span = map_args[1].span.expn_id == unwrap_args[1].span.expn_id;
1069 if same_span && !multiline {
1070 span_note_and_lint(cx,
1071 OPTION_MAP_UNWRAP_OR,
1075 &format!("replace `map({0}).unwrap_or({1})` with `map_or({1}, {0})`",
1078 } else if same_span && multiline {
1079 span_lint(cx, OPTION_MAP_UNWRAP_OR, expr.span, msg);
1084 /// lint use of `map().unwrap_or_else()` for `Option`s
1085 fn lint_map_unwrap_or_else(cx: &LateContext, expr: &hir::Expr, map_args: &[hir::Expr], unwrap_args: &[hir::Expr]) {
1086 // lint if the caller of `map()` is an `Option`
1087 if match_type(cx, cx.tables.expr_ty(&map_args[0]), &paths::OPTION) {
1089 let msg = "called `map(f).unwrap_or_else(g)` on an Option value. This can be done more directly by calling \
1090 `map_or_else(g, f)` instead";
1091 // get snippets for args to map() and unwrap_or_else()
1092 let map_snippet = snippet(cx, map_args[1].span, "..");
1093 let unwrap_snippet = snippet(cx, unwrap_args[1].span, "..");
1094 // lint, with note if neither arg is > 1 line and both map() and
1095 // unwrap_or_else() have the same span
1096 let multiline = map_snippet.lines().count() > 1 || unwrap_snippet.lines().count() > 1;
1097 let same_span = map_args[1].span.expn_id == unwrap_args[1].span.expn_id;
1098 if same_span && !multiline {
1099 span_note_and_lint(cx,
1100 OPTION_MAP_UNWRAP_OR_ELSE,
1104 &format!("replace `map({0}).unwrap_or_else({1})` with `with map_or_else({1}, {0})`",
1107 } else if same_span && multiline {
1108 span_lint(cx, OPTION_MAP_UNWRAP_OR_ELSE, expr.span, msg);
1113 /// lint use of `filter().next()` for `Iterators`
1114 fn lint_filter_next(cx: &LateContext, expr: &hir::Expr, filter_args: &[hir::Expr]) {
1115 // lint if caller of `.filter().next()` is an Iterator
1116 if match_trait_method(cx, expr, &paths::ITERATOR) {
1117 let msg = "called `filter(p).next()` on an `Iterator`. This is more succinctly expressed by calling \
1118 `.find(p)` instead.";
1119 let filter_snippet = snippet(cx, filter_args[1].span, "..");
1120 if filter_snippet.lines().count() <= 1 {
1121 // add note if not multi-line
1122 span_note_and_lint(cx,
1127 &format!("replace `filter({0}).next()` with `find({0})`", filter_snippet));
1129 span_lint(cx, FILTER_NEXT, expr.span, msg);
1134 /// lint use of `filter().map()` for `Iterators`
1135 fn lint_filter_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &[hir::Expr], _map_args: &[hir::Expr]) {
1136 // lint if caller of `.filter().map()` is an Iterator
1137 if match_trait_method(cx, expr, &paths::ITERATOR) {
1138 let msg = "called `filter(p).map(q)` on an `Iterator`. \
1139 This is more succinctly expressed by calling `.filter_map(..)` instead.";
1140 span_lint(cx, FILTER_MAP, expr.span, msg);
1144 /// lint use of `filter().map()` for `Iterators`
1145 fn lint_filter_map_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &[hir::Expr], _map_args: &[hir::Expr]) {
1146 // lint if caller of `.filter().map()` is an Iterator
1147 if match_trait_method(cx, expr, &paths::ITERATOR) {
1148 let msg = "called `filter_map(p).map(q)` on an `Iterator`. \
1149 This is more succinctly expressed by only calling `.filter_map(..)` instead.";
1150 span_lint(cx, FILTER_MAP, expr.span, msg);
1154 /// lint use of `filter().flat_map()` for `Iterators`
1155 fn lint_filter_flat_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &[hir::Expr], _map_args: &[hir::Expr]) {
1156 // lint if caller of `.filter().flat_map()` is an Iterator
1157 if match_trait_method(cx, expr, &paths::ITERATOR) {
1158 let msg = "called `filter(p).flat_map(q)` on an `Iterator`. \
1159 This is more succinctly expressed by calling `.flat_map(..)` \
1160 and filtering by returning an empty Iterator.";
1161 span_lint(cx, FILTER_MAP, expr.span, msg);
1165 /// lint use of `filter_map().flat_map()` for `Iterators`
1166 fn lint_filter_map_flat_map(cx: &LateContext, expr: &hir::Expr, _filter_args: &[hir::Expr], _map_args: &[hir::Expr]) {
1167 // lint if caller of `.filter_map().flat_map()` is an Iterator
1168 if match_trait_method(cx, expr, &paths::ITERATOR) {
1169 let msg = "called `filter_map(p).flat_map(q)` on an `Iterator`. \
1170 This is more succinctly expressed by calling `.flat_map(..)` \
1171 and filtering by returning an empty Iterator.";
1172 span_lint(cx, FILTER_MAP, expr.span, msg);
1176 /// lint searching an Iterator followed by `is_some()`
1177 fn lint_search_is_some(
1180 search_method: &str,
1181 search_args: &[hir::Expr],
1182 is_some_args: &[hir::Expr]
1184 // lint if caller of search is an Iterator
1185 if match_trait_method(cx, &is_some_args[0], &paths::ITERATOR) {
1186 let msg = format!("called `is_some()` after searching an `Iterator` with {}. This is more succinctly \
1187 expressed by calling `any()`.",
1189 let search_snippet = snippet(cx, search_args[1].span, "..");
1190 if search_snippet.lines().count() <= 1 {
1191 // add note if not multi-line
1192 span_note_and_lint(cx,
1197 &format!("replace `{0}({1}).is_some()` with `any({1})`", search_method, search_snippet));
1199 span_lint(cx, SEARCH_IS_SOME, expr.span, &msg);
1204 /// Checks for the `CHARS_NEXT_CMP` lint.
1205 fn lint_chars_next(cx: &LateContext, expr: &hir::Expr, chain: &hir::Expr, other: &hir::Expr, eq: bool) -> bool {
1207 let Some(args) = method_chain_args(chain, &["chars", "next"]),
1208 let hir::ExprCall(ref fun, ref arg_char) = other.node,
1209 arg_char.len() == 1,
1210 let hir::ExprPath(ref qpath) = fun.node,
1211 let Some(segment) = single_segment_path(qpath),
1212 &*segment.name.as_str() == "Some"
1214 let self_ty = walk_ptrs_ty(cx.tables.expr_ty_adjusted(&args[0][0]));
1216 if self_ty.sty != ty::TyStr {
1220 span_lint_and_then(cx,
1223 "you should use the `starts_with` method",
1225 let sugg = format!("{}{}.starts_with({})",
1226 if eq { "" } else { "!" },
1227 snippet(cx, args[0][0].span, "_"),
1228 snippet(cx, arg_char[0].span, "_")
1231 db.span_suggestion(expr.span, "like this", sugg);
1240 /// lint for length-1 `str`s for methods in `PATTERN_METHODS`
1241 fn lint_single_char_pattern(cx: &LateContext, expr: &hir::Expr, arg: &hir::Expr) {
1242 if let Ok(ConstVal::Str(r)) = ConstContext::with_tables(cx.tcx, cx.tables).eval(arg, ExprTypeChecked) {
1244 let hint = snippet(cx, expr.span, "..").replace(&format!("\"{}\"", r), &format!("'{}'", r));
1245 span_lint_and_then(cx,
1246 SINGLE_CHAR_PATTERN,
1248 "single-character string constant used as pattern",
1249 |db| { db.span_suggestion(expr.span, "try using a char instead:", hint); });
1254 /// Given a `Result<T, E>` type, return its error type (`E`).
1255 fn get_error_type<'a>(cx: &LateContext, ty: ty::Ty<'a>) -> Option<ty::Ty<'a>> {
1256 if let ty::TyAdt(_, substs) = ty.sty {
1257 if match_type(cx, ty, &paths::RESULT) {
1258 substs.types().nth(1)
1267 /// This checks whether a given type is known to implement Debug.
1268 fn has_debug_impl<'a, 'b>(ty: ty::Ty<'a>, cx: &LateContext<'b, 'a>) -> bool {
1269 match cx.tcx.lang_items.debug_trait() {
1270 Some(debug) => implements_trait(cx, ty, debug, Vec::new()),
1277 StartsWith(&'static str),
1280 #[cfg_attr(rustfmt, rustfmt_skip)]
1281 const CONVENTIONS: [(Convention, &'static [SelfKind]); 6] = [
1282 (Convention::Eq("new"), &[SelfKind::No]),
1283 (Convention::StartsWith("as_"), &[SelfKind::Ref, SelfKind::RefMut]),
1284 (Convention::StartsWith("from_"), &[SelfKind::No]),
1285 (Convention::StartsWith("into_"), &[SelfKind::Value]),
1286 (Convention::StartsWith("is_"), &[SelfKind::Ref, SelfKind::No]),
1287 (Convention::StartsWith("to_"), &[SelfKind::Ref]),
1290 #[cfg_attr(rustfmt, rustfmt_skip)]
1291 const TRAIT_METHODS: [(&'static str, usize, SelfKind, OutType, &'static str); 30] = [
1292 ("add", 2, SelfKind::Value, OutType::Any, "std::ops::Add"),
1293 ("as_mut", 1, SelfKind::RefMut, OutType::Ref, "std::convert::AsMut"),
1294 ("as_ref", 1, SelfKind::Ref, OutType::Ref, "std::convert::AsRef"),
1295 ("bitand", 2, SelfKind::Value, OutType::Any, "std::ops::BitAnd"),
1296 ("bitor", 2, SelfKind::Value, OutType::Any, "std::ops::BitOr"),
1297 ("bitxor", 2, SelfKind::Value, OutType::Any, "std::ops::BitXor"),
1298 ("borrow", 1, SelfKind::Ref, OutType::Ref, "std::borrow::Borrow"),
1299 ("borrow_mut", 1, SelfKind::RefMut, OutType::Ref, "std::borrow::BorrowMut"),
1300 ("clone", 1, SelfKind::Ref, OutType::Any, "std::clone::Clone"),
1301 ("cmp", 2, SelfKind::Ref, OutType::Any, "std::cmp::Ord"),
1302 ("default", 0, SelfKind::No, OutType::Any, "std::default::Default"),
1303 ("deref", 1, SelfKind::Ref, OutType::Ref, "std::ops::Deref"),
1304 ("deref_mut", 1, SelfKind::RefMut, OutType::Ref, "std::ops::DerefMut"),
1305 ("div", 2, SelfKind::Value, OutType::Any, "std::ops::Div"),
1306 ("drop", 1, SelfKind::RefMut, OutType::Unit, "std::ops::Drop"),
1307 ("eq", 2, SelfKind::Ref, OutType::Bool, "std::cmp::PartialEq"),
1308 ("from_iter", 1, SelfKind::No, OutType::Any, "std::iter::FromIterator"),
1309 ("from_str", 1, SelfKind::No, OutType::Any, "std::str::FromStr"),
1310 ("hash", 2, SelfKind::Ref, OutType::Unit, "std::hash::Hash"),
1311 ("index", 2, SelfKind::Ref, OutType::Ref, "std::ops::Index"),
1312 ("index_mut", 2, SelfKind::RefMut, OutType::Ref, "std::ops::IndexMut"),
1313 ("into_iter", 1, SelfKind::Value, OutType::Any, "std::iter::IntoIterator"),
1314 ("mul", 2, SelfKind::Value, OutType::Any, "std::ops::Mul"),
1315 ("neg", 1, SelfKind::Value, OutType::Any, "std::ops::Neg"),
1316 ("next", 1, SelfKind::RefMut, OutType::Any, "std::iter::Iterator"),
1317 ("not", 1, SelfKind::Value, OutType::Any, "std::ops::Not"),
1318 ("rem", 2, SelfKind::Value, OutType::Any, "std::ops::Rem"),
1319 ("shl", 2, SelfKind::Value, OutType::Any, "std::ops::Shl"),
1320 ("shr", 2, SelfKind::Value, OutType::Any, "std::ops::Shr"),
1321 ("sub", 2, SelfKind::Value, OutType::Any, "std::ops::Sub"),
1324 #[cfg_attr(rustfmt, rustfmt_skip)]
1325 const PATTERN_METHODS: [(&'static str, usize); 17] = [
1333 ("split_terminator", 1),
1334 ("rsplit_terminator", 1),
1339 ("match_indices", 1),
1340 ("rmatch_indices", 1),
1341 ("trim_left_matches", 1),
1342 ("trim_right_matches", 1),
1346 #[derive(Clone, Copy, PartialEq, Debug)]
1355 fn matches(self, ty: &hir::Ty, arg: &hir::Arg, self_ty: &hir::Ty, allow_value_for_ref: bool) -> bool {
1356 // Self types in the HIR are desugared to explicit self types. So it will always be `self:
1358 // where SomeType can be `Self` or an explicit impl self type (e.g. `Foo` if the impl is on `Foo`)
1359 // Thus, we only need to test equality against the impl self type or if it is an explicit
1360 // `Self`. Furthermore, the only possible types for `self: ` are `&Self`, `Self`, `&mut Self`,
1361 // and `Box<Self>`, including the equivalent types with `Foo`.
1363 let is_actually_self = |ty| is_self_ty(ty) || ty == self_ty;
1366 SelfKind::Value => is_actually_self(ty),
1367 SelfKind::Ref | SelfKind::RefMut => {
1368 if allow_value_for_ref && is_actually_self(ty) {
1372 hir::TyRptr(_, ref mt_ty) => {
1373 let mutability_match = if self == SelfKind::Ref {
1374 mt_ty.mutbl == hir::MutImmutable
1376 mt_ty.mutbl == hir::MutMutable
1378 is_actually_self(&mt_ty.ty) && mutability_match
1386 self == SelfKind::No
1390 fn description(&self) -> &'static str {
1392 SelfKind::Value => "self by value",
1393 SelfKind::Ref => "self by reference",
1394 SelfKind::RefMut => "self by mutable reference",
1395 SelfKind::No => "no self",
1401 fn check(&self, other: &str) -> bool {
1403 Convention::Eq(this) => this == other,
1404 Convention::StartsWith(this) => other.starts_with(this) && this != other,
1409 impl fmt::Display for Convention {
1410 fn fmt(&self, f: &mut fmt::Formatter) -> Result<(), fmt::Error> {
1412 Convention::Eq(this) => this.fmt(f),
1413 Convention::StartsWith(this) => this.fmt(f).and_then(|_| '*'.fmt(f)),
1418 #[derive(Clone, Copy)]
1427 fn matches(&self, ty: &hir::FunctionRetTy) -> bool {
1429 (&OutType::Unit, &hir::DefaultReturn(_)) => true,
1430 (&OutType::Unit, &hir::Return(ref ty)) if ty.node == hir::TyTup(vec![].into()) => true,
1431 (&OutType::Bool, &hir::Return(ref ty)) if is_bool(ty) => true,
1432 (&OutType::Any, &hir::Return(ref ty)) if ty.node != hir::TyTup(vec![].into()) => true,
1433 (&OutType::Ref, &hir::Return(ref ty)) => matches!(ty.node, hir::TyRptr(_, _)),
1439 fn is_bool(ty: &hir::Ty) -> bool {
1440 if let hir::TyPath(ref p) = ty.node {
1441 match_path(p, &["bool"])