UnsafePinned should provide the same guarantee layouts as UnsafeCell
Open
Beginner friendly
Nobody has claimed this yet.
A-docs
C-bug
F-unsafe_pinned
T-libs
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
As discussed with @RalfJung here, it seems like the documentation for UnsafePinned<T> should guarantee the same layout as T, like UnsafeCell does.
I didn't mention it in that comment, but I think this also makes sense given that the documentation says that UnsafePinned is intended to subsume UnsafeCell.
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 with the UnsafePinned documentation linked in the issue and compare its layout guarantees with the UnsafeCell documentation. Update the UnsafePinned documentation so it explicitly provides the same guarantee as T, then verify that the resulting wording matches the intended relationship between the two types.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 70/100