document what "thin pointers" are

[droundy]

I got the following error message:

error: casting `*const T` as `usize` is invalid
  --> src/refset.rs:17:9
   |
17 |         (self.0 as *const T as usize).hash(state);
   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: cast through a thin pointer first

which was quite clear, except that there seems to be no documentation as to what a "thin" pointer is. I ended up through guesswork casting to a *const usize in between which made this work for me.

[steveklabnik]

/cc @rust-lang/lang ; I wonder what the official terminology here should be. I prefer the "single pointer"/"double pointer" language to the "thin pointer"/"fat pointer" stuff, but it seems to me that this diagnostic could use re-worked and possibly made even more clear. Thoughts?

also, re-tagging as compiler since I believe this is more of a diagnostic issue than a docs issue.

[hanna-kruppe]

"single pointer"/"double pointer" language

That's not really accurate though, is it? Slices are (pointer, len), not two pointers. There's also the possibility of custom DSTs which would permit fat pointers larger than two words.

[withoutboats]

I prefer the "single pointer"/"double pointer" language to the "thin pointer"/"fat pointer" stuff, but it seems to me that this diagnostic could use re-worked and possibly made even more clear.

I agree with rkruppe that 'double pointer' could be misleading, but think our language would be slightly more welcoming if we used 'wide pointer' in error messages instead of 'fat'.

[steveklabnik]

not two pointers

When I've heard it, it was referring to "double the size", not "two pointers" though that confusion is certainly a good reason to not have it.

👍 for "pointer"/"wide pointer"

[eddyb]

Would "non-wide pointer" make sense then?

[withoutboats]

Yea, I think in most cases "thin pointer" can probably just be "pointer," this error message (trying to cast wide pointer down) seems like the only one where its helpful to explicit mentioning the non-wideness of the pointer, based on a ripgrep.

"non-wide" or even just "regular" seems fine when you need to highlight the distinction of most pointers from wide pointers.

[nikomatsakis]

In light of the custom DST proposal, I've come to think of all pointers as "wide pointers", it's sort of just a question of what their auxiliary data is ("thin" pointers would have metadata of type ()). I wonder if we can avoid the terminology altogether, somehow? But it's not obvious how to adapt the error message to this POV. I think of "casting to a thin pointer" as basically replacing the wide pointer metadata with ().

[tlively]

I just ran into this issue and had no idea what was going on, so it would be great if this could be fixed.

(For anyone else confused about this thin pointer help message, you can fix it by adding an intermediate cast to some primitive pointer type like *const usize)

[ghost]

I just ran across this issue after encountering the mentioned error message. I was thoroughly confused, and while the solution of casting to *const usize instead of just usize works, I have no idea why that is the case (I prefer to understand how things work rather than just copying a solution from somewhere). I would really appreciate some further documentation on what thin pointers vs wide pointers are, when they are used and why, specifically when dyn Any is involved.

[QuineDot]

In light of RFC 2580, perhaps this could be something like

error: casting `*const T` as `usize` is invalid
  --> src/refset.rs:17:9
   |
17 |         (self.0 as *const T as usize).hash(state);
   |         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
   |
   = help: `*const T` may include non-zero sized metadata, such as a slice length or `dyn Trait` vtable
   = help: cast through a pointer that has no metadata first:
             (self.0 as *const T as *const () as usize).hash(state);

In non-generic cases, "non-zero sized metadata" could be replaced with something more specific. Post-stabilization, the hints could be updated to match the trait.

   = help: `*const T` may include non-zero sized metadata, such as a slice length or `dyn Trait` vtable
   = help: cast through a pointer that satisfies `Pointee<Metadata=()>` first: