Skip to content

Commit

Permalink
fix documentation of ptr::dangling() function
Browse files Browse the repository at this point in the history
  • Loading branch information
tifv committed Oct 23, 2024
1 parent ffd978b commit f4c8ff3
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
4 changes: 2 additions & 2 deletions library/core/src/ptr/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
4 changes: 1 addition & 3 deletions library/core/src/ptr/non_null.rs
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down

0 comments on commit f4c8ff3

Please sign in to comment.