Skip to content

Clarify that <str>::from_utf8* methods are aliases to core::str::from_utf8* functions #141079

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
sorairolake opened this issue May 16, 2025 · 1 comment · Fixed by #141112
Closed

Clarify that <str>::from_utf8* methods are aliases to core::str::from_utf8* functions #141079

sorairolake opened this issue May 16, 2025 · 1 comment · Fixed by #141112
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.

Comments

@sorairolake
Copy link
Contributor

Location

Summary

These methods are aliases to core::str::from_utf8* functions.

So I think it would be better to mention this as follows:

/// This is an alias to [`core::str::from_utf8`].

This also makes it more clear that the results of <str>::from_utf8* methods and core::str::from_utf8* functions are the same.
@sorairolake sorairolake added the A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools label May 16, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label May 16, 2025
@hanna-kruppe
Copy link
Contributor

It’s probably better for the links to go in the other direction: the inherent functions are more idiomatic and easier to access, so they shouldn’t distract readers by pointing out the worse alternative. Actually deprecating the free functions is probably too much churn for the foreseeable future but now that the inherent methods are stable they can be recommended in the free functions’ docs.

@xizheyin xizheyin mentioned this issue May 17, 2025
Merged
@bors bors closed this as completed in a2bf37e May 31, 2025
rust-timer added a commit that referenced this issue May 31, 2025
@rust-timer
Unrolled build for #141112
8df66b0 
Rollup merge of #141112 - xizheyin:issue-141079, r=Mark-Simulacrum

std: note that `std::str::from_utf8*` functions are aliases to `<str>::from_utf8*` methods

Closes #141079

r? libs
@saethlin saethlin added T-libs Relevant to the library team, which will review and decide on the PR/issue. and removed needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. labels Jun 2, 2025
github-actions bot pushed a commit to model-checking/verify-rust-std that referenced this issue Jun 3, 2025
@matthiaskrgr
Rollup merge of rust-lang#141112 - xizheyin:issue-141079, r=Mark-Simu…
451801b 
…lacrum

std: note that `std::str::from_utf8*` functions are aliases to `<str>::from_utf8*` methods

Closes rust-lang#141079

r? libs
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-docs Area: Documentation for any part of the project, including the compiler, standard library, and tools T-libs Relevant to the library team, which will review and decide on the PR/issue.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

std: note that std::str::from_utf8* functions are aliases to <str>::from_utf8* methods xizheyin/rust
4 participants
@hanna-kruppe @saethlin @rustbot @sorairolake