rust-lang / rust-lang/rust-clippy

unit_cmp: special handling of assert_eq!(Option.unwrap(), ());

Open
#4,661 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

C-enhancement L-suggestion
Dominant language
Rust
Stars
13.5k
Forks
2.2k
Avg merge
2d 10h
Merged PRs (30d)
32

Description

pub fn main() {
    let x: Option<()> = Some(());
    assert_eq!(x.unwrap(), ());
}

Clippy warns here ``assert_eq of unit values detected. This will always succeed, however this code will actually check and panic if x is None.

Can we suggest to replace it with
assert!(x.is_some()) in this case?

Found in cargo codebase of cargo.

clippy 0.0.212 (5cb9833 2019-10-08)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the assert_eq unit-value lint and trace how it handles an Option.unwrap() expression. Add coverage for the shown Option<()> case and verify that the diagnostic suggests assert!(x.is_some()) while retaining the panic behavior for None.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
devtools
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.