Rollup merge of #46884 - Manishearth:vec-docs, r=steveklabnik
Clarify vec docs on deallocation (fixes #46879) r? @steveklabnik
This commit is contained in:
commit
7767d84a68
@ -224,8 +224,10 @@ use Bound::{Excluded, Included, Unbounded};
|
||||
/// types inside a `Vec`, it will not allocate space for them. *Note that in this case
|
||||
/// the `Vec` may not report a [`capacity`] of 0*. `Vec` will allocate if and only
|
||||
/// if [`mem::size_of::<T>`]`() * capacity() > 0`. In general, `Vec`'s allocation
|
||||
/// details are subtle enough that it is strongly recommended that you only
|
||||
/// free memory allocated by a `Vec` by creating a new `Vec` and dropping it.
|
||||
/// details are very subtle — if you intend to allocate memory using a `Vec`
|
||||
/// and use it for something else (either to pass to unsafe code, or to build your
|
||||
/// own memory-backed collection), be sure to deallocate this memory by using
|
||||
/// `from_raw_parts` to recover the `Vec` and then dropping it.
|
||||
///
|
||||
/// If a `Vec` *has* allocated memory, then the memory it points to is on the heap
|
||||
/// (as defined by the allocator Rust is configured to use by default), and its
|
||||
|
Loading…
Reference in New Issue
Block a user