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

E0793: Clarify that it applies to unions as well #131472

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Changes from all commits
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
29 changes: 28 additions & 1 deletion compiler/rustc_error_codes/src/error_codes/E0793.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
An unaligned references to a field of a [packed] struct got created.
An unaligned reference to a field of a [packed] `struct` or `union` was created.

Erroneous code example:

Expand Down Expand Up @@ -45,9 +45,36 @@ unsafe {
// For formatting, we can create a copy to avoid the direct reference.
let copy = foo.field1;
println!("{}", copy);

// Creating a copy can be written in a single line with curly braces.
// (This is equivalent to the two lines above.)
println!("{}", { foo.field1 });

// A reference to a field that will always be sufficiently aligned is safe:
println!("{}", foo.field2);
}
```

### Unions

Even though creating a reference to a `union` field is `unsafe`, this error
will still be triggered when referencing a field that is not sufficiently
aligned. `addr_of!` and raw pointers should be used the same way as is done
for `struct` fields.

```compile_fail,E0793
#[repr(packed)]
pub union Foo {
field1: u64,
field2: u8,
}

unsafe {
let foo = Foo { field1: 0 };
// Accessing the field directly is fine.
let val = foo.field1;
// A reference to a packed union field causes a error.
let val = &foo.field1; // ERROR
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// A reference to a packed union field causes a error.
// A reference to a packed union field causes an error.

}
Comment on lines +74 to +77
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
// Accessing the field directly is fine.
let val = foo.field1;
// A reference to a packed union field causes a error.
let val = &foo.field1; // ERROR
// Accessing the field directly is fine.
let val = foo.field1;
// A reference to a packed union field causes a error.
let val = &foo.field1; // ERROR

```

Expand Down
Loading