fix documentation of ptr::dangling() function

This commit is contained in:
July Tikhonov 2024-10-23 19:17:36 +06:00
parent ffd978b7bf
commit f4c8ff33de
2 changed files with 3 additions and 5 deletions

View File

@ -602,7 +602,7 @@ pub const fn without_provenance<T>(addr: usize) -> *const T {
unsafe { mem::transmute(addr) }
}
/// Creates a new pointer that is dangling, but well-aligned.
/// Creates a new pointer that is dangling, but non-null and well-aligned.
///
/// This is useful for initializing types which lazily allocate, like
/// `Vec::new` does.
@ -645,7 +645,7 @@ pub const fn without_provenance_mut<T>(addr: usize) -> *mut T {
unsafe { mem::transmute(addr) }
}
/// Creates a new pointer that is dangling, but well-aligned.
/// Creates a new pointer that is dangling, but non-null and well-aligned.
///
/// This is useful for initializing types which lazily allocate, like
/// `Vec::new` does.

View File

@ -107,9 +107,7 @@ impl<T: Sized> NonNull<T> {
#[must_use]
#[inline]
pub const fn dangling() -> Self {
// SAFETY: mem::align_of() returns a non-zero usize which is then casted
// to a *mut T. Therefore, `ptr` is not null and the conditions for
// calling new_unchecked() are respected.
// SAFETY: ptr::dangling_mut() returns a non-null well-aligned pointer.
unsafe {
let ptr = crate::ptr::dangling_mut::<T>();
NonNull::new_unchecked(ptr)