Clippy lints / Style
Clippy lint · Style · checked with Clippy 0.1.99
clippy::enum_variant_names: variant name ends with the enum's name
What it meansDetects enumeration variants that are prefixed or suffixed by the same characters. It is in the style group and warns by default.
What you see
warning: variant name ends with the enum's name --> main.rs:4:5 | 4 | BlackForestCake, | ^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#enum_variant_names = note: `#[warn(clippy::enum_variant_names)]` on by default
Real output of Clippy 0.1.99 (Rust 1.99) on the example below. Names and line numbers in yours will differ.
Does it matter?
Enumeration variant names should specify their variant, not repeat the enumeration name.
Code that works but is not idiomatic Rust. Warns by default.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
enum Cake {
BlackForestCake,
HummingbirdCake,
BattenbergCake,
}
Write this instead
enum Cake {
BlackForest,
Hummingbird,
Battenberg,
}
Turn it off, or on
Allow it where it does not fit your code, as narrowly as you can:
On one item
#[allow(clippy::enum_variant_names)]
fn my_function() { /* ... */ }Whole crate (Cargo.toml)
[lints.clippy]
enum_variant_names = "allow"One run
cargo clippy -- -A clippy::enum-variant-namesThe [lints] table needs Rust 1.74 or newer. In a workspace, put it under [workspace.lints.clippy] and add [lints] workspace = true to each member.
Settings in clippy.toml
avoid-breaking-exported-api: Suppress lints whenever the suggested change would cause breakage for other crates.enum-variant-name-threshold: The minimum number of enum variants for the lints about variant names to trigger
Clippy's own documentation
What it does
Detects enumeration variants that are prefixed or suffixed by the same characters.
Why is this bad?
Enumeration variant names should specify their variant, not repeat the enumeration name.
Limitations
Characters with no casing will be considered when comparing prefixes/suffixes
This applies to numbers and non-ascii characters without casing
e.g. Foo1 and Foo2 is considered to have different prefixes
(the prefixes are Foo1 and Foo2 respectively), as also Bar螃, Bar蟹
Example
enum Cake {
BlackForestCake,
HummingbirdCake,
BattenbergCake,
}
Use instead:
enum Cake {
BlackForest,
Hummingbird,
Battenberg,
}
Configuration
-
avoid-breaking-exported-api: Suppress lints whenever the suggested change would cause breakage for other crates.(default:
true) -
enum-variant-name-threshold: The minimum number of enum variants for the lints about variant names to trigger(default:
3)
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- needless_returnunneeded `return` statement
- new_without_defaultChecks for public types with a pub fn new() -> Self method and no implementation of Default
- len_zeroChecks for getting the length of something via .len() just to compare to zero, and suggests using .is_empty() where applicable
- doc_overindented_list_itemsDetects overindented list items in doc comments where the continuation lines are indented more than necessary
- double_must_usethis function has a `#[must_use]` attribute with no message, but returns a type already considered as `#[must_use]`
- duplicate_underscore_argument`a` already exists, having another argument having almost the same name makes code comprehension and documentation more difficult
- err_expectcalled `.err().expect()` on a `Result` value
- excessive_precisionfloat has excessive precision
- field_reassign_with_defaultChecks for immediate reassignment of fields initialized with Default::default()
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::needless_returnunneeded `return` statementRead it next →Did this answer your question?