1 //! lint when there is a large size difference between variants on an enum
3 use crate::utils::{snippet_opt, span_lint_and_then};
5 use rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
6 use rustc::ty::layout::LayoutOf;
7 use rustc::{declare_tool_lint, lint_array};
8 use rustc_errors::Applicability;
10 /// **What it does:** Checks for large size differences between variants on
13 /// **Why is this bad?** Enum size is bounded by the largest variant. Having a
15 /// can penalize the memory layout of that enum.
17 /// **Known problems:** None.
26 declare_clippy_lint! {
27 pub LARGE_ENUM_VARIANT,
29 "large size difference between variants on an enum"
32 #[derive(Copy, Clone)]
33 pub struct LargeEnumVariant {
34 maximum_size_difference_allowed: u64,
37 impl LargeEnumVariant {
38 pub fn new(maximum_size_difference_allowed: u64) -> Self {
40 maximum_size_difference_allowed,
45 impl LintPass for LargeEnumVariant {
46 fn get_lints(&self) -> LintArray {
47 lint_array!(LARGE_ENUM_VARIANT)
50 fn name(&self) -> &'static str {
55 impl<'a, 'tcx> LateLintPass<'a, 'tcx> for LargeEnumVariant {
56 fn check_item(&mut self, cx: &LateContext<'_, '_>, item: &Item) {
57 let did = cx.tcx.hir().local_def_id(item.id);
58 if let ItemKind::Enum(ref def, _) = item.node {
59 let ty = cx.tcx.type_of(did);
60 let adt = ty.ty_adt_def().expect("already checked whether this is an enum");
62 let mut smallest_variant: Option<(_, _)> = None;
63 let mut largest_variant: Option<(_, _)> = None;
65 for (i, variant) in adt.variants.iter().enumerate() {
66 let size: u64 = variant
70 let ty = cx.tcx.type_of(f.did);
71 // don't count generics by filtering out everything
72 // that does not have a layout
73 cx.layout_of(ty).ok().map(|l| l.size.bytes())
77 let grouped = (size, (i, variant));
79 update_if(&mut smallest_variant, grouped, |a, b| b.0 <= a.0);
80 update_if(&mut largest_variant, grouped, |a, b| b.0 >= a.0);
83 if let (Some(smallest), Some(largest)) = (smallest_variant, largest_variant) {
84 let difference = largest.0 - smallest.0;
86 if difference > self.maximum_size_difference_allowed {
87 let (i, variant) = largest.1;
93 "large size difference between variants",
95 if variant.fields.len() == 1 {
96 let span = match def.variants[i].node.data {
97 VariantData::Struct(ref fields, ..) | VariantData::Tuple(ref fields, ..) => {
100 VariantData::Unit(..) => unreachable!(),
102 if let Some(snip) = snippet_opt(cx, span) {
105 "consider boxing the large fields to reduce the total size of the \
107 format!("Box<{}>", snip),
108 Applicability::MaybeIncorrect,
114 def.variants[i].span,
115 "consider boxing the large fields to reduce the total size of the enum",
125 fn update_if<T, F>(old: &mut Option<T>, new: T, f: F)
127 F: Fn(&T, &T) -> bool,
129 if let Some(ref mut val) = *old {