From: Tim Diekmann <tim.diekmann@3dvision.de>
Date: Wed, 25 Mar 2020 17:44:29 +0000 (+0100)
Subject: Refine docs for `RawVec::from_raw_parts(_in)`
X-Git-Url: https://git.lizzy.rs/?a=commitdiff_plain;h=ad7de67a32d40360ad36d03845c5a7004ba68150;p=rust.git

Refine docs for `RawVec::from_raw_parts(_in)`
---

diff --git a/src/liballoc/raw_vec.rs b/src/liballoc/raw_vec.rs
index ba810bf5faf..79dfa7b6b45 100644
--- a/src/liballoc/raw_vec.rs
+++ b/src/liballoc/raw_vec.rs
@@ -100,10 +100,11 @@ pub fn with_capacity_zeroed(capacity: usize) -> Self {
 
     /// Reconstitutes a `RawVec` from a pointer and capacity.
     ///
-    /// # Undefined Behavior
+    /// # Safety
     ///
     /// The `ptr` must be allocated (on the system heap), and with the given `capacity`.
-    /// The `capacity` cannot exceed `isize::MAX` (only a concern on 32-bit systems).
+    /// The `capacity` cannot exceed `isize::MAX` for sized types. (only a concern on 32-bit
+    /// systems). ZSTs may have a capacity up to `usize::MAX`.
     /// If the `ptr` and `capacity` come from a `RawVec`, then this is guaranteed.
     #[inline]
     pub unsafe fn from_raw_parts(ptr: *mut T, capacity: usize) -> Self {
@@ -160,10 +161,11 @@ fn allocate_in(capacity: usize, init: AllocInit, mut alloc: A) -> Self {
 
     /// Reconstitutes a `RawVec` from a pointer, capacity, and allocator.
     ///
-    /// # Undefined Behavior
+    /// # Safety
     ///
     /// The `ptr` must be allocated (via the given allocator `a`), and with the given `capacity`.
-    /// The `capacity` cannot exceed `isize::MAX` (only a concern on 32-bit systems).
+    /// The `capacity` cannot exceed `isize::MAX` for sized types. (only a concern on 32-bit
+    /// systems). ZSTs may have a capacity up to `usize::MAX`.
     /// If the `ptr` and `capacity` come from a `RawVec` created via `a`, then this is guaranteed.
     #[inline]
     pub unsafe fn from_raw_parts_in(ptr: *mut T, capacity: usize, a: A) -> Self {