rust-lang / rust-lang/reference

Document union alignment guarantee?

Open
#871 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Rust
Stars
1.6k
Forks
607
PR merge metrics
PR metrics pending

Description

Currently https://github.com/rust-lang/reference/blob/master/src/items/unions.md only document size guarantee of union.
Can Rust guarantee that alignment of union somehow? Like it is the same as biggest alignment of all fields?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read src/items/unions.md and review the existing documentation of union size guarantees. Determine whether Rust has a defined alignment guarantee for unions, then document the established behavior in that section if the question can be resolved.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.