Clippy lints / Restriction
Clippy lint · Restriction · checked with Clippy 0.1.99
clippy::partial_pub_fields: mixed usage of pub and non-pub fields
What it meansChecks whether some but not all fields of a struct are public. Either make all fields of a type public, or make none of them public It is in the restriction group and off by default.
What you see
warning: mixed usage of pub and non-pub fields --> main.rs:6:5 | 6 | b: u8, | ^ | = help: consider using public field here = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#partial_pub_fields = note: requested on the command line with `-W clippy::partial-pub-fields`
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?
Most types should either be: Abstract data types: complex objects with opaque implementation which guard interior invariants and expose intentionally limited API to the outside world. Data: relatively simple objects which group a bunch of related attributes together, but have no invariants.
Lints that forbid language features for specific codebases (no unwrap, no indexing...). Off by default; pick them one by one, never the whole group.
How to fix it
Clippy does not fix this one automatically. Change the code by hand:
Flagged
pub struct Color {
pub r: u8,
pub g: u8,
b: u8,
}
Write this instead
pub struct Color {
pub r: u8,
pub g: u8,
pub b: 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]
partial_pub_fields = "warn"In code
#![warn(clippy::partial_pub_fields)]One run
cargo clippy -- -W clippy::partial-pub-fieldsThe [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.
Clippy's own documentation
What it does
Checks whether some but not all fields of a struct are public.
Either make all fields of a type public, or make none of them public
Why restrict this?
Most types should either be:
- Abstract data types: complex objects with opaque implementation which guard interior invariants and expose intentionally limited API to the outside world.
- Data: relatively simple objects which group a bunch of related attributes together, but have no invariants.
Example
pub struct Color {
pub r: u8,
pub g: u8,
b: u8,
}
Use instead:
pub struct Color {
pub r: u8,
pub g: u8,
pub b: u8,
}
From the Clippy lint list (0.1.99), part of the Rust project, MIT or Apache-2.0. Official entry.
Related lints
- unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on Options
- module_name_repetitionsDetects public item names that are prefixed or suffixed by the containing public module’s name
- expect_usedChecks for .expect() or .expect_err() calls on Results and .expect() call on Options
- non_zero_suggestionsconsider using `NonZeroU64::from()` for more efficient and type-safe conversion
- panic`panic` should not be present in production code
- panic_in_result_fnused `panic!()` or assertion in a function that returns `Result`
- pathbuf_init_then_pushChecks for calls to push immediately after creating a new PathBuf
- pattern_type_mismatchtype of pattern does not match the expression type
- pointer_formatpointer formatting detected
All 847 Clippy lints · Rust compiler errors · Cargo.toml checker
Up next
Related lintclippy::unwrap_usedChecks for .unwrap() or .unwrap_err() calls on Results and .unwrap() call on OptionsRead it next →Did this answer your question?