Clippy lints / Pedantic
Clippy lint · Pedantic · checked with Clippy 0.1.99
clippy::used_underscore_binding: used underscore-prefixed binding
What it meansChecks for the use of bindings with a single leading underscore. It is in the pedantic group and off by default.
What you see
warning: used underscore-prefixed binding --> main.rs:4:9 | 4 | let y = _x + 1; // Here we are using `_x`, even though it has a leading | ^^ | note: binding is defined here --> main.rs:3:5 | 3 | let _x = 0; | ^^ = help: for further information visit https://rust-lang.github.io/rust-clippy/stable/index.html#used_underscore_binding = note: `-W clippy::used-underscore-binding` 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?
A single leading underscore is usually used to indicate that a binding will not be used. Using such a binding breaks this expectation.
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
let _x = 0;
let y = _x + 1; // Here we are using `_x`, even though it has a leading
// underscore. We should rename `_x` to `x`
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]
used_underscore_binding = "warn"In code
#![warn(clippy::used_underscore_binding)]One run
cargo clippy -- -W clippy::used-underscore-bindingThe [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 for the use of bindings with a single leading underscore.
Why is this bad?
A single leading underscore is usually used to indicate that a binding will not be used. Using such a binding breaks this expectation.
Known problems
The lint does not work properly with desugaring and macro, it has been allowed in the meantime.
Example
let _x = 0;
let y = _x + 1; // Here we are using `_x`, even though it has a leading
// underscore. We should rename `_x` to `x`
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
- unused_asyncunused `async` for function with no await statements
- unused_async_trait_implunused `async` for async trait impl function with no `.await` statements
- unused_selfunused `self` argument
- used_underscore_itemsused underscore-prefixed item
- verbose_bit_maskChecks for bit masks that can be replaced by a call to trailing_zeros
- wildcard_importsChecks for wildcard imports use _::*
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?