-
Notifications
You must be signed in to change notification settings - Fork 488
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
unions: call out field offset issues #627
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 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
This file contains 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 |
---|---|---|
@@ -1,15 +1,16 @@ | ||
# Union types | ||
|
||
A *union type* is a nominal, heterogeneous C-like union, denoted by the name of | ||
a [`union` item]. | ||
a [`union` item][item]. | ||
|
||
A union access transmutes the content of the union to the type of the accessed | ||
Unions have no notion of an "active field". Instead, every union access | ||
transmutes parts of the content of the union to the type of the accessed | ||
field. Since transmutes can cause unexpected or undefined behaviour, `unsafe` is | ||
required to read from a union field or to write to a field that doesn't | ||
implement [`Copy`]. | ||
implement [`Copy`]. See the [item] documentation for further details. | ||
|
||
The memory layout of a `union` is undefined by default, but the `#[repr(...)]` | ||
attribute can be used to fix a layout. | ||
|
||
[`Copy`]: special-types-and-traits.html#copy | ||
[`union` item]: items/unions.html | ||
[item]: items/unions.html |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It's not really the role of the reference to say "it is the programmer's responsibility" or "this is how you use X" but it's fine here imo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you have a suggestion for wording it differently? I think it is useful to think in terms of responsibilities/obligations when talking about unsafe code, and hence I think it is useful for the reference to explain it as such.
I also have 0 experience writing standard-esque text.^^ Given my experience reading it though, it seems often so useless that I am not sure I am sad about that...
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really; the text itself is good but it's probably more aimed at users (e.g. the nomicon) whereas the reference is intended as the seeds of a spec with just definitions of the language but not the "why" and "this is how I use it". That is, should be more like the details of one of your academic papers with operational semantics and judgements... it isn't now, but it should be. :)
In any case, I think we can afford a smidgen of tips towards the programmer also here because some users will read this.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You mean the parts of the paper (or more often, the appendix) that only 2 people on this planet read because they are incomprehensible? ;)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
That's not the papers I read :)
I think something like the WASM spec has a nice structure:
That is, a mix of formally written semantics and English text to make it a bit less dense and more informative for non-experts.