user0/rust
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Clarify when range is removed by drain

Browse source 
Based on a discussion on #rust-beginners the existing note for drain is confusing. This new wording was suggested.
This commit is contained in:
Stephen E. Baker 2017-01-17 14:39:16 -05:00 • committed by GitHub
parent aedebfe77d
commit 3d85f73def
1 changed files with 2 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

4
src/libcollections/vec.rs
View file

@ -1023,8 +1023,8 @@ impl<T> Vec<T> {
/// Create 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 not
/// consumed until the end.
/// 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.