Add more docs - mostly warnings - to std::mem::transmute #34609

strega-nil · 2016-07-02T06:34:53Z

No description provided.

rust-highfive · 2016-07-02T06:34:59Z

r? @aturon

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

strega-nil · 2016-07-02T06:35:18Z

r? @steveklabnik

strega-nil · 2016-07-02T06:36:48Z

Perhaps I should also add an example for casting to usize.

arielb1 · 2016-07-02T15:16:58Z

transmute can also be used to transform a Vec<Option<&T>> to a Vec<&T>.

strega-nil · 2016-07-02T15:31:15Z

@arielb1 Ah, good for the alternatives section!

ollie27 · 2016-07-03T08:46:54Z

src/libcore/intrinsics.rs

@@ -278,17 +278,157 @@ extern "rust-intrinsic" {
    /// Moves a value out of scope without running drop glue.
    pub fn forget<T>(_: T) -> ();

-    /// Unsafely transforms a value of one type into a value of another type.
+    /// Reinterprets the bits of a value of one type as another type. Both types


The first paragraph needs to be a single sentence as it's used as a short summary on the module page and search results.

ollie27 · 2016-07-03T09:03:24Z

A lot of these examples aren't compiling, check the travis output and try them locally. I suggest you put each example in it's own code block so they run individually and some examples like the libc one need to be marked ignore as that won't even compile.

strega-nil · 2016-07-03T09:06:59Z

@ollie27 Yeah, I've obviously never written documentation like this before xP

strega-nil · 2016-07-04T09:19:35Z

@ollie27 Okay, I can't actually try it locally due to LLDB failures. I'm... not willing to continue to try this. If someone else wants to pick this up, they can, but goddamnit, I've spent a fucking day trying to get rustc to compile. This is ridiculous.

Edit: Alright, it's working now. The rustc new-dev experience is... not great :P

ollie27 · 2016-07-05T09:26:29Z

You shouldn't need to compile rustc to try these. If you have a working rustdoc you can copy this doc block into it's own file and run rustdoc --test on that. You can also use https://play.rust-lang.org/.

steveklabnik · 2016-07-05T15:50:56Z

I suggest you put each example in it's own code block so they run individually and some examples like the libc one need to be marked ignore as that won't even compile.

Yes please to both of these!

steveklabnik · 2016-07-05T18:02:02Z

src/libcore/intrinsics.rs

+    /// are as follows:
+    ///
+    /// Turning a pointer into a `usize`:
+    /// ```


can you put a blank line between the triple backticks and the descriptions? This applies throughout the file.

steveklabnik · 2016-07-21T19:15:42Z

src/libcore/intrinsics.rs

+    /// `transmute` is semantically equivalent to a bitwise move of one type
+    /// into another. It copies the bits from the destination type into the
+    /// source type, then forgets the original. If you know C or C++, it's like
+    /// `memcpy` under the hood.


We usually don't refer to other languages in the docs. I would just say

then forgets the original, like memcpy.

steveklabnik · 2016-07-21T19:17:38Z

@ubsan thanks for all the work on this, it's improved greatly 😄

I have some extremely small nits and then this is good to go, I think.

steveklabnik · 2016-07-21T19:58:59Z

@bors: r+ rollup

bors · 2016-07-21T19:59:01Z

📌 Commit 24f8589 has been approved by steveklabnik

bors · 2016-07-21T19:59:04Z

⌛ Testing commit 24f8589 with merge 3850b22...

bors · 2016-07-21T20:04:31Z

💔 Test failed - auto-win-gnu-32-opt

alexcrichton · 2016-07-21T20:29:44Z

@bors: retry

On Thu, Jul 21, 2016 at 1:04 PM, bors notifications@github.com wrote:

💔 Test failed - auto-win-gnu-32-opt
https://buildbot.rust-lang.org/builders/auto-win-gnu-32-opt/builds/5024

—
You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
#34609 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAD95G2-XT29Gv4h4UxzWq6n25TnPZ3Pks5qX9DSgaJpZM4JDnTq
.

steveklabnik · 2016-07-25T18:28:15Z

@bors: retry

alexcrichton · 2016-07-25T18:39:05Z

@bors: retry (maybe third time's the charm)

Add more docs - mostly warnings - to std::mem::transmute

Rollup of 13 pull requests - Successful merges: #34461, #34609, #34732, #34850, #34894, #34935, #34974, #34990, #34995, #35001, #35009, #35010, #35028 - Failed merges:

bors · 2016-07-26T10:58:46Z

⌛ Testing commit 24f8589 with merge 2094bc3...

bors · 2016-07-26T11:03:11Z

💔 Test failed - auto-win-msvc-64-opt

alexcrichton · 2016-07-26T17:17:14Z

@bors: retry

On Tue, Jul 26, 2016 at 4:03 AM, bors notifications@github.com wrote:

💔 Test failed - auto-win-msvc-64-opt
https://buildbot.rust-lang.org/builders/auto-win-msvc-64-opt/builds/5083

—
You are receiving this because you are on a team that was mentioned.
Reply to this email directly, view it on GitHub
#34609 (comment), or mute
the thread
https://github.com/notifications/unsubscribe-auth/AAD95JTonEuCnHepaRi5964EO9N3lIeQks5qZelygaJpZM4JDnTq
.

Add more docs - mostly warnings - to std::mem::transmute

Rollup of 15 pull requests - Successful merges: #34461, #34609, #34732, #34850, #34935, #34974, #34990, #34995, #35001, #35009, #35010, #35019, #35028, #35029, #35043 - Failed merges:

Add more docs - mostly warnings - to std::mem::transmute

3d03f75

rust-highfive assigned aturon Jul 2, 2016

rust-highfive assigned steveklabnik and unassigned aturon Jul 2, 2016

ubsan added 3 commits July 1, 2016 23:57

Fix up some things which scott mentioned

233b45f

Fix some other small nits

6928bbb

More nits :P

2413b52

ubsan added 2 commits July 2, 2016 08:45

Add a new alternative

377bbfe

Make sure the documentation compiles

9e94ebf

ollie27 reviewed Jul 3, 2016
View reviewed changes

Fix tests

7ec44e6

steveklabnik reviewed Jul 5, 2016
View reviewed changes

steveklabnik reviewed Jul 21, 2016
View reviewed changes

Fix nits

24f8589

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 25, 2016

Rollup merge of rust-lang#34609 - ubsan:transmute_docs, r=steveklabnik

ee771bf

Add more docs - mostly warnings - to std::mem::transmute

steveklabnik mentioned this pull request Jul 25, 2016

Rollup of 13 pull requests #35036

Closed

steveklabnik added a commit to steveklabnik/rust that referenced this pull request Jul 26, 2016

Rollup merge of rust-lang#34609 - ubsan:transmute_docs, r=steveklabnik

4c95b66

Add more docs - mostly warnings - to std::mem::transmute

steveklabnik mentioned this pull request Jul 26, 2016

Rollup of 15 pull requests #35053

Merged

bors merged commit 24f8589 into rust-lang:master Jul 27, 2016

strega-nil deleted the transmute_docs branch September 11, 2018 05:38

wchargin mentioned this pull request Nov 24, 2020

transmute_ptr_to_ptr doesn’t justify its existence rust-lang/rust-clippy#6372

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add more docs - mostly warnings - to std::mem::transmute #34609

Add more docs - mostly warnings - to std::mem::transmute #34609

strega-nil commented Jul 2, 2016

rust-highfive commented Jul 2, 2016

strega-nil commented Jul 2, 2016

strega-nil commented Jul 2, 2016

arielb1 commented Jul 2, 2016 •

edited

Loading

strega-nil commented Jul 2, 2016

ollie27 Jul 3, 2016

ollie27 commented Jul 3, 2016

strega-nil commented Jul 3, 2016

strega-nil commented Jul 4, 2016 •

edited

Loading

ollie27 commented Jul 5, 2016

steveklabnik commented Jul 5, 2016

steveklabnik Jul 5, 2016

steveklabnik Jul 21, 2016

steveklabnik commented Jul 21, 2016

steveklabnik commented Jul 21, 2016

bors commented Jul 21, 2016

bors commented Jul 21, 2016

bors commented Jul 21, 2016

alexcrichton commented Jul 21, 2016

steveklabnik commented Jul 25, 2016

alexcrichton commented Jul 25, 2016

bors commented Jul 26, 2016

bors commented Jul 26, 2016

alexcrichton commented Jul 26, 2016

Add more docs - mostly warnings - to std::mem::transmute #34609

Add more docs - mostly warnings - to std::mem::transmute #34609

Conversation

strega-nil commented Jul 2, 2016

rust-highfive commented Jul 2, 2016

strega-nil commented Jul 2, 2016

strega-nil commented Jul 2, 2016

arielb1 commented Jul 2, 2016 • edited Loading

strega-nil commented Jul 2, 2016

ollie27 Jul 3, 2016

Choose a reason for hiding this comment

ollie27 commented Jul 3, 2016

strega-nil commented Jul 3, 2016

strega-nil commented Jul 4, 2016 • edited Loading

ollie27 commented Jul 5, 2016

steveklabnik commented Jul 5, 2016

steveklabnik Jul 5, 2016

Choose a reason for hiding this comment

steveklabnik Jul 21, 2016

Choose a reason for hiding this comment

steveklabnik commented Jul 21, 2016

steveklabnik commented Jul 21, 2016

bors commented Jul 21, 2016

bors commented Jul 21, 2016

bors commented Jul 21, 2016

alexcrichton commented Jul 21, 2016

steveklabnik commented Jul 25, 2016

alexcrichton commented Jul 25, 2016

bors commented Jul 26, 2016

bors commented Jul 26, 2016

alexcrichton commented Jul 26, 2016

arielb1 commented Jul 2, 2016 •

edited

Loading

strega-nil commented Jul 4, 2016 •

edited

Loading