Skip to content

Document raw pointer <-> usize casts. #970

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
May 17, 2021
Merged

Document raw pointer <-> usize casts. #970

Changes from 3 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
d65e590
Document raw pointer <-> usize casts.
Feb 28, 2021
ec33e2b
Address to pointer cast: hint at provenance.
Mar 8, 2021
b144532
Pointer<->address cast: stylistic changes.
Mar 8, 2021
f41e1a8
Reformat cast expression details.
ben0x539 Apr 28, 2021
b794f8a
Expand on pointer<->address casts without mentioning provenance.
ben0x539 Apr 28, 2021
96a811a
Fix warning block for pointer<->integer cast expression.
ben0x539 Apr 28, 2021
c11c649
Fix reformatting mishap.
ben0x539 Apr 28, 2021
a2cae39
Make the pointer to address cast example sounder.
ben0x539 Apr 28, 2021
771cce3
Justify "4".
ben0x539 Apr 28, 2021
dc1931a
Use markdown link instead of HTML.
ehuss May 17, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions src/expressions/operator-expr.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -360,6 +360,18 @@ Here `*T` means either `*const T` or `*mut T`.
* `char` casts to the value of the code point, then uses a numeric cast if needed.
* `u8` to `char` cast
* Casts to the `char` with the corresponding code point.
* Pointer to address cast
* Casting from a valid raw pointer to `usize` will produce the address that is pointed to.

The pointer's provenance is lost in this conversion.
* Address to pointer cast
* Casting from `usize` to a raw pointer will produce a raw pointer to the same location as the original pointer, if the `usize` was obtained through a pointer to address cast of a valid pointer.

<div class="warning">
Warning:
The two pointers are not equivalent.
Dereferencing the pointer obtained from the address to pointer cast may be <a href="../behavior-considered-undefined.md">undefined behavior</a> if aliasing rules are not followed.
</div>

\* if integer-to-float casts with this rounding mode and overflow behavior are
not supported natively by the hardware, these casts will likely be slower than
Expand Down