rust-lang / rust-lang/rust-clippy

Recommend testing array sizes using type system rather than assertions when possible

Open
#7,936 0 comments 0 reactions 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

Checks for functions accepting slices that immediately check its length for equality with a constant and fail if isn't equal.

Categories (optional)
  • Kind: pedantic

What is the advantage of the recommended code over the original code

  • Making illegal states unrepresentable.
  • Making length requirements clear in documentation.
  • Removing unnecessary bound check at runtime.
Drawbacks

Necessitates using try_into() when calling a function using a slice. Doing this change for a public API is a breaking change.

Example
fn my_func(x: &[u32]) {
    assert_eq!(x.len(), 16);
    unimplemented!();
}

Could be written as:

fn my_func(x: &[u32; 16]) {
    unimplemented!();
}

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 with the issue's slice-length equality example and review how Rust Clippy organizes comparable lint proposals. Define the cases the lint should recognize, including the documented public-API breaking-change concern, and determine the expected diagnostics and tests. Done means the behavior and limitations are specified well enough to implement and verify.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
tooling
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.