Skip to content

Commit 654a955

Browse files
committed
mention provenance in the pointer::wrapping_offset docs
fixes rust-lang#139008
1 parent f2ae9c4 commit 654a955

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

core/src/ptr/const_ptr.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -483,8 +483,9 @@ impl<T: ?Sized> *const T {
483483
///
484484
/// This operation itself is always safe, but using the resulting pointer is not.
485485
///
486-
/// The resulting pointer "remembers" the [allocated object] that `self` points to; it must not
487-
/// be used to read or write other allocated objects.
486+
/// The resulting pointer "remembers" the [allocated object] that `self` points to
487+
/// (this is called "[Provenance](ptr/index.html#provenance)").
488+
/// The pointer must not be used to read or write other allocated objects.
488489
///
489490
/// In other words, `let z = x.wrapping_offset((y as isize) - (x as isize))` does *not* make `z`
490491
/// the same as `y` even if we assume `T` has size `1` and there is no overflow: `z` is still

core/src/ptr/mut_ptr.rs

+3-2
Original file line numberDiff line numberDiff line change
@@ -482,8 +482,9 @@ impl<T: ?Sized> *mut T {
482482
///
483483
/// This operation itself is always safe, but using the resulting pointer is not.
484484
///
485-
/// The resulting pointer "remembers" the [allocated object] that `self` points to; it must not
486-
/// be used to read or write other allocated objects.
485+
/// The resulting pointer "remembers" the [allocated object] that `self` points to
486+
/// (this is called "[Provenance](ptr/index.html#provenance)").
487+
/// The pointer must not be used to read or write other allocated objects.
487488
///
488489
/// In other words, `let z = x.wrapping_offset((y as isize) - (x as isize))` does *not* make `z`
489490
/// the same as `y` even if we assume `T` has size `1` and there is no overflow: `z` is still

0 commit comments

Comments
 (0)