docs: add comprehensive documentation for borrowing from repr(packed)… #1984
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
… arrays - Add detailed explanation of alignment requirements when borrowing from packed structs - Document that array/slice ABI alignment equals element type alignment - Provide concrete examples showing allowed and forbidden borrowing patterns - Clarify that E0793 error prevents creation of misaligned references - Explain the conservative nature of alignment checks in generic contexts This documentation helps developers understand the safety constraints when working with packed structs containing arrays of different types.
rustbot added the S-waiting-on-review Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit. This suggestion is invalid because no changes were made to the code. Suggestions cannot be applied while the pull request is closed. Suggestions cannot be applied while viewing a subset of changes. Only one suggestion per line can be applied in a batch. Add this suggestion to a batch that can be applied as a single commit. Applying suggestions on deleted lines is not supported. You must change the existing code in this line in order to create a valid suggestion. Outdated suggestions cannot be applied. This suggestion has been applied or marked resolved. Suggestions cannot be applied from pending reviews. Suggestions cannot be applied on multi-line comments. Suggestions cannot be applied while the pull request is queued to merge. Suggestion cannot be applied right now. Please check back later.
Document borrowing rules for
repr(packed)fields (E0793).This documents the behavior implemented in rust-lang/rust#145419:
[T; N]/[T], alignment equals that ofT, independent ofN.Includes examples for the allowed
[u8; N]case and the disallowed[u16; N]case.