Skip to content

Document NonNull layout guarantees#158325

Open
0xEgao wants to merge 1 commit into
rust-lang:mainfrom
0xEgao:docs-non-null
Open

Document NonNull layout guarantees#158325
0xEgao wants to merge 1 commit into
rust-lang:mainfrom
0xEgao:docs-non-null

Conversation

@0xEgao

@0xEgao 0xEgao commented Jun 23, 2026

Copy link
Copy Markdown

As discussed here
Fixes #157741

This updates the NonNull layout docs to match the structure and wording used by NonZero.

  • adds the missing NonNull<T> layout and validity wording, and documents that Option<NonNull<T>> is compatible with *mut T, including in FFI.

r? @RalfJung

@rustbot rustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue. labels Jun 23, 2026
@rustbot

rustbot commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

RalfJung is not on the review rotation at the moment.
They may take a while to respond.

@rustbot

rustbot commented Jun 23, 2026

Copy link
Copy Markdown
Collaborator

Thanks for the pull request, and welcome! The Rust Project is excited to review your changes, and you should hear from @RalfJung (or someone else) some time within the next two weeks.

Please see the contribution instructions for more information. Namely, in order to ensure the minimum review times lag, PR authors and assigned reviewers should ensure that the review label (S-waiting-on-review and S-waiting-on-author) stays updated, invoking these commands when appropriate:

  • @rustbot author: the review is finished, PR author should check the comments and take action accordingly
  • @rustbot review: the author is ready for a review, this PR will be queued again in the reviewer's queue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

NonNull<T> doesn't guarantee ABI compatibility with *mut T

3 participants