rust-clippy/clippy_lints/src/empty_enum.rs

61 lines
1.9 KiB
Rust
Raw Normal View History

2018-10-06 16:18:06 +00:00
// Copyright 2014-2018 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
//! lint when there is an enum with no variants
2018-11-27 20:14:15 +00:00
use crate::rustc::hir::*;
use crate::rustc::lint::{LateContext, LateLintPass, LintArray, LintPass};
use crate::rustc::{declare_tool_lint, lint_array};
2018-05-30 08:15:50 +00:00
use crate::utils::span_lint_and_then;
/// **What it does:** Checks for `enum`s with no variants.
///
2017-08-09 07:30:56 +00:00
/// **Why is this bad?** Enum's with no variants should be replaced with `!`,
/// the uninhabited type,
/// or a wrapper around it.
///
/// **Known problems:** None.
///
/// **Example:**
/// ```rust
/// enum Test {}
/// ```
2018-03-28 13:24:26 +00:00
declare_clippy_lint! {
pub EMPTY_ENUM,
2018-03-28 13:24:26 +00:00
pedantic,
"enum with no variants"
}
2017-08-09 07:30:56 +00:00
#[derive(Copy, Clone)]
pub struct EmptyEnum;
impl LintPass for EmptyEnum {
fn get_lints(&self) -> LintArray {
lint_array!(EMPTY_ENUM)
}
}
impl<'a, 'tcx> LateLintPass<'a, 'tcx> for EmptyEnum {
2018-07-23 11:01:12 +00:00
fn check_item(&mut self, cx: &LateContext<'_, '_>, item: &Item) {
let did = cx.tcx.hir().local_def_id(item.id);
2018-07-16 13:07:39 +00:00
if let ItemKind::Enum(..) = item.node {
2017-04-27 12:00:35 +00:00
let ty = cx.tcx.type_of(did);
2018-11-27 20:14:15 +00:00
let adt = ty.ty_adt_def().expect("already checked whether this is an enum");
if adt.variants.is_empty() {
span_lint_and_then(cx, EMPTY_ENUM, item.span, "enum with no variants", |db| {
2018-11-27 20:14:15 +00:00
db.span_help(
item.span,
"consider using the uninhabited type `!` or a wrapper around it",
);
});
}
}
}
}