-
Notifications
You must be signed in to change notification settings - Fork 60
basic chapter for representation of unions #39
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
*~ |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Representation of unions | ||
|
||
**Disclaimer:** This chapter represents the consensus from issue | ||
[#13]. The statements in here are not (yet) "guaranteed" | ||
not to change until an RFC ratifies them. | ||
|
||
[#13]: https://github.com/rust-rfcs/unsafe-code-guidelines/issues/13 | ||
|
||
The only degree of freedom the compiler has when computing the layout of a union | ||
like | ||
|
||
```rust | ||
union U { f1: T1, f2: T2 } | ||
``` | ||
|
||
is to determine the offset of the fields. The layout of these fields themselves | ||
is already entirely determined by their types, and since we intend to allow | ||
creating references to fields (`&u.f1`), unions do not have any wiggle-room | ||
there. | ||
|
||
### C-compatible layout ("repr C") | ||
|
||
For unions tagged `#[repr(C)]`, the compiler will apply the C layout scheme. Per | ||
sections [6.5.8.5] and [6.7.2.1.16] of the C11 specification, this means that | ||
the offset of every field is 0. Unsafe code can case a pointer to the union to | ||
a field type to obtain a pointer to any field, and vice versa. | ||
|
||
[6.5.8.5]: http://port70.net/~nsz/c/c11/n1570.html#6.5.8p5 | ||
[6.7.2.1.16]: http://port70.net/~nsz/c/c11/n1570.html#6.7.2.1p16 | ||
|
||
### Default layout ("repr rust") | ||
|
||
**The default layout of unions is not specified.** As of this writing, we want | ||
to keep the option of using non-zero offsets open for the future; whether this | ||
is useful depends on what exactly the compiler-assumed invariants about union | ||
contents are. |
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.
Uh oh!
There was an error while loading. Please reload this page.