rust-lang / rust-lang/rust-clippy

Suggest replacing manual equality assertion with assert_eq!

Open
#14,557 2 comments 1 reaction 0 assignees View on GitHub

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

Suggests replacing assert!(matches!(a, b)) and assert!(a == b); with assert_eq!(a, b) if PartialEq and Debug is implemented

Advantage
  • communicates the intent more directly
  • provides better debugging output if the assertion fails
Example

Suppose ...

#[derive(PartialEq, Debug)]
enum Enum {
    A,
    B,
}

let value = Enum::A;

Then the following code

assert!(matches!(value, Enum::A));
// or
assert!(value == Enum::A);

could be written as:

assert_eq!(value, Enum::A);

Also similar case possible for assert_ne!, debug_assert_eq!, debug_assert_ne!

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

No files, tests, or entry points are named in the issue. Start by locating existing assertion-related lint entry points and review the assert!(matches!(a, b)), assert!(a == b), and related macro examples; done means the supported equivalent forms are diagnosed only when the required traits are implemented and covered by tests.

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
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.