1 use clippy_utils::diagnostics::span_lint_and_then;
2 use clippy_utils::{is_default_equivalent, peel_blocks};
3 use rustc_errors::Applicability;
6 Body, Expr, ExprKind, GenericArg, Impl, ImplItemKind, Item, ItemKind, Node, PathSegment, QPath, TyKind,
8 use rustc_lint::{LateContext, LateLintPass};
9 use rustc_session::{declare_lint_pass, declare_tool_lint};
12 declare_clippy_lint! {
14 /// Detects manual `std::default::Default` implementations that are identical to a derived implementation.
16 /// ### Why is this bad?
17 /// It is less concise.
25 /// impl Default for Foo {
26 /// fn default() -> Self {
36 /// #[derive(Default)]
42 /// ### Known problems
43 /// Derive macros [sometimes use incorrect bounds](https://github.com/rust-lang/rust/issues/26925)
44 /// in generic types and the user defined `impl` may be more generalized or
45 /// specialized than what derive will produce. This lint can't detect the manual `impl`
46 /// has exactly equal bounds, and therefore this lint is disabled for types with
47 /// generic parameters.
48 #[clippy::version = "1.57.0"]
51 "manual implementation of the `Default` trait which is equal to a derive"
54 declare_lint_pass!(DerivableImpls => [DERIVABLE_IMPLS]);
56 fn is_path_self(e: &Expr<'_>) -> bool {
57 if let ExprKind::Path(QPath::Resolved(_, p)) = e.kind {
58 matches!(p.res, Res::SelfCtor(..) | Res::Def(DefKind::Ctor(..), _))
64 impl<'tcx> LateLintPass<'tcx> for DerivableImpls {
65 fn check_item(&mut self, cx: &LateContext<'tcx>, item: &'tcx Item<'_>) {
67 if let ItemKind::Impl(Impl {
68 of_trait: Some(ref trait_ref),
73 if !cx.tcx.has_attr(item.owner_id.to_def_id(), sym::automatically_derived);
74 if !item.span.from_expansion();
75 if let Some(def_id) = trait_ref.trait_def_id();
76 if cx.tcx.is_diagnostic_item(sym::Default, def_id);
77 if let impl_item_hir = child.id.hir_id();
78 if let Some(Node::ImplItem(impl_item)) = cx.tcx.hir().find(impl_item_hir);
79 if let ImplItemKind::Fn(_, b) = &impl_item.kind;
80 if let Body { value: func_expr, .. } = cx.tcx.hir().body(*b);
81 if let Some(adt_def) = cx.tcx.type_of(item.owner_id).ty_adt_def();
82 if let attrs = cx.tcx.hir().attrs(item.hir_id());
83 if !attrs.iter().any(|attr| attr.doc_str().is_some());
84 if let child_attrs = cx.tcx.hir().attrs(impl_item_hir);
85 if !child_attrs.iter().any(|attr| attr.doc_str().is_some());
86 if adt_def.is_struct();
88 if let TyKind::Path(QPath::Resolved(_, p)) = self_ty.kind {
89 if let Some(PathSegment { args: Some(a), .. }) = p.segments.last() {
91 if !matches!(arg, GenericArg::Lifetime(_)) {
97 let should_emit = match peel_blocks(func_expr).kind {
98 ExprKind::Tup(fields) => fields.iter().all(|e| is_default_equivalent(cx, e)),
99 ExprKind::Call(callee, args)
100 if is_path_self(callee) => args.iter().all(|e| is_default_equivalent(cx, e)),
101 ExprKind::Struct(_, fields, _) => fields.iter().all(|ef| is_default_equivalent(cx, ef.expr)),
106 let struct_span = cx.tcx.def_span(adt_def.did());
111 "this `impl` can be derived",
113 diag.span_suggestion_hidden(
115 "remove the manual implementation...",
117 Applicability::MachineApplicable
119 diag.span_suggestion(
120 struct_span.shrink_to_lo(),
121 "...and instead derive it",
122 "#[derive(Default)]\n".to_string(),
123 Applicability::MachineApplicable