Skip to content

Resolve layout of single variant enums #159

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 6 commits into from
Aug 27, 2019
Merged
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
Prev Previous commit
Next Next commit
Remove guarantees for enums with uninhabited variants
  • Loading branch information
gnzlbg committed Aug 15, 2019
commit e80b69d6898c5ffbe99abeac603d11ed04d65e8f
34 changes: 4 additions & 30 deletions reference/src/layout/enums.md
Original file line number Diff line number Diff line change
Expand Up @@ -401,34 +401,8 @@ enum DataCarryingSingleVariant {
* `FieldSingleVariant` has the same layout as `UnitStruct`,
* `DataCarryingSingleVariant` has the same layout as `SomeStruct`.

### Layout of multi-variant enums with one inhabited variant
## Unresolved questions

> **NOTE**: the guarantees in this section have not been approved by an RFC process.

The layout of **multi-variant** enums with **one inhabited variant** is the same
as that of the single-variant enum containing that same inhabited variant.

Here:

```rust
# use std::mem::{size_of, align_of};
struct SomeStruct { x: u32 }
enum SingleVariantDataCarrying {
DataCarryingVariant(SomeStruct),
}
enum Void0 {}
enum Void1 {}
enum MultiVariantSingleHabited {
DataCarryingVariant(SomeStruct),
Uninhabited0(Void0),
Uninhabited1(Void1),
}
# fn main() {
# use std::mem;
# assert_eq!(size_of::<SingleVariantDataCarrying>(), size_of::<MultiVariantSingleHabited>());
# assert_eq!(align_of::<SingleVariantDataCarrying>(), align_of::<MultiVariantSingleHabited>());
# }
```

the `MultiVariantSingleHabited` enum has the same layout as
`SingleVariantDataCarrying`.
See [Issue #79.](https://github.com/rust-rfcs/unsafe-code-guidelines/issues/79):

* Layout of multi-variant enums with one inhabited variant.