Remove uses of `enum`
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 2.6k
- Forks
- 1.3k
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 69
Description
Rust enums become UB if they hold an unexpected value, while C enums are effectively a grouped list of named constants. This causes easy UB if e.g. C adds a value or returns a value not represented by the enum (as is allowed in C), and this value gets passed to Rust.
The easiest thing to do is map enums to constants, which we already do in most cases. We could also consider an enum! macro that figures out the values.
Some more context is at https://mdaverde.com/posts/rust-bindgen-enum/ and https://github.com/rust-lang/rust-bindgen/issues/2646.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the existing cases where C enums are mapped to constants, then read the linked bindgen context and the discussion in rust-bindgen issue #2646. Determine the scope of enum uses to remove and whether an enum! macro is needed. Done means the affected bindings avoid unsafe Rust enums while preserving the C values across platforms.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- operating-systems
- Issue type
- Refactor
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100