Clippy lints / Pedantic
Clippy lint · Pedantic · checked with Clippy 0.1.99
clippy::struct_field_names: field name starts with the struct's name
What it meansDetects struct fields that are prefixed or suffixed by the same characters or the name of the struct itself. It is in the pedantic group and off by default.
What you see
warning: field name starts with the struct's name --> main.rs:4:5 | 4 | cake_sugar: u8, | ^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#struct_field_names = note: `-W clippy::struct-field-names` implied by `-W clippy::pedantic`
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?
Information common to all struct fields is better represented in the struct name.
Stricter lints with some false positives. Off by default; opt in with clippy::pedantic.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
struct Cake {
cake_sugar: u8,
cake_flour: u8,
cake_eggs: u8
}
Write this instead
struct Cake {
sugar: u8,
flour: u8,
eggs: u8
}
Turn it off, or on
It is off by default. To use it, set it to warn or deny:
Whole crate (Cargo.toml)
[lints.clippy]
struct_field_names = "warn"In code
#![warn(clippy::struct_field_names)]One run
cargo clippy -- -W clippy::struct-field-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
struct-field-name-threshold: The minimum number of struct fields for the lints about field names to trigger
Clippy's own documentation
What it does
Detects struct fields that are prefixed or suffixed by the same characters or the name of the struct itself.
Why is this bad?
Information common to all struct fields is better represented in the struct 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
struct Cake {
cake_sugar: u8,
cake_flour: u8,
cake_eggs: u8
}
Use instead:
struct Cake {
sugar: u8,
flour: u8,
eggs: u8
}
Configuration
-
struct-field-name-threshold: The minimum number of struct fields for the lints about field 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
- too_many_linesChecks for functions with a large amount of lines
- missing_errors_docChecks the doc comments of publicly visible functions that return a Result type and warns if there is no # Errors section
- must_use_candidateChecks for public functions that have no #[must_use] attribute, but return something not already marked must-use, have no mutable arg and mutate no statics
- str_split_at_newlineChecks for usages of str.trim().split("\n") and str.trim().split("\r\n")
- string_add_assignyou assigned the result of adding something to this string. Consider using `String::push_str()` instead
- struct_excessive_boolsChecks for excessive use of bools in structs
- transmute_ptr_to_ptrtransmute from a pointer to a pointer
- trivially_copy_pass_by_refthis argument (4 byte) is passed by reference, but would be more efficient if passed by value (limit: 8 byte)
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::too_many_linesChecks for functions with a large amount of linesRead it next →Did this answer your question?