google / google/zerocopy

Document layout stability considerations

Open
#1,077 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Rust
Stars
2.6k
Forks
179
Avg merge
1d 19h
Merged PRs (30d)
29

Description

*See also: #1262*

We should provide crate level documentation about ensuring ABI stability. Particularly:
- When do you need to care about ABI stability?
- What factors impact ABI stability?
- What tooling exists to ensure ABI stability?

---

Old text from #1688:

> Most of our traits do not require layout stability (e.g., permitting `#[repr(packed)]` and not requiring `#[repr(C)]`). We should update our docs to at least point out this limitation and point users to external docs where they can learn more.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.