Skip to content
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.

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

Improve the documentation for Vec::drain #74652

Merged
merged 3 commits into from
Jul 25, 2020
Merged
Changes from 1 commit
Commits
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
11 changes: 7 additions & 4 deletions src/liballoc/vec.rs
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.
poliorcetics marked this conversation as resolved.
Show resolved Hide resolved
///
/// # Panics
///
Expand All @@ -1297,6 +1298,8 @@ impl<T> Vec<T> {
/// v.drain(..);
/// assert_eq!(v, &[]);
/// ```
///
/// [`mem::forget`]: mem::forget
poliorcetics marked this conversation as resolved.
Show resolved Hide resolved
#[stable(feature = "drain", since = "1.6.0")]
pub fn drain<R>(&mut self, range: R) -> Drain<'_, T>
where
Expand Down