bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Additional docs about Vec::leak behavior

Browse source
This commit is contained in:
Matt Brubeck 2021-09-28 16:27:47 -07:00
parent 58b1a127d6
commit 1fca2ce901
1 changed files with 5 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

7
library/alloc/src/vec/mod.rs
View file

@ -1952,8 +1952,11 @@ impl<T, A: Allocator> Vec<T, A> {
/// `'a`. If the type has only static references, or none at all, then this /// `'a`. If the type has only static references, or none at all, then this
/// may be chosen to be `'static`. /// may be chosen to be `'static`.
/// ///
/// This function is similar to the [`leak`][Box::leak] function on [`Box`] /// This method does not reallocate or shrink the `Vec`, so the leaked
/// except that there is no way to recover the leaked memory. /// allocation may include unused capacity that is not part of the returned
/// slice. Unsafe code that later reconstructs or deallocates the `Vec`
/// (for example, by calling [`Vec::from_raw_parts`]) must keep track of the
/// original capacity.
/// ///
/// This function is mainly useful for data that lives for the remainder of /// This function is mainly useful for data that lives for the remainder of
/// the program's life. Dropping the returned reference will cause a memory /// the program's life. Dropping the returned reference will cause a memory