rust-lang / rust-lang/rust-clippy

disallowed_types for enum variants

Open
#10,154 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

Acts like the disallowed_* family of lints but would prevent the construction of a specific enum variant.

Lint Name

disallowed_variants

Category

style

Advantage

Disallows usage of a particular enum variant in your code that may be unsupported in the context you are writing in, but may make sense for a library to expose for use.

My use case is with prometheus and openmetrics. prometheus v1 can be seen as a subset of openmetrics (to an extent) and so using an openmetrics compatible library with lint restrictions on the allowed types and enum variants would prevent the programmer from making the mistake of including a non-prometheus feature in their code.

Drawbacks

As this does not exist yet, and has no mention from what I have seen, this lint may not be widely used.

Example

In a context where unknown is not a valid metric type.

  const TYPE: MetricType = MetricType::Unknown;

Could be written as:

  const TYPE: MetricType = MetricType::Gauge;

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 by comparing the existing disallowed_* lint family with the proposed disallowed_variants behavior. Confirm how the lint should identify prohibited enum variants and how configuration would express them. Done means the example rejects MetricType::Unknown while permitting MetricType::Gauge, with coverage for the intended diagnostics.

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.