Clippy lints / Restriction
Clippy lint · Restriction · checked with Clippy 0.1.99
clippy::shadow_unrelated: Checks for bindings that shadow other bindings already in scope, either without an initialization or with one that does not even use the original value
What it meansChecks for bindings that shadow other bindings already in scope, either without an initialization or with one that does not even use the original value. It is in the restriction group and off by default.
Does it matter?
Shadowing a binding with a closely related one is part of idiomatic Rust, but shadowing a binding by accident with an unrelated one may indicate a mistake. Additionally, name shadowing in general can hurt readability, especially in large code bases, because it is easy to lose track of the active binding at any place in the code. If linting against all shadowing is desired, you may wish to use the shadow_same and shadow_reuse lints as well.
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
let x = y;
let x = z; // shadows the earlier binding
Write this instead
let x = y;
let w = z; // use different variable name
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]
shadow_unrelated = "warn"In code
#![warn(clippy::shadow_unrelated)]One run
cargo clippy -- -W clippy::shadow-unrelatedThe [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 bindings that shadow other bindings already in scope, either without an initialization or with one that does not even use the original value.
Why restrict this?
Shadowing a binding with a closely related one is part of idiomatic Rust, but shadowing a binding by accident with an unrelated one may indicate a mistake.
Additionally, name shadowing in general can hurt readability, especially in
large code bases, because it is easy to lose track of the active binding at
any place in the code. If linting against all shadowing is desired, you may wish
to use the shadow_same and shadow_reuse lints as well.
Example
let x = y;
let x = z; // shadows the earlier binding
Use instead:
let x = y;
let w = z; // use different variable name
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
- separated_literal_suffixinteger type suffix should not be separated by an underscore
- shadow_reuse`x` is shadowed
- shadow_sameChecks for bindings that shadow other bindings already in scope, while just changing reference level or mutability
- single_call_fnthis function is only used once
- single_char_lifetime_namessingle-character lifetime names are likely uninformative
- std_instead_of_allocused import from `std` instead of `alloc`
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?