paritytech / paritytech/parity-scale-codec
A way to require enum variant index being specified
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 287
- Forks
- 103
- Avg merge
- 6d 13h
- Merged PRs (30d)
- 1
Description
I think it would be valuable to make an enum variant index required in derived code.
The way to approach this might be to have a separate feature that would generate a compile-time warning when #[codec(index = something)] is missing.
This is important in blockchain environment where some data structures can evolve over time and refactoring can accidentally break things.
Contributor guide
No contributing guide indexed for this repository
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 locating the derived-code handling for #[codec(index = something)] and how feature-gated compile-time diagnostics are implemented. Determine how missing enum variant indexes should be detected and verify that the chosen feature emits a warning without affecting explicitly indexed variants; add or run the relevant derive tests if available.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- blockchain
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 30/100