Skip to content

Improve the documentation for Vec::drain #74652

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bors merged 3 commits into from
Jul 25, 2020
Merged

Improve the documentation for Vec::drain #74652

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e601e2a
Improve the documentation for Vec::drain
poliorcetics Jul 22, 2020
771ec21
Remove unecessary link
poliorcetics Jul 23, 2020
654c180
Apply suggestion from review
poliorcetics Jul 24, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions src/liballoc/vec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1274,11 +1274,12 @@ 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.
/// 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.
/// Note: Be aware that if the iterator is leaked (eg: [`mem::forget`]), it
/// cancels this property so it is unspecified how many elements are removed
/// from the vector in this case.
///
/// # Panics
///
Expand Down