Skip to content

Add supplementary information for get_unchecked(mut)#158810

Merged
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
yilin0518:fix_get_unchecked
Jul 6, 2026
Merged

Add supplementary information for get_unchecked(mut)#158810
rust-bors[bot] merged 1 commit into
rust-lang:mainfrom
yilin0518:fix_get_unchecked

Conversation

@yilin0518

@yilin0518 yilin0518 commented Jul 5, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Tracking issue: #74265

This PR makes the safety documentation for raw pointer and NonNull get_unchecked(_mut) APIs more consistent.

Currently, *mut [T]::get_unchecked_mut links out-of-bounds index to the add method, but the corresponding docs for *const[T]::get_unchecked and NonNull<[T]>::get_unchecked_mut use plain text for the same safety condition.

This PR updates those two docs to link out-of-bounds index to #method.add, matching the existing wording and link style used by *mut [T]::get_unchecked_mut.

This is a documentation-only change.

I also noticed that similar wording in the following APIs currently does not link out-of-bounds index:

I did not update those in this PR because I am not sure which target would be the most appropriate link for those APIs. If there is a preferred link target for these slice and SliceIndex docs, I would be happy to update them and merge the updates in this PR.

@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 Jul 5, 2026
@rustbot

rustbot commented Jul 5, 2026

Copy link
Copy Markdown
Collaborator

r? @Darksonn

rustbot has assigned @Darksonn.
They will have a look at your PR within the next two weeks and either review your PR or reassign to another reviewer.

Use r? to explicitly pick a reviewer

Why was this reviewer chosen?

The reviewer was selected based on:

  • Owners of files modified in this PR: libs
  • libs expanded to 12 candidates
  • Random selection from Darksonn, JohnTitor, Mark-Simulacrum, clarfonthey, jhpratt

Darksonn
Darksonn approved these changes Jul 6, 2026
View reviewed changes

@Darksonn Darksonn left a comment •
edited by rustbot
Loading

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

I don't think we should add any links to the slice methods. Defining in-bounds for raw pointers is slightly tricky and non-obvious, so it makes sense to link those, but for slices the definition is obvious and I think no link is needed.

@bors r+ rollup

View changes since this review

@rust-bors

rust-bors Bot commented Jul 6, 2026

Copy link
Copy Markdown
Contributor

📌 Commit c2cf85b has been approved by Darksonn

It is now in the queue for this repository.

@rust-bors rust-bors Bot added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Jul 6, 2026
@yilin0518

yilin0518 commented Jul 6, 2026

Copy link
Copy Markdown
Contributor Author

I understand. Thank you for your review!

@jhpratt jhpratt mentioned this pull request Jul 6, 2026
Merged
rust-bors Bot pushed a commit that referenced this pull request Jul 6, 2026
@bors
Auto merge of #158847 - jhpratt:rollup-MkjhKjV, r=jhpratt
29d802f 
Rollup of 24 pull requests

Successful merges:

 - #158377 (add `-Zforce-intrinsic-fallback` flag)
 - #158642 (Clarify some interning details)
 - #158694 (Positive test for closures needing expectations)
 - #158743 (Look for cdb location in the registry first)
 - #158775 (bootstrap: only encode RUSTFLAGS when a flag contains a space)
 - #158782 (Add and use cfg(target_has_threads) to enforce no_thread impl usage)
 - #158785 (hook intrinsic-test into aarch64-gnu)
 - #158819 (Put `InhabitedPredicate::NotInModule` earlier in disjunction since it can be a lot faster)
 - #157734 (Stabilize `local_key_cell_update`)
 - #158183 (std: allocate less memory in `current_exe` for OpenBSD)
 - #158310 (Remove unexpected usage of Unambig in non-infer variants)
 - #158671 (Move tests batch 17)
 - #158730 (Update `FIXME(static_mut_refs)` comments)
 - #158752 (Reorganize `tests/ui/issues` [18/N])
 - #158755 (Use `ThinVec` more in the AST)
 - #158757 (Fix incorrect tracking issue for `read_le`/`read_be`)
 - #158765 (Fix ICE on non-ident path in `doc(auto_cfg values)`)
 - #158771 (library: expand HashSet::extract_if coverage)
 - #158772 (rustc-dev-guide subtree update)
 - #158776 (fix: emit diagnostic for AVR target without target-cpu)
 - #158786 (Add regression test for builtin attr macro values)
 - #158810 (Add supplementary information for get_unchecked(mut))
 - #158825 (Fix typo)
 - #158838 (tidy: Use `empty_alternate = true` for triagebot mention glob check)
