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

Auto merge of #74652 - poliorcetics:clarify-vec-drain-doc, r=jyn514

Browse source 
Improve the documentation for Vec::drain

Fixes #73844.

@rusbot modify labels: A-collections, C-enhancement, T-doc, T-libs
This commit is contained in:
bors 2020-07-25 03:38:30 +00:00
commit 0e11fc8053
1 changed files with 4 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
src/liballoc/vec.rs
View file

@ -1274,11 +1274,10 @@ impl<T> Vec<T> {
/// Creates a draining iterator that removes the specified range in the vector
/// and yields the removed items.
///
/// Note 1: The element range is removed even if the iterator is only
/// partially consumed or not consumed at all.
///
/// Note 2: It is unspecified how many elements are removed from the vector
/// if the `Drain` value is leaked.
/// When the iterator **is** dropped, all elements in the range are removed
/// from the vector, even if the iterator was not fully consumed. If the
/// iterator **is not** dropped (with [`mem::forget`] for example), it is
/// unspecified how many elements are removed.
///
/// # Panics
///