squiid/rust
1
0
Fork 0
Code Issues Pull requests Projects Activity

Add note to Vec::split_at_spare_mut docs that the method is low-level

Browse source
This commit is contained in:
Waffle 2021-02-03 14:14:55 +03:00
parent 476a57a628
commit 76223fafb4
1 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -1837,6 +1837,21 @@ impl<T, A: Allocator> Vec<T, A> {
///
/// [`set_len`]: Vec::set_len
///
/// Note that this is a low-level API, which should be used with care for
/// optimization purposes. If you need to append data to a `Vec`
/// you can use [`push`], [`extend`], [`extend_from_slice`],
/// [`extend_from_within`], [`insert`], [`append`], [`resize`] or
/// [`resize_with`], depending on your exact needs.
///
/// [`push`]: Vec::push
/// [`extend`]: Vec::extend
/// [`extend_from_slice`]: Vec::extend_from_slice
/// [`extend_from_within`]: Vec::extend_from_within
/// [`insert`]: Vec::insert
/// [`append`]: Vec::append
/// [`resize`]: Vec::resize
/// [`resize_with`]: Vec::resize_with
///
/// # Examples
///
/// ```