about summary refs log tree commit diff
diff options
context:
space:
mode:
authorasquared31415 <34665709+asquared31415@users.noreply.github.com>2021-11-09 07:13:53 -0500
committerasquared31415 <34665709+asquared31415@users.noreply.github.com>2021-11-09 07:13:53 -0500
commitdb4e60b29f863bbf78351b7f095b221ffe7b93a6 (patch)
tree166590c56ac4ca99f7766057cb0d3dcd237311d5
parent214cd1f228a463b59f73ee46c8ae3b30f85de253 (diff)
downloadrust-db4e60b29f863bbf78351b7f095b221ffe7b93a6.tar.gz
rust-db4e60b29f863bbf78351b7f095b221ffe7b93a6.zip
document Box and box_free connection
-rw-r--r--library/alloc/src/boxed.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/library/alloc/src/boxed.rs b/library/alloc/src/boxed.rs
index bd4f5256042..f6332b072cf 100644
--- a/library/alloc/src/boxed.rs
+++ b/library/alloc/src/boxed.rs
@@ -169,6 +169,9 @@ use crate::vec::Vec;
 #[lang = "owned_box"]
 #[fundamental]
 #[stable(feature = "rust1", since = "1.0.0")]
+// The declaration of the `Box` struct must be kept in sync with the
+// `alloc::alloc::box_free` function or ICEs will happen. See the comment
+// on `box_free` for more details.
 pub struct Box<
     T: ?Sized,
     #[unstable(feature = "allocator_api", issue = "32838")] A: Allocator = Global,