rust-lang / rust-lang/rust-clippy

New lint: `repr_transparent`

Open
#11,573 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

Suggests adding #[repr(transparent)] to items with only one field.

Advantage

Allows structs to be layed out as their singular field, which can be useful in FFI bounds

Drawbacks

Some types may not want to be used in FFI context, so no repr or repr(Rust) might be preferred

Example
struct MyNum(i32);

Could be written as:

#[repr(transparent)]
struct MyNum(i32);

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 reading the repository's existing lint implementations and tests to find the entry points for a new lint. Compare the requested behavior with the examples in this issue, and consider the stated FFI and layout tradeoffs. Done means the lint suggests #[repr(transparent)] for eligible single-field items without suggesting it where the drawbacks apply.

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.