Skip to content

Commit 341005b

Browse files
committed
Update the repr(transparent) section to reflect the current state
Signed-off-by: Yuki Okushi <jtitor@2k36.org>
1 parent 8d1e4dc commit 341005b

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

src/other-reprs.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,24 +56,27 @@ compiled as normal.)
5656

5757
## repr(transparent)
5858

59-
This can only be used on structs with a single non-zero-sized field (there may
60-
be additional zero-sized fields). The effect is that the layout and ABI of the
61-
whole struct is guaranteed to be the same as that one field.
59+
This can only be used on structs with a single non-zero-sized field
60+
or enums with only one non-zero-sized field (there may be additional zero-sized fields).
61+
The effect is that the layout and ABI of the whole struct/enum is guaranteed to be the same as that one field.
62+
63+
> NOTE: There's a `transparent_unions` nightly feature to apply `repr(transparent)` to unions,
64+
> but it hasn't been stabilized due to design concerns. See the [tracking issue][issue-60405] for more details.
6265
6366
The goal is to make it possible to transmute between the single field and the
64-
struct. An example of that is [`UnsafeCell`], which can be transmuted into
67+
struct/enum. An example of that is [`UnsafeCell`], which can be transmuted into
6568
the type it wraps ([`UnsafeCell`] also uses the unstable [no_niche][no-niche-pull],
6669
so its ABI is not actually guaranteed to be the same when nested in other types).
6770

68-
Also, passing the struct through FFI where the inner field type is expected on
69-
the other side is guaranteed to work. In particular, this is necessary for `struct
70-
Foo(f32)` to always have the same ABI as `f32`.
71+
Also, passing the struct/enum through FFI where the inner field type is expected on
72+
the other side is guaranteed to work. In particular, this is necessary for
73+
`struct Foo(f32)` or `enum Foo { Bar(f32) }` to always have the same ABI as `f32`.
7174

7275
This repr is only considered part of the public ABI of a type if either the single
7376
field is `pub`, or if its layout is documented in prose. Otherwise, the layout should
7477
not be relied upon by other crates.
7578

76-
More details are in the [RFC][rfc-transparent].
79+
More details are in the [RFC 1758][rfc-transparent] and the [RFC 2645][rfc-transparent-unions-enums].
7780

7881
## repr(u*), repr(i*)
7982

@@ -153,8 +156,10 @@ This is a modifier on `repr(C)` and `repr(Rust)`. It is incompatible with
153156
[unsafe code guidelines]: https://rust-lang.github.io/unsafe-code-guidelines/layout.html
154157
[drop flags]: drop-flags.html
155158
[ub loads]: https://github.com/rust-lang/rust/issues/27060
159+
[issue-60405]: https://github.com/rust-lang/rust/issues/60405
156160
[`UnsafeCell`]: ../std/cell/struct.UnsafeCell.html
157161
[rfc-transparent]: https://github.com/rust-lang/rfcs/blob/master/text/1758-repr-transparent.md
162+
[rfc-transparent-unions-enums]: https://rust-lang.github.io/rfcs/2645-transparent-unions.html
158163
[really-tagged]: https://github.com/rust-lang/rfcs/blob/master/text/2195-really-tagged-unions.md
159164
[rust-bindgen]: https://rust-lang.github.io/rust-bindgen/
160165
[cbindgen]: https://github.com/eqrion/cbindgen

0 commit comments

Comments
 (0)