Clippy lints / Style
Clippy lint · Style · checked with Clippy 0.1.99
clippy::disallowed_names: use of a disallowed/placeholder name `foo`
What it meansChecks for usage of disallowed names for variables, such as foo. It is in the style group and warns by default.
What you see
warning: use of a disallowed/placeholder name `foo` --> main.rs:3:5 | 3 | let foo = 3.14; | ^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#disallowed_names = note: `#[warn(clippy::disallowed_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?
These names are usually placeholder names and should be avoided.
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
let foo = 3.14;
Turn it off, or on
Allow it where it does not fit your code, as narrowly as you can:
On one item
#[allow(clippy::disallowed_names)]
fn my_function() { /* ... */ }Whole crate (Cargo.toml)
[lints.clippy]
disallowed_names = "allow"One run
cargo clippy -- -A clippy::disallowed-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
disallowed-names: The list of disallowed names to lint about. NB: bar is not here since it has legitimate uses. The value ".." can be used as part of the list to indicate that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value.
Clippy's own documentation
What it does
Checks for usage of disallowed names for variables, such
as foo.
Why is this bad?
These names are usually placeholder names and should be avoided.
Example
let foo = 3.14;
Past names
- blacklisted_name
Configuration
-
disallowed-names: The list of disallowed names to lint about. NB:baris not here since it has legitimate uses. The value".."can be used as part of the list to indicate that the configured values should be appended to the default configuration of Clippy. By default, any configuration will replace the default value.(default:
["foo", "baz", "quux"])
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
- disallowed_fieldsDenies the configured fields in clippy.toml Note: Even though this lint is warn-by-default, it will only trigger if fields are defined in the clippy.toml file
- disallowed_macrosDenies the configured macros in clippy.toml Note: Even though this lint is warn-by-default, it will only trigger if macros are defined in the clippy.toml file
- disallowed_methodsDenies the configured methods and functions in clippy.toml Note: Even though this lint is warn-by-default, it will only trigger if methods are defined in the clippy.toml file
- disallowed_typesDenies the configured types in clippy.toml. Note: Even though this lint is warn-by-default, it will only trigger if types are defined in the clippy.toml file
- doc_lazy_continuationdoc quote line without `>` marker
- doc_overindented_list_itemsDetects overindented list items in doc comments where the continuation lines are indented more than necessary
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?