rust-bors Bot pushed a commit that referenced this pull request Jul 6, 2026
@bors
Auto merge of #158847 - jhpratt:rollup-MkjhKjV, r=jhpratt
315eb8b 
Rollup of 24 pull requests

Successful merges:

 - #158377 (add `-Zforce-intrinsic-fallback` flag)
 - #158642 (Clarify some interning details)
 - #158694 (Positive test for closures needing expectations)
 - #158743 (Look for cdb location in the registry first)
 - #158775 (bootstrap: only encode RUSTFLAGS when a flag contains a space)
 - #158782 (Add and use cfg(target_has_threads) to enforce no_thread impl usage)
 - #158785 (hook intrinsic-test into aarch64-gnu)
 - #158819 (Put `InhabitedPredicate::NotInModule` earlier in disjunction since it can be a lot faster)
 - #157734 (Stabilize `local_key_cell_update`)
 - #158183 (std: allocate less memory in `current_exe` for OpenBSD)
 - #158310 (Remove unexpected usage of Unambig in non-infer variants)
 - #158671 (Move tests batch 17)
 - #158730 (Update `FIXME(static_mut_refs)` comments)
 - #158752 (Reorganize `tests/ui/issues` [18/N])
 - #158755 (Use `ThinVec` more in the AST)
 - #158757 (Fix incorrect tracking issue for `read_le`/`read_be`)
 - #158765 (Fix ICE on non-ident path in `doc(auto_cfg values)`)
 - #158771 (library: expand HashSet::extract_if coverage)
 - #158772 (rustc-dev-guide subtree update)
 - #158776 (fix: emit diagnostic for AVR target without target-cpu)
 - #158786 (Add regression test for builtin attr macro values)
 - #158810 (Add supplementary information for get_unchecked(mut))
 - #158825 (Fix typo)
 - #158838 (tidy: Use `empty_alternate = true` for triagebot mention glob check)
rust-bors Bot pushed a commit that referenced this pull request Jul 6, 2026
@bors
Auto merge of #158847 - jhpratt:rollup-MkjhKjV, r=jhpratt
c4af710 
Rollup of 24 pull requests

Successful merges:

 - #158377 (add `-Zforce-intrinsic-fallback` flag)
 - #158642 (Clarify some interning details)
 - #158694 (Positive test for closures needing expectations)
 - #158743 (Look for cdb location in the registry first)
 - #158775 (bootstrap: only encode RUSTFLAGS when a flag contains a space)
 - #158782 (Add and use cfg(target_has_threads) to enforce no_thread impl usage)
 - #158785 (hook intrinsic-test into aarch64-gnu)
 - #158819 (Put `InhabitedPredicate::NotInModule` earlier in disjunction since it can be a lot faster)
 - #157734 (Stabilize `local_key_cell_update`)
 - #158183 (std: allocate less memory in `current_exe` for OpenBSD)
 - #158310 (Remove unexpected usage of Unambig in non-infer variants)
 - #158671 (Move tests batch 17)
 - #158730 (Update `FIXME(static_mut_refs)` comments)
 - #158752 (Reorganize `tests/ui/issues` [18/N])
 - #158755 (Use `ThinVec` more in the AST)
 - #158757 (Fix incorrect tracking issue for `read_le`/`read_be`)
 - #158765 (Fix ICE on non-ident path in `doc(auto_cfg values)`)
 - #158771 (library: expand HashSet::extract_if coverage)
 - #158772 (rustc-dev-guide subtree update)
 - #158776 (fix: emit diagnostic for AVR target without target-cpu)
 - #158786 (Add regression test for builtin attr macro values)
 - #158810 (Add supplementary information for get_unchecked(mut))
 - #158825 (Fix typo)
 - #158838 (tidy: Use `empty_alternate = true` for triagebot mention glob check)
@rust-bors rust-bors Bot merged commit 9d5b99d into rust-lang:main Jul 6, 2026
13 checks passed
@rustbot rustbot added this to the 1.99.0 milestone Jul 6, 2026
rust-timer added a commit that referenced this pull request Jul 6, 2026
@rust-timer
Unrolled build for #158810
97dd637 
Rollup merge of #158810 - yilin0518:fix_get_unchecked, r=Darksonn

