rust-lang / rust-lang/std-dev-guide
Document when and how to specialize for optimization
Nobody has claimed this yet.
- Dominant language
- Shell
- Stars
- 90
- Forks
- 47
- Avg merge
- 9h 22m
- Merged PRs (30d)
- 1
Description
A lot of iterator adapters have specialized implementations for when the underlying iterator implements e.g. TrustedRandomAccess.Traits like that are marked with #[rustc_specialization_marker] or #[rustc_unsafe_specialization_marker]. We should document when to use this, and what it means for stability guarantees.
cc @matthewjasper
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
Begin by locating the std-dev-guide section covering iterator adapters and specialization. Document when TrustedRandomAccess and the two specialization marker attributes should be used, including their stability guarantees; the work is done when these rules are clear in the guide.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100