clippy_lints/src/needless_update.rs

   1 use crate::utils::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     /// **Why is this bad?** This will cost resources (because the base has to be
  12     /// somewhere), and make the code less readable.
  13     ///
  14     /// **Known problems:** None.
  15     ///
  16     /// **Example:**
  17     /// ```rust
  18     /// # struct Point {
  19     /// #     x: i32,
  20     /// #     y: i32,
  21     /// #     z: i32,
  22     /// # }
  23     /// # let zero_point = Point { x: 0, y: 0, z: 0 };
  24     /// #
  25     /// # #[non_exhaustive]
  26     /// # struct Options {
  27     /// #     a: bool,
  28     /// #     b: i32,
  29     /// # }
  30     /// # let default_options = Options { a: false, b: 0 };
  31     /// #
  32     /// // Bad
  33     /// Point {
  34     ///     x: 1,
  35     ///     y: 1,
  36     ///     z: 1,
  37     ///     ..zero_point
  38     /// };
  39     ///
  40     /// // Ok
  41     /// Point {
  42     ///     x: 1,
  43     ///     y: 1,
  44     ///     ..zero_point
  45     /// };
  46     ///
  47     /// // this lint is not applied to structs marked with [non_exhaustive](https://doc.rust-lang.org/reference/attributes/type_system.html)
  48     /// // Ok
  49     /// Options {
  50     ///     a: true,
  51     ///     b: 321,
  52     ///     ..default_options
  53     ///  };
  54     /// ```
  55     pub NEEDLESS_UPDATE,
  56     complexity,
  57     "using `Foo { ..base }` when there are no missing fields"
  58 }
  59
  60 declare_lint_pass!(NeedlessUpdate => [NEEDLESS_UPDATE]);
  61
  62 impl<'tcx> LateLintPass<'tcx> for NeedlessUpdate {
  63     fn check_expr(&mut self, cx: &LateContext<'tcx>, expr: &'tcx Expr<'_>) {
  64         if let ExprKind::Struct(_, ref fields, Some(ref base)) = expr.kind {
  65             let ty = cx.typeck_results().expr_ty(expr);
  66             if let ty::Adt(def, _) = ty.kind() {
  67                 if fields.len() == def.non_enum_variant().fields.len()
  68                     && !def.variants[0_usize.into()].is_field_list_non_exhaustive()
  69                 {
  70                     span_lint(
  71                         cx,
  72                         NEEDLESS_UPDATE,
  73                         base.span,
  74                         "struct update has no effect, all the fields in the struct have already been specified",
  75                     );
  76                 }
  77             }
  78         }
  79     }
  80 }