rust-lang / rust-lang/rust-clippy
`if_assert`
Open
Nobody has claimed this yet.
A-lint
- Dominant language
- Rust
- Stars
- 13.5k
- Forks
- 2.2k
- Avg merge
- 2d 10h
- Merged PRs (30d)
- 32
Description
What it does
It should deny or warn when a predicate is checked by both an assert (or any similar built-in macro) and any conditional control-flow construct, in any order
Related: #8567
Advantage
- It removes a redundant check that's certainly a bug
- Less confusion for readers
- No change in code-gen, as the optimizer could catch the dupe and eliminate it
Drawbacks
- False negatives because of custom macros
Cannot be auto-fixed, because intent isn't clear(wrong?)
Example
fn f<T: std::fmt::Debug + PartialEq>(a: T, b: T) {
if a == b {
assert_eq!(a, b);
// do something
}
}
fn g<T: std::fmt::Debug + PartialEq>(a: T, b: T) {
assert_eq!(a, b);
if a == b {
// do something
}
}
Could be written as:
fn f<T: std::fmt::Debug + PartialEq>(a: T, b: T) {
if a == b {
// do something
}
}
fn g<T: std::fmt::Debug + PartialEq>(a: T, b: T) {
assert_eq!(a, b);
// do something
}
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with related issue #8567 and the two examples in this issue. Define the lint behavior for both assertion-before-conditional and conditional-before-assertion cases, then verify that it reports redundant predicate checks while accounting for the stated false negatives around custom macros.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100