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.

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

Improve docs for vec_extend_from_within #105030

Closed
wants to merge 1 commit into from
Closed

Improve docs for vec_extend_from_within #105030

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 16 additions & 11 deletions library/alloc/src/vec/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2392,26 +2392,31 @@ impl<T: Clone, A: Allocator> Vec<T, A> {
self.spec_extend(other.iter())
}

/// Copies elements from `src` range to the end of the vector.
/// Appends elements specified by the `src` parameter to the end of the vector.
/// The `src` parameter is of type [`RangeBounds`], which means that
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

RangeBounds is a trait here, not a type. Not exactly sure what the best way to specify this is, though.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since RangeBounds is in the signature anyway, and the examples show use of ranges, could this just be:

Copies elements from one part of the vector to the end.

src is the range that the elements will be copied from.

This would be consistent with the wording used in slice::copy_within

/// it can be used to specify a range of elements in the vector.
///
/// [`RangeBounds`]: ../../std/ops/trait.RangeBounds.html
///
/// # Panics
///
/// Panics if the starting point is greater than the end point or if
/// the end point is greater than the length of the vector.
/// Panics if the starting index is greater than the end index.
/// Panics if the end index is greater than the length of the vector.
///
/// # Examples
///
/// ```
/// let mut vec = vec![0, 1, 2, 3, 4];
///
/// vec.extend_from_within(2..);
/// assert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4]);
/// let mut characters1 = vec!['a', 'b', 'c', 'd', 'e'];
/// characters1.extend_from_within(2..);
/// assert_eq!(characters1, ['a', 'b', 'c', 'd', 'e', 'c', 'd', 'e']);
///
/// vec.extend_from_within(..2);
/// assert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1]);
/// let mut characters2 = vec!['a', 'b', 'c', 'd', 'e'];
/// characters2.extend_from_within(..2);
/// assert_eq!(characters2, ['a', 'b', 'c', 'd', 'e', 'a', 'b']);
///
/// vec.extend_from_within(4..8);
/// assert_eq!(vec, [0, 1, 2, 3, 4, 2, 3, 4, 0, 1, 4, 2, 3, 4]);
/// let mut characters3 = vec!['a', 'b', 'c', 'd', 'e'];
/// characters3.extend_from_within(1..3);
/// assert_eq!(characters3, ['a', 'b', 'c', 'd', 'e', 'b', 'c']);
/// ```
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "vec_extend_from_within", since = "1.53.0")]
Expand Down