Additional docs about Vec::leak behavior
This commit is contained in:
parent
58b1a127d6
commit
1fca2ce901
@ -1952,8 +1952,11 @@ pub fn resize_with<F>(&mut self, new_len: usize, f: F)
|
||||
/// `'a`. If the type has only static references, or none at all, then this
|
||||
/// may be chosen to be `'static`.
|
||||
///
|
||||
/// This function is similar to the [`leak`][Box::leak] function on [`Box`]
|
||||
/// except that there is no way to recover the leaked memory.
|
||||
/// This method does not reallocate or shrink the `Vec`, so the leaked
|
||||
/// 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
|
||||
/// the program's life. Dropping the returned reference will cause a memory
|
||||
|
Loading…
Reference in New Issue
Block a user