Mirrors/rust
1
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2026-04-29 11:51:31 +03:00
Code Issues Packages Projects Releases Wiki Activity

Rollup merge of #95630 - declanvk:update-nonnull-doc, r=RalfJung

Browse Source 
Update `NonNull` pointer provenance methods' documentation

 - Add links to equivalent methods on raw pointers
This commit is contained in:
Dylan DPC
2022-04-05 01:53:34 +02:00
committed by GitHub
parent 78f81f0d10 637592d8c3
commit 1c2b4b7af5
1 changed files with 8 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
library/core/src/ptr/non_null.rs
+8 -4
View File
@@ -256,8 +256,10 @@ pub const fn to_raw_parts(self) -> (NonNull<()>, <T as super::Pointee>::Metadata
/// Gets the "address" portion of the pointer.
///
/// For more details see the equivalent method on a raw pointer, [`pointer::addr`].
///
/// This API and its claimed semantics are part of the Strict Provenance experiment,
/// see the [module documentation][crate::ptr] for details.
/// see the [`ptr` module documentation][crate::ptr].
#[must_use]
#[inline]
#[unstable(feature = "strict_provenance", issue = "95228")]
@@ -272,8 +274,10 @@ pub fn addr(self) -> NonZeroUsize
/// Creates a new pointer with the given address.
///
/// For more details see the equivalent method on a raw pointer, [`pointer::with_addr`].
///
/// This API and its claimed semantics are part of the Strict Provenance experiment,
/// see the [module documentation][crate::ptr] for details.
/// see the [`ptr` module documentation][crate::ptr].
#[must_use]
#[inline]
#[unstable(feature = "strict_provenance", issue = "95228")]
@@ -287,10 +291,10 @@ pub fn with_addr(self, addr: NonZeroUsize) -> Self
/// Creates a new pointer by mapping `self`'s address to a new one.
///
/// This is a convenience for [`with_addr`][Self::with_addr], see that method for details.
/// For more details see the equivalent method on a raw pointer, [`pointer::map_addr`].
///
/// This API and its claimed semantics are part of the Strict Provenance experiment,
/// see the [module documentation][crate::ptr] for details.
/// see the [`ptr` module documentation][crate::ptr].
#[must_use]
#[inline]
#[unstable(feature = "strict_provenance", issue = "95228")]