diff options
| author | Fabian Hintringer <fabianhintringer01@gmail.com> | 2022-11-28 22:38:23 +0100 |
|---|---|---|
| committer | Fabian Hintringer <fabianhintringer01@gmail.com> | 2022-11-28 22:42:05 +0100 |
| commit | f9490c81219c78dc64d9f1c8578b7a9f3fa06833 (patch) | |
| tree | c0b28fc207b1217634beae0651b7ac8eab72480e /library/alloc/src/vec | |
| parent | 8a09420ac48658cad726e0a6997687ceac4151e3 (diff) | |
| download | rust-f9490c81219c78dc64d9f1c8578b7a9f3fa06833.tar.gz rust-f9490c81219c78dc64d9f1c8578b7a9f3fa06833.zip | |
improve doc
Diffstat (limited to 'library/alloc/src/vec')
| -rw-r--r-- | library/alloc/src/vec/mod.rs | 11 |
1 files changed, 10 insertions, 1 deletions
diff --git a/library/alloc/src/vec/mod.rs b/library/alloc/src/vec/mod.rs index e147af2ce39..ba34ab6800f 100644 --- a/library/alloc/src/vec/mod.rs +++ b/library/alloc/src/vec/mod.rs @@ -1070,7 +1070,8 @@ impl<T, A: Allocator> Vec<T, A> { /// Converts the vector into [`Box<[T]>`][owned slice]. /// - /// Note that this will drop any excess capacity. + /// If the vector has excess capacity, its items will be moved into a + /// newly-allocated buffer with exactly the right capacity. /// /// [owned slice]: Box /// @@ -3223,6 +3224,14 @@ impl<T, A: Allocator> From<Vec<T, A>> for Box<[T], A> { /// ``` /// assert_eq!(Box::from(vec![1, 2, 3]), vec![1, 2, 3].into_boxed_slice()); /// ``` + /// + /// Any excess capacity is removed: + /// ``` + /// let mut vec = Vec::with_capacity(10); + /// vec.extend([1, 2, 3]); + /// + /// assert_eq!(Box::from(vec), vec![1, 2, 3].into_boxed_slice()); + /// ``` fn from(v: Vec<T, A>) -> Self { v.into_boxed_slice() } |
