Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Unalign::update docs should suggest DerefMut for unaligned types #262

Closed
joshlf opened this issue Aug 15, 2023 · 0 comments · Fixed by #273
Closed

Unalign::update docs should suggest DerefMut for unaligned types #262

joshlf opened this issue Aug 15, 2023 · 0 comments · Fixed by #273
Labels
compatibility-nonbreaking Changes that are (likely to be) non-breaking

Comments

@joshlf
Copy link
Member

joshlf commented Aug 15, 2023

For T: Unaligned, Unalign<T> implements DerefMut. The Unalign::update docs should suggest that users prefer that over update when possible.
@joshlf joshlf added the compatibility-nonbreaking Changes that are (likely to be) non-breaking label Aug 15, 2023
joshlf added a commit that referenced this issue Aug 16, 2023
@joshlf
Unalign::update docs suggest DerefMut
de122eb 
For `T: Unaligned`, `Unalign<T>: DerefMut`. Using that impl will usually
be faster and more ergonomic than using `update`.

Closes #262
@joshlf joshlf mentioned this issue Aug 16, 2023
Merged
joshlf added a commit that referenced this issue Aug 17, 2023
@joshlf
Unalign::update docs suggest DerefMut (#273)
b7505f7 
For `T: Unaligned`, `Unalign<T>: DerefMut`. Using that impl will usually
be faster and more ergonomic than using `update`.

Closes #262
@joshlf joshlf mentioned this issue Aug 20, 2023
Closed
joshlf added a commit that referenced this issue Aug 23, 2023
@joshlf
Unalign::update docs suggest DerefMut (#273)
496ee17 
For `T: Unaligned`, `Unalign<T>: DerefMut`. Using that impl will usually
be faster and more ergonomic than using `update`.

Closes #262
joshlf added a commit that referenced this issue Aug 23, 2023
@joshlf
Unalign::update docs suggest DerefMut (#273)
8094973 
For `T: Unaligned`, `Unalign<T>: DerefMut`. Using that impl will usually
be faster and more ergonomic than using `update`.

Closes #262
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
compatibility-nonbreaking Changes that are (likely to be) non-breaking
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Unalign::update docs suggest DerefMut google/zerocopy
1 participant
@joshlf