Skip to content

Commit bf6f8a4

Browse files
committed
Auto merge of #135009 - DiuDiu777:box-doc, r=jhpratt
Fix doc for missing Box allocator consistency ### Description: This PR addresses missing document regarding consistency of `Box::from_raw` and `Box::from_raw_in`. - [from_raw](https://doc.rust-lang.org/nightly/std/boxed/struct.Box.html#method.from_raw): The document now misses the raw pointer passed to `Box::from_raw` must point to a block of memory allocated by the `Global Allocator` (specified in source code). - [from_raw_in](https://doc.rust-lang.org/nightly/std/boxed/struct.Box.html#method.from_raw_in): The safety conditions don't include the allocator consistency. Besides, [Boxed Memory Layout](https://doc.rust-lang.org/nightly/std/boxed/index.html#memory-layout) doesn't explicitly cover the allocator consistency issue. This change builds upon the improvements made in [PR #134496](#134496).
2 parents c528b8c + a5494a8 commit bf6f8a4

File tree

1 file changed

+3
-0
lines changed

1 file changed

+3
-0
lines changed

library/alloc/src/boxed.rs

+3
Original file line numberDiff line numberDiff line change
@@ -1045,6 +1045,8 @@ impl<T: ?Sized> Box<T> {
10451045
/// memory problems. For example, a double-free may occur if the
10461046
/// function is called twice on the same raw pointer.
10471047
///
1048+
/// The raw pointer must point to a block of memory allocated by the global allocator.
1049+
///
10481050
/// The safety conditions are described in the [memory layout] section.
10491051
///
10501052
/// # Examples
@@ -1148,6 +1150,7 @@ impl<T: ?Sized, A: Allocator> Box<T, A> {
11481150
/// memory problems. For example, a double-free may occur if the
11491151
/// function is called twice on the same raw pointer.
11501152
///
1153+
/// The raw pointer must point to a block of memory allocated by `alloc`
11511154
///
11521155
/// # Examples
11531156
///

0 commit comments

Comments
 (0)