clippy_lints/src/needless_update.rs

   1 use clippy_utils::diagnostics::span_lint;
   2 use rustc_hir::{Expr, ExprKind};
   3 use rustc_lint::{LateContext, LateLintPass};
   4 use rustc_middle::ty;
   5 use rustc_session::{declare_lint_pass, declare_tool_lint};
   6
   7 declare_clippy_lint! {
   8     /// **What it does:** Checks for needlessly including a base struct on update
   9     /// when all fields are changed anyway.
  10     ///
  11     /// This lint is not applied to structs marked with
  12     /// [non_exhaustive](https://doc.rust-lang.org/reference/attributes/type_system.html).
  13     ///
  14     /// **Why is this bad?** This will cost resources (because the base has to be
  15     /// somewhere), and make the code less readable.
  16     ///
  17     /// **Known problems:** None.
  18     ///
  19     /// **Example:**
  20     /// ```rust
  21     /// # struct Point {
  22     /// #     x: i32,
  23     /// #     y: i32,
  24     /// #     z: i32,
  25     /// # }
  26     /// # let zero_point = Point { x: 0, y: 0, z: 0 };
  27     ///
  28     /// // Bad
  29     /// Point {
  30     ///     x: 1,
  31     ///     y: 1,
  32     ///     z: 1,
  33     ///     ..zero_point
  34     /// };
  35     ///
  36     /// // Ok
  37     /// Point {
  38     ///     x: 1,
  39     ///     y: 1,
  40     ///     ..zero_point
  41     /// };
  42     /// ```
  43     pub NEEDLESS_UPDATE,
  44     complexity,
  45     "using `Foo { ..base }` when there are no missing fields"
  46 }
  47
  48 declare_lint_pass!(NeedlessUpdate => [NEEDLESS_UPDATE]);
  49
  50 impl<'tcx> LateLintPass<'tcx> for NeedlessUpdate {
  51     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
  52         if let ExprKind::Struct(_, fields, Some(base)) = expr.kind {
  53             let ty = cx.typeck_results().expr_ty(expr);
  54             if let ty::Adt(def, _) = ty.kind() {
  55                 if fields.len() == def.non_enum_variant().fields.len()
  56                     && !def.variants[0_usize.into()].is_field_list_non_exhaustive()
  57                 {
  58                     span_lint(
  59                         cx,
  60                         NEEDLESS_UPDATE,
  61                         base.span,
  62                         "struct update has no effect, all the fields in the struct have already been specified",
  63                     );
  64                 }
  65             }
  66         }
  67     }
  68 }