about summary refs log tree commit diff
path: root/src/rustllvm/RustWrapper.cpp
diff options
context:
space:
mode:
authorJosh Triplett <josh@joshtriplett.org>2018-07-18 12:50:13 -0700
committerJosh Triplett <josh@joshtriplett.org>2018-07-18 13:00:35 -0700
commitce756321ba888c7701cb81febd1de2bd98f87724 (patch)
tree7b7783844717c800d85a8ef9cfb046b53bc9c864 /src/rustllvm/RustWrapper.cpp
parent12ed235adc62e63b16bb4f715b143c37a5efa00d (diff)
downloadrust-ce756321ba888c7701cb81febd1de2bd98f87724.tar.gz
rust-ce756321ba888c7701cb81febd1de2bd98f87724.zip
Document that Unique::empty() and NonNull::dangling() aren't sentinel values
The documentation of Unique::empty() and NonNull::dangling() could
potentially suggest that they work as sentinel values indicating a
not-yet-initialized pointer. However, they both declare a non-null
pointer equal to the alignment of the type, which could potentially
reference a valid value of that type (specifically, the first such valid
value in memory). Explicitly document that the return value of these
functions does not work as a sentinel value.
Diffstat (limited to 'src/rustllvm/RustWrapper.cpp')
0 files changed, 0 insertions, 0 deletions