Skip to content

Documentation for CStr is not that of CString - #84000

Closed
eggyal wants to merge 1 commit into
rust-lang:masterfrom
eggyal:issue-83999
Closed

Documentation for CStr is not that of CString#84000
eggyal wants to merge 1 commit into
rust-lang:masterfrom
eggyal:issue-83999

Conversation

@eggyal

@eggyaleggyal commented Apr 8, 2021

Copy link
Copy Markdown
Contributor

Fixes#83999

@rust-highfive

rust-highfive commented Apr 8, 2021

Copy link
Copy Markdown
Contributor

r? @m-ou-se

(rust-highfive has picked a reviewer for you, use r? to override)

@rust-highfiverust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Apr 8, 2021
jyn514
jyn514 reviewed Apr 8, 2021
View reviewed changes
Comment threadlibrary/std/src/ffi/c_str.rs Outdated
gribozavr
gribozavr reviewed Apr 8, 2021
View reviewed changes
Comment threadlibrary/std/src/ffi/c_str.rs Outdated
@eggyal
eggyalforce-pushed the issue-83999 branch 3 times, most recently from 61aa43d to 72cac1cCompareApril 8, 2021 17:10
m-ou-se
m-ou-se reviewed Apr 11, 2021
View reviewed changes
Comment threadlibrary/std/src/ffi/c_str.rs Outdated
Comment threadlibrary/std/src/ffi/c_str.rs Outdated
@m-ou-sem-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Apr 25, 2021
@bstrie

bstrie commented May 12, 2021

Copy link
Copy Markdown
Contributor

@eggyal , have you had time to address the most recent comments?

@eggyal

eggyal commented May 13, 2021

Copy link
Copy Markdown
ContributorAuthor

@bstrie@m-ou-se Apologies, this rather slipped off my radar... I'll get around to it later today.

@eggyaleggyal closed this May 14, 2021
@eggyal

eggyal commented May 14, 2021•
edited
Loading

Copy link
Copy Markdown
ContributorAuthor

Erroneous push closed PR accidentally.

@rustbot label -S-waiting-on-author +S-waiting-on-review

@eggyaleggyal reopened this May 14, 2021
@rustbotrustbot added S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. and removed S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. labels May 14, 2021
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@eggyal
eggyalforce-pushed the issue-83999 branch 2 times, most recently from d16d8ca to 053e0c7CompareMay 14, 2021 10:17
@eggyal
eggyal marked this pull request as draft May 14, 2021 10:19
@rust-log-analyzer

This comment has been minimized.

Sign in to view
@eggyal

eggyal commented May 14, 2021

Copy link
Copy Markdown
ContributorAuthor

Aaagh, sorry, I'm making a right hash of git today.

@eggyal
eggyal marked this pull request as ready for review May 14, 2021 10:25
m-ou-se
m-ou-se reviewed May 19, 2021
View reviewed changes

@m-ou-sem-ou-se left a comment

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.

I don't think this change in its current form is an improvement. The original example shows the subtle mistake of using CString::new and .as_ptr() in the same expression, which is an easy mistake to make. The new example shows a more contrived snippet, which doesn't show as clearly how easy it is to make this mistake.

In addition, the changed documentation continues to explain a fix that doesn't just keep the right variable alive longer, but uses a completely different method of using a [u8; _] called bytes which the first example doesn't have, making it harder to focus on the lifetime problem itself.

@m-ou-sem-ou-se added S-waiting-on-author Status: This is awaiting some action (such as code changes or more information) from the author. T-libs-api [DEPRECATED; DO NOT USE] and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels May 19, 2021
@crlf0710

crlf0710 commented Jun 5, 2021

Copy link
Copy Markdown
Member

@eggyal Ping from triage, any updates on this?

@JohnCSimonJohnCSimon added the S-inactive Status: Inactive and waiting on the author. This is often applied to closed PRs. label Jun 22, 2021
@JohnCSimon

JohnCSimon commented Jun 22, 2021

Copy link
Copy Markdown

@eggyal Ping from triage: I'm closing this as inactive because it hasn't moved for a month. Please feel free to reopen when you're ready to continue.

@eggyal
eggyal deleted the issue-83999 branch June 28, 2022 06:11
This was referenced Jan 30, 2025
Closed
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@m-ou-sem-ou-sem-ou-se left review comments
+2 more reviewers
@gribozavrgribozavrgribozavr left review comments
@jyn514jyn514jyn514 left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

@m-ou-sem-ou-se

Labels

S-inactiveStatus: Inactive and waiting on the author. This is often applied to closed PRs.S-waiting-on-authorStatus: This is awaiting some action (such as code changes or more information) from the author.T-libs-api[DEPRECATED; DO NOT USE]

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Docs for CStr.as_ptr() are describing CString

10 participants

@eggyal@rust-highfive@bstrie@rust-log-analyzer@crlf0710@JohnCSimon@m-ou-se@gribozavr@jyn514@rustbot