Improve {String,Vec}::from_raw_parts documentation #34884

shepmaster · 2016-07-17T14:55:45Z

No description provided.

rust-highfive · 2016-07-17T14:55:51Z

(rust_highfive has picked a reviewer for you, use r? to override)

nagisa · 2016-07-17T20:38:27Z

src/libcollections/string.rs

@@ -701,6 +701,13 @@ impl String {
    /// Violating these may cause problems like corrupting the allocator's
    /// internal datastructures.
    ///
+    /// The ownership of `ptr` is effectively transferred to the
+    /// `String` and the memory referred to by the pointer will be
+    /// deallocated when the `String` goes out of scope. Ensure that


Should say “dropped” instead “goes out of scope”. Going out of scope does not necessarily imply the drop (we do not guarantee that, for example) and its the dropping which handles the deallocation.

shepmaster · 2016-07-17T21:55:24Z

src/libcollections/string.rs

+    /// deallocated when the `String` is dropped. Ensure that
+    /// nothing else uses the pointer after calling this
+    /// function. Calling this function multiple times with the same
+    /// pointer is an error.


Github overzealously hid the unresolved previous conversation

nagisa · 2016-07-17T22:24:41Z

Seems good to me.

r=me.

nagisa · 2016-07-17T22:26:12Z

Oh, eh, I wonder whether the added paragraph is best under the Safety section. Maybe it would be better to add it just before it (right after the short description)?

GuillaumeGomez · 2016-07-17T22:40:09Z

After discussion on IRC:

@bors: r=nagisa rollup

Thanks @shepmaster!

bors · 2016-07-17T22:40:10Z

📌 Commit 661187a has been approved by @nagisa

bors · 2016-07-17T22:40:19Z

💡 This pull request was already approved, no need to approve it again.

There's another pull request that is currently being tested, blocking this pull request: Avoid reseting the thread local interner at the beginning of phase_1_parse_input #34856

bors · 2016-07-17T22:40:20Z

📌 Commit 661187a has been approved by @nagisa

…agisa

…agisa Improve {String,Vec}::from_raw_parts documentation

Rollup of 5 pull requests - Successful merges: #34807, #34853, #34875, #34884, #34889 - Failed merges:

rust-highfive assigned aturon Jul 17, 2016

nagisa reviewed Jul 17, 2016
View reviewed changes

shepmaster force-pushed the from_raw_parts_doc branch from 5eb8a74 to 66e610f Compare July 17, 2016 21:39

shepmaster reviewed Jul 17, 2016
View reviewed changes

shepmaster added 2 commits July 17, 2016 18:18

Document from_raw_parts involves ownership transfer

f6be6aa

Remove extraneous words

661187a

shepmaster force-pushed the from_raw_parts_doc branch from 66e610f to 661187a Compare July 17, 2016 22:19

sanxiyn mentioned this pull request Jul 18, 2016

Rollup of 5 pull requests #34898

Merged

sanxiyn added a commit to sanxiyn/rust that referenced this pull request Jul 18, 2016

Rollup merge of rust-lang#34884 - shepmaster:from_raw_parts_doc, r=@n…

1132a4d

…agisa Improve {String,Vec}::from_raw_parts documentation

bors added a commit that referenced this pull request Jul 19, 2016

Auto merge of #34898 - sanxiyn:rollup, r=sanxiyn

27e766d

Rollup of 5 pull requests - Successful merges: #34807, #34853, #34875, #34884, #34889 - Failed merges:

bors merged commit 661187a into rust-lang:master Jul 19, 2016

shepmaster deleted the from_raw_parts_doc branch July 19, 2016 18:43

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Improve {String,Vec}::from_raw_parts documentation #34884

Improve {String,Vec}::from_raw_parts documentation #34884

shepmaster commented Jul 17, 2016

rust-highfive commented Jul 17, 2016

nagisa Jul 17, 2016

shepmaster Jul 17, 2016

shepmaster Jul 17, 2016

nagisa commented Jul 17, 2016

nagisa commented Jul 17, 2016

GuillaumeGomez commented Jul 17, 2016 •

edited

Loading

bors commented Jul 17, 2016

bors commented Jul 17, 2016

bors commented Jul 17, 2016

Improve {String,Vec}::from_raw_parts documentation #34884

Improve {String,Vec}::from_raw_parts documentation #34884

Conversation

shepmaster commented Jul 17, 2016

rust-highfive commented Jul 17, 2016

nagisa Jul 17, 2016

Choose a reason for hiding this comment

shepmaster Jul 17, 2016

Choose a reason for hiding this comment

shepmaster Jul 17, 2016

Choose a reason for hiding this comment

nagisa commented Jul 17, 2016

nagisa commented Jul 17, 2016

GuillaumeGomez commented Jul 17, 2016 • edited Loading

bors commented Jul 17, 2016

bors commented Jul 17, 2016

bors commented Jul 17, 2016

GuillaumeGomez commented Jul 17, 2016 •

edited

Loading