diff options
| author | Yoshua Wuyts <yoshuawuyts@gmail.com> | 2020-11-20 15:25:43 +0100 |
|---|---|---|
| committer | Yoshua Wuyts <yoshuawuyts@gmail.com> | 2021-01-22 18:15:28 +0100 |
| commit | 7d102383f97c1616cffce5ca72ff12eabd9603bf (patch) | |
| tree | e693cfad89c88181d4269c71a2a491ec5dafbe6a | |
| parent | bbc01bb624a960533e049fdb98d0489ff2a8de06 (diff) | |
| download | rust-7d102383f97c1616cffce5ca72ff12eabd9603bf.tar.gz rust-7d102383f97c1616cffce5ca72ff12eabd9603bf.zip | |
Add doc aliases for memory allocations
- Vec::with_capacity / Box::new -> alloc + malloc
- Box::new_zeroed -> calloc
- Vec::{reserve,reserve_exact,try_reserve_exact,shrink_to_fit,shrink_to} -> realloc
| -rw-r--r-- | library/alloc/src/boxed.rs | 7 | ||||
| -rw-r--r-- | library/alloc/src/macros.rs | 2 | ||||
| -rw-r--r-- | library/alloc/src/string.rs | 2 | ||||
| -rw-r--r-- | library/alloc/src/vec/mod.rs | 7 |
4 files changed, 16 insertions, 2 deletions
diff --git a/library/alloc/src/boxed.rs b/library/alloc/src/boxed.rs index 0aa52b35ced..dacf6f8d830 100644 --- a/library/alloc/src/boxed.rs +++ b/library/alloc/src/boxed.rs @@ -178,8 +178,10 @@ impl<T> Box<T> { /// ``` /// let five = Box::new(5); /// ``` - #[stable(feature = "rust1", since = "1.0.0")] #[inline(always)] + #[doc(alias = "alloc")] + #[doc(alias = "malloc")] + #[stable(feature = "rust1", since = "1.0.0")] pub fn new(x: T) -> Self { box x } @@ -226,8 +228,9 @@ impl<T> Box<T> { /// ``` /// /// [zeroed]: mem::MaybeUninit::zeroed - #[unstable(feature = "new_uninit", issue = "63291")] #[inline] + #[doc(alias = "calloc")] + #[unstable(feature = "new_uninit", issue = "63291")] pub fn new_zeroed() -> Box<mem::MaybeUninit<T>> { Self::new_zeroed_in(Global) } diff --git a/library/alloc/src/macros.rs b/library/alloc/src/macros.rs index 3a46763c3f6..73f68b88488 100644 --- a/library/alloc/src/macros.rs +++ b/library/alloc/src/macros.rs @@ -35,6 +35,8 @@ /// /// [`Vec`]: crate::vec::Vec #[cfg(not(test))] +#[doc(alias = "alloc")] +#[doc(alias = "malloc")] #[macro_export] #[stable(feature = "rust1", since = "1.0.0")] #[allow_internal_unstable(box_syntax, liballoc_internals)] diff --git a/library/alloc/src/string.rs b/library/alloc/src/string.rs index 6f2a497598d..b1f860d6b64 100644 --- a/library/alloc/src/string.rs +++ b/library/alloc/src/string.rs @@ -403,6 +403,8 @@ impl String { /// s.push('a'); /// ``` #[inline] + #[doc(alias = "alloc")] + #[doc(alias = "malloc")] #[stable(feature = "rust1", since = "1.0.0")] pub fn with_capacity(capacity: usize) -> String { String { vec: Vec::with_capacity(capacity) } diff --git a/library/alloc/src/vec/mod.rs b/library/alloc/src/vec/mod.rs index 0f5feb4ab8d..b533ce79420 100644 --- a/library/alloc/src/vec/mod.rs +++ b/library/alloc/src/vec/mod.rs @@ -433,6 +433,7 @@ impl<T> Vec<T> { /// assert!(vec.capacity() >= 11); /// ``` #[inline] + #[doc(alias = "malloc")] #[stable(feature = "rust1", since = "1.0.0")] pub fn with_capacity(capacity: usize) -> Self { Self::with_capacity_in(capacity, Global) @@ -766,6 +767,7 @@ impl<T, A: Allocator> Vec<T, A> { /// vec.reserve(10); /// assert!(vec.capacity() >= 11); /// ``` + #[doc(alias = "realloc")] #[stable(feature = "rust1", since = "1.0.0")] pub fn reserve(&mut self, additional: usize) { self.buf.reserve(self.len, additional); @@ -791,6 +793,7 @@ impl<T, A: Allocator> Vec<T, A> { /// vec.reserve_exact(10); /// assert!(vec.capacity() >= 11); /// ``` + #[doc(alias = "realloc")] #[stable(feature = "rust1", since = "1.0.0")] pub fn reserve_exact(&mut self, additional: usize) { self.buf.reserve_exact(self.len, additional); @@ -828,6 +831,7 @@ impl<T, A: Allocator> Vec<T, A> { /// } /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?"); /// ``` + #[doc(alias = "realloc")] #[unstable(feature = "try_reserve", reason = "new API", issue = "48043")] pub fn try_reserve(&mut self, additional: usize) -> Result<(), TryReserveError> { self.buf.try_reserve(self.len, additional) @@ -869,6 +873,7 @@ impl<T, A: Allocator> Vec<T, A> { /// } /// # process_data(&[1, 2, 3]).expect("why is the test harness OOMing on 12 bytes?"); /// ``` + #[doc(alias = "realloc")] #[unstable(feature = "try_reserve", reason = "new API", issue = "48043")] pub fn try_reserve_exact(&mut self, additional: usize) -> Result<(), TryReserveError> { self.buf.try_reserve_exact(self.len, additional) @@ -888,6 +893,7 @@ impl<T, A: Allocator> Vec<T, A> { /// vec.shrink_to_fit(); /// assert!(vec.capacity() >= 3); /// ``` + #[doc(alias = "realloc")] #[stable(feature = "rust1", since = "1.0.0")] pub fn shrink_to_fit(&mut self) { // The capacity is never less than the length, and there's nothing to do when @@ -920,6 +926,7 @@ impl<T, A: Allocator> Vec<T, A> { /// vec.shrink_to(0); /// assert!(vec.capacity() >= 3); /// ``` + #[doc(alias = "realloc")] #[unstable(feature = "shrink_to", reason = "new API", issue = "56431")] pub fn shrink_to(&mut self, min_capacity: usize) { self.buf.shrink_to_fit(cmp::max(self.len, min_capacity)); |
