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.

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 2 commits into from
Jun 29, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 7 additions & 5 deletions src/items/unions.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ let f = u.f1;

Unions have no notion of an "active field". Instead, every union access just
interprets the storage at the type of the field used for the access. Reading a
union field reads the bits of the union at the field's type. It is the
programmer's responsibility to make sure that the data is valid at that
type. Failing to do so results in undefined behavior. For example, reading the
value `3` at type `bool` is undefined behavior. Effectively, writing to and then
reading from a union is analogous to a [`transmute`] from the type used for
union field reads the bits of the union at the field's type. Fields might have a
non-zero offset (except when `#[repr(C)]` is used); in that case the bits
starting at the offset of the fields are read. It is the programmer's
responsibility to make sure that the data is valid at that type. Failing to do
RalfJung marked this conversation as resolved.
Show resolved Hide resolved
so results in undefined behavior. For example, reading the value `3` at type
`bool` is undefined behavior. Effectively, writing to and then reading from a
`#[repr(C)]` union is analogous to a [`transmute`] from the type used for
writing to the type used for reading.

Consequently, all reads of union fields have to be placed in `unsafe` blocks:
Expand Down
9 changes: 5 additions & 4 deletions src/types/union.md
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