Document From trait implementations for OsStr, OsString, CString, and CStr #52340

cypher · 2018-07-13T10:53:57Z

As part of issue #51430 (cc @skade).

The allocation and copy claims should be double-checked.

rust-highfive · 2018-07-13T10:54:00Z

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @steveklabnik (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

rust-highfive · 2018-07-13T12:16:25Z

The job x86_64-gnu-llvm-5.0 of your PR failed on Travis (raw log). Through arcane magic we have determined that the following fragments from the build log may contain information about the problem.

Click to expand the log.

[01:19:33] travis_fold:end:stage0-linkchecker

[01:19:33] travis_time:end:stage0-linkchecker:start=1531484156982743671,finish=1531484159599167196,duration=2616423525

[01:19:36] std/io/struct.Error.html:190: broken link - std/io/struct.NulError.html
[01:19:37] std/sync/struct.Arc.html:399: broken link - std/sync/struct.CString.html
[01:19:37] std/sync/struct.Arc.html:401: broken link - std/sync/struct.OsString.html
[01:19:39] std/boxed/struct.Box.html:297: broken link - std/boxed/struct.CString.html
[01:19:39] std/boxed/struct.Box.html:300: broken link - std/boxed/struct.CString.html
[01:19:39] std/boxed/struct.Box.html:304: broken link - std/boxed/struct.OsString.html
[01:19:42] std/rc/struct.Rc.html:289: broken link - std/rc/struct.CString.html
[01:19:42] std/rc/struct.Rc.html:291: broken link - std/rc/struct.OsString.html
[01:19:42] std/vec/struct.Vec.html:1931: broken link - std/vec/struct.CString.html
[01:19:42] std/vec/struct.Vec.html:1932: broken link - std/vec/struct.CString.html
[01:19:54] thread 'main' panicked at 'found some broken links', tools/linkchecker/main.rs:49:9
[01:19:54] 
[01:19:54] 
[01:19:54] command did not execute successfully: "/checkout/obj/build/x86_64-unknown-linux-gnu/stage0-tools-bin/linkchecker" "/checkout/obj/build/x86_64-unknown-linux-gnu/doc"
[01:19:54] expected success, got: exit code: 101
[01:19:54] expected success, got: exit code: 101
[01:19:54] 
[01:19:54] 
[01:19:54] failed to run: /checkout/obj/build/bootstrap/debug/bootstrap test
[01:19:54] Build completed unsuccessfully in 0:32:39
[01:19:54] make: *** [check] Error 1
[01:19:54] Makefile:58: recipe for target 'check' failed

The command "stamp sh -x -c "$RUN_SCRIPT"" exited with 2.
travis_time:start:063e39b7
$ date && (curl -fs --head https://google.com | grep ^Date: | sed 's/Date: //g' || true)

I'm a bot! I can only do what humans tell me to, so if this was not helpful or you have suggestions for improvements, please ping or otherwise contact @TimNN. (Feature Requests)

cypher · 2018-07-16T18:37:52Z

Fixed a few broken links, and rebased against current master.

stokhos · 2018-07-21T05:23:29Z

Ping from triage! @steveklabnik will you have time to review this PR?

steveklabnik

One tiny tweak and then this is good to go! Thanks a ton :)

steveklabnik · 2018-07-23T13:14:58Z

src/libstd/ffi/c_str.rs

@@ -642,6 +642,11 @@ impl fmt::Debug for CString {

 #[stable(feature = "cstring_into", since = "1.7.0")]
 impl From<CString> for Vec<u8> {
+    /// Converts a [`CString`] into a [`Vec`]`<u8>`.
+    /// The conversion consumes the [`CString`], and removes the terminating NUL byte.


You need a blank /// above this line to separate the summary from the rest of the content

steveklabnik · 2018-07-23T13:15:10Z

src/libstd/ffi/os_str.rs

@@ -348,6 +348,11 @@ impl OsString {

 #[stable(feature = "rust1", since = "1.0.0")]
 impl From<String> for OsString {
+    /// Converts a [`String`] into a [`OsString`].
+    /// The conversion copies the data, and includes an allocation on the heap.


cypher · 2018-07-23T13:38:41Z

@steveklabnik Done and done!

pietroalbini · 2018-07-30T17:17:59Z

Ping from triage @steveklabnik! This PR needs your review.

steveklabnik · 2018-07-30T17:58:15Z

@bors: r+ rollup

thanks!

bors · 2018-07-30T17:58:16Z

📌 Commit ed5edcb has been approved by steveklabnik

@skade

…r=steveklabnik Document From trait implementations for OsStr, OsString, CString, and CStr As part of issue rust-lang#51430 (cc @skade). The allocation and copy claims should be double-checked. r? @steveklabnik

@skade

…r=steveklabnik Document From trait implementations for OsStr, OsString, CString, and CStr As part of issue rust-lang#51430 (cc @skade). The allocation and copy claims should be double-checked. r? @steveklabnik

@skade

…r=steveklabnik Document From trait implementations for OsStr, OsString, CString, and CStr As part of issue rust-lang#51430 (cc @skade). The allocation and copy claims should be double-checked. r? @steveklabnik

@ghost

Rollup of 31 pull requests Successful merges: - #52332 (dead-code lint: say "constructed" for structs) - #52340 (Document From trait implementations for OsStr, OsString, CString, and CStr) - #52628 (Cleanup some rustdoc code) - #52732 (Remove unstable and deprecated APIs) - #52745 (Update clippy to latest master) - #52756 (rustc: Disallow machine applicability in foreign macros) - #52771 (Clarify thread::park semantics) - #52810 ([NLL] Don't make "fake" match variables mutable) - #52821 (pretty print for std::collections::vecdeque) - #52822 (Fix From<LocalWaker>) - #52824 (Fix -Wpessimizing-move warnings in rustllvm/PassWrapper) - #52831 (remove references to AUTHORS.txt file) - #52835 (Fix Alias intra doc ICE) - #52842 (update comment) - #52846 (Add timeout to use of `curl` in bootstrap.py.) - #52851 (Make the tool_lints actually usable) - #52853 (Improve bootstrap help on stages) - #52859 (Use Vec::extend in SmallVec::extend when applicable) - #52861 (Add targets for HermitCore (https://hermitcore.org) to the Rust compiler and port libstd to it.) - #52867 (releases.md: fix 2 typos) - #52870 (Implement Unpin for FutureObj and LocalFutureObj) - #52876 (run-pass/const-endianness: negate before to_le()) - #52878 (Fix wrong issue number in the test name) - #52883 (Include lifetime in mutability suggestion in NLL messages) - #52904 (NLL: sort diagnostics by span) - #52905 (Fix a typo in unsize.rs) - #52907 (NLL: On "cannot move out of type" error, print original before rewrite) - #52908 (Use SetLenOnDrop in Vec::truncate()) - #52914 (Only run the sparc-abi test on sparc) - #52918 (Backport 1.27.2 release notes) - #52929 (Update compatibility note for 1.28.0 to be correct) Failed merges: - #52758 (Cleanup for librustc::session) - #52799 (Use BitVector for global sets of AttrId) r? @ghost

@skade

…r=steveklabnik Document From trait implementations for OsStr, OsString, CString, and CStr As part of issue rust-lang#51430 (cc @skade). The allocation and copy claims should be double-checked. r? @steveklabnik

@ghost

Rollup of 30 pull requests Successful merges: - #52340 (Document From trait implementations for OsStr, OsString, CString, and CStr) - #52628 (Cleanup some rustdoc code) - #52732 (Remove unstable and deprecated APIs) - #52745 (Update clippy to latest master) - #52771 (Clarify thread::park semantics) - #52778 (Improve readability of serialize.rs) - #52810 ([NLL] Don't make "fake" match variables mutable) - #52821 (pretty print for std::collections::vecdeque) - #52822 (Fix From<LocalWaker>) - #52824 (Fix -Wpessimizing-move warnings in rustllvm/PassWrapper) - #52825 (Make sure #47772 does not regress) - #52831 (remove references to AUTHORS.txt file) - #52842 (update comment) - #52846 (Add timeout to use of `curl` in bootstrap.py.) - #52851 (Make the tool_lints actually usable) - #52853 (Improve bootstrap help on stages) - #52859 (Use Vec::extend in SmallVec::extend when applicable) - #52861 (Add targets for HermitCore (https://hermitcore.org) to the Rust compiler and port libstd to it.) - #52867 (releases.md: fix 2 typos) - #52870 (Implement Unpin for FutureObj and LocalFutureObj) - #52876 (run-pass/const-endianness: negate before to_le()) - #52878 (Fix wrong issue number in the test name) - #52883 (Include lifetime in mutability suggestion in NLL messages) - #52888 (Use suggestions for shell format arguments) - #52904 (NLL: sort diagnostics by span) - #52905 (Fix a typo in unsize.rs) - #52907 (NLL: On "cannot move out of type" error, print original before rewrite) - #52914 (Only run the sparc-abi test on sparc) - #52918 (Backport 1.27.2 release notes) - #52929 (Update compatibility note for 1.28.0 to be correct) Failed merges: r? @ghost

rust-highfive assigned steveklabnik Jul 13, 2018

rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Jul 13, 2018

cypher added 2 commits July 16, 2018 20:37

Document From conversions for OsString and OsStr

acdafa0

Document From conversions for CString and CStr

b81ee0b

steveklabnik reviewed Jul 23, 2018

View reviewed changes

Seperate summaries from rest of the comment

ed5edcb

bors 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 30, 2018

Mark-Simulacrum mentioned this pull request Jul 30, 2018

Rollup of 22 pull requests #52882

Closed

Mark-Simulacrum mentioned this pull request Jul 31, 2018

Rollup of 21 pull requests #52902

Closed

GuillaumeGomez mentioned this pull request Jul 31, 2018

Rollup of 20 pull requests #52916

Closed

Mark-Simulacrum mentioned this pull request Aug 1, 2018

Rollup of 31 pull requests #52931

Closed

pietroalbini mentioned this pull request Aug 1, 2018

Rollup of 30 pull requests #52937

Merged

bors merged commit ed5edcb into rust-lang:master Aug 1, 2018

cypher deleted the document-from-trait-in-ffi branch August 1, 2018 11:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Document From trait implementations for OsStr, OsString, CString, and CStr #52340

Document From trait implementations for OsStr, OsString, CString, and CStr #52340

cypher commented Jul 13, 2018

rust-highfive commented Jul 13, 2018

rust-highfive commented Jul 13, 2018

cypher commented Jul 16, 2018

stokhos commented Jul 21, 2018

steveklabnik left a comment

steveklabnik Jul 23, 2018

steveklabnik Jul 23, 2018

cypher commented Jul 23, 2018

pietroalbini commented Jul 30, 2018

steveklabnik commented Jul 30, 2018

bors commented Jul 30, 2018

Document From trait implementations for OsStr, OsString, CString, and CStr #52340

Document From trait implementations for OsStr, OsString, CString, and CStr #52340

Conversation

cypher commented Jul 13, 2018

rust-highfive commented Jul 13, 2018

rust-highfive commented Jul 13, 2018

cypher commented Jul 16, 2018

stokhos commented Jul 21, 2018

steveklabnik left a comment

Choose a reason for hiding this comment

steveklabnik Jul 23, 2018

Choose a reason for hiding this comment

steveklabnik Jul 23, 2018

Choose a reason for hiding this comment

cypher commented Jul 23, 2018

pietroalbini commented Jul 30, 2018

steveklabnik commented Jul 30, 2018

bors commented Jul 30, 2018