Add supplementary information for get_unchecked(mut)

Tracking issue: #74265

This PR makes the safety documentation for raw pointer and NonNull `get_unchecked(_mut)` APIs more consistent.

Currently, `*mut [T]::get_unchecked_mut` links `out-of-bounds index` to the `add` method, but the corresponding docs for `*const[T]::get_unchecked` and `NonNull<[T]>::get_unchecked_mut` use plain text for the same safety condition.

This PR updates those two docs to link `out-of-bounds index` to `#method.add`, matching the existing wording and link style used by `*mut [T]::get_unchecked_mut`.

This is a documentation-only change.

I also noticed that similar wording in the following APIs currently does not link `out-of-bounds index`:

- [slice::get_unchecked](https://doc.rust-lang.org/core/primitive.slice.html#method.get_unchecked)
- [slice::get_unchecked_mut](https://doc.rust-lang.org/core/primitive.slice.html#method.get_unchecked_mut)
- [core::slice::SliceIndex::get_unchecked](https://doc.rust-lang.org/core/slice/trait.SliceIndex.html#tymethod.get_unchecked)
- [core::slice::SliceIndex::get_unchecked_mut](https://doc.rust-lang.org/core/slice/trait.SliceIndex.html#tymethod.get_unchecked_mut)

I did not update those in this PR because I am not sure which target would be the most appropriate link for those APIs. If there is a preferred link target for these slice and `SliceIndex` docs, I would be happy to update them and merge the updates in this PR.
pull Bot pushed a commit to xtqqczze/rust-lang-miri that referenced this pull request Jul 7, 2026
@bors
Auto merge of #158847 - jhpratt:rollup-MkjhKjV, r=jhpratt
a2587f8 
Rollup of 24 pull requests

Successful merges:

 - rust-lang/rust#158377 (add `-Zforce-intrinsic-fallback` flag)
 - rust-lang/rust#158642 (Clarify some interning details)
 - rust-lang/rust#158694 (Positive test for closures needing expectations)
 - rust-lang/rust#158743 (Look for cdb location in the registry first)
 - rust-lang/rust#158775 (bootstrap: only encode RUSTFLAGS when a flag contains a space)
 - rust-lang/rust#158782 (Add and use cfg(target_has_threads) to enforce no_thread impl usage)
 - rust-lang/rust#158785 (hook intrinsic-test into aarch64-gnu)
 - rust-lang/rust#158819 (Put `InhabitedPredicate::NotInModule` earlier in disjunction since it can be a lot faster)
 - rust-lang/rust#157734 (Stabilize `local_key_cell_update`)
 - rust-lang/rust#158183 (std: allocate less memory in `current_exe` for OpenBSD)
 - rust-lang/rust#158310 (Remove unexpected usage of Unambig in non-infer variants)
 - rust-lang/rust#158671 (Move tests batch 17)
 - rust-lang/rust#158730 (Update `FIXME(static_mut_refs)` comments)
 - rust-lang/rust#158752 (Reorganize `tests/ui/issues` [18/N])
 - rust-lang/rust#158755 (Use `ThinVec` more in the AST)
 - rust-lang/rust#158757 (Fix incorrect tracking issue for `read_le`/`read_be`)
 - rust-lang/rust#158765 (Fix ICE on non-ident path in `doc(auto_cfg values)`)
 - rust-lang/rust#158771 (library: expand HashSet::extract_if coverage)
 - rust-lang/rust#158772 (rustc-dev-guide subtree update)
 - rust-lang/rust#158776 (fix: emit diagnostic for AVR target without target-cpu)
 - rust-lang/rust#158786 (Add regression test for builtin attr macro values)
 - rust-lang/rust#158810 (Add supplementary information for get_unchecked(mut))
 - rust-lang/rust#158825 (Fix typo)
 - rust-lang/rust#158838 (tidy: Use `empty_alternate = true` for triagebot mention glob check)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@Darksonn Darksonn Darksonn approved these changes

Assignees

@Darksonn Darksonn

Labels

S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. T-libs Relevant to the library team, which will review and decide on the PR/issue.

Projects

None yet

Milestone

1.99.0

Development

Successfully merging this pull request may close these issues.

3 participants

@yilin0518 @rustbot @Darksonn