about summary refs log tree commit diff
path: root/src/liballoc/alloc.rs
diff options
context:
space:
mode:
authorMazdak Farrokhzad <twingoow@gmail.com>2019-02-24 05:55:57 +0100
committerGitHub <noreply@github.com>2019-02-24 05:55:57 +0100
commit55b5ab83592d607a6ba8793ac76bedadb05e5bab (patch)
tree9130191c9fc3dd78b2e88633c54ad2d207737ea8 /src/liballoc/alloc.rs
parentae646687e0032564469f2c839063bee2485e88e4 (diff)
parente41e694d9e5a6bcb2109c936df9757879a65eb59 (diff)
downloadrust-55b5ab83592d607a6ba8793ac76bedadb05e5bab.tar.gz
rust-55b5ab83592d607a6ba8793ac76bedadb05e5bab.zip
Rollup merge of #58183 - jethrogb:jb/alloc-box-guarantees, r=SimonSapin
Clarify guarantees for `Box` allocation

This basically says `Box` does the obvious things for its allocations.

See also: https://users.rust-lang.org/t/alloc-crate-guarantees/24981

This may require a T-libs FCP? Not sure.

r? @sfackler
Diffstat (limited to 'src/liballoc/alloc.rs')
-rw-r--r--src/liballoc/alloc.rs3
1 files changed, 3 insertions, 0 deletions
diff --git a/src/liballoc/alloc.rs b/src/liballoc/alloc.rs
index ec652df3b37..f3877e51a66 100644
--- a/src/liballoc/alloc.rs
+++ b/src/liballoc/alloc.rs
@@ -34,6 +34,9 @@ extern "Rust" {
 /// This type implements the [`Alloc`] trait by forwarding calls
 /// to the allocator registered with the `#[global_allocator]` attribute
 /// if there is one, or the `std` crate’s default.
+///
+/// Note: while this type is unstable, the functionality it provides can be
+/// accessed through the [free functions in `alloc`](index.html#functions).
 #[unstable(feature = "allocator_api", issue = "32838")]
 #[derive(Copy, Clone, Default, Debug)]
 pub struct Global;