Skip to content

Outdated docs claim that #[repr(transparent)] on empty structs is not permitted #129029

Closed

Description

@scovich

This code compiles:

#[repr(transparent)] struct Foo {}

Going by the docs for #[repr(transparent)]:

#[repr(transparent)] can only be used on a struct or single-variant enum that has a single non-zero-sized field (there may be additional zero-sized fields). The effect is that the layout and ABI of the whole struct/enum is guaranteed to be the same as that one field.

... it seems like the compiler should reject that code, with diagnostics similar to those it emits for an empty transparent enum:

error[E0084]: unsupported representation for zero-variant enum
 --> src/lib.rs:2:1
  |
2 | #[repr(transparent)] enum E {}
  | ^^^^^^^^^^^^^^^^^^^^ ------ zero-variant enum

error[E0731]: transparent enum needs exactly one variant, but has 0
 --> src/lib.rs:2:22
  |
2 | #[repr(transparent)] enum E {}
  |                      ^^^^^^ needs exactly one variant, but has 0

Some errors have detailed explanations: E0084, E0731.

Activity

  1. added
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Aug 12, 2024
  2. changed the title [-]Compiler does not reject `#[repr(transparent)]` for empty struct[/-] [+]Compiler allows `#[repr(transparent)]` for empty struct[/+] on Aug 12, 2024
  3. compiler-errors commented on Aug 12, 2024

    @compiler-errors
    Contributor

    This regressed somewhere in 1.55

  4. compiler-errors commented on Aug 13, 2024

    @compiler-errors
    Contributor

    This is intentional: #86279

  5. compiler-errors commented on Aug 13, 2024

    @compiler-errors
    Contributor

    Notably, the difference between empty (variantless) enums and empty (fieldless) structs are that the former are uninhabited. Fieldless structs just have 0 size.

  6. compiler-errors commented on Aug 13, 2024

    @compiler-errors
    Contributor

    Actually, is the reference out of date? The reference says:

    The transparent representation can only be used on a struct or an enum with a single variant that has:
    * a single field with non-zero size, and
    * any number of fields with size 0 and alignment 1

  7. compiler-errors commented on Aug 13, 2024

    @compiler-errors
    Contributor

    We should update the reference anyways to note this change in rules. I still don't consider this to be a bug according to these rules:

    #77841 (comment)

  8. scovich commented on Aug 13, 2024

    @scovich
    ContributorAuthor

    Yes, reading the RFC, there is no bug, but the stale documentation needs to be fixed so people are not misled.

  9. added
    T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.
    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and tools
    and removed
    needs-triageThis issue may need triage. Remove when done. See docs forge.rust-lang.org/release/issue-triaging
    on Aug 13, 2024
  10. changed the title [-]Compiler allows `#[repr(transparent)]` for empty struct[/-] [+]Outdated docs claim that `#[repr(transparent)]` on empty struct is not permitted[/+] on Aug 13, 2024
  11. changed the title [-]Outdated docs claim that `#[repr(transparent)]` on empty struct is not permitted[/-] [+]Outdated docs claim that `#[repr(transparent)]` on empty structs is not permitted[/+] on Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsC-bugCategory: This is a bug.T-compilerRelevant to the compiler team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions