Skip to content

Commit

Permalink
Docs: recommend VecDeque instead of Vec::remove(0)
Browse files Browse the repository at this point in the history
  • Loading branch information
kornelski committed Jan 16, 2022
1 parent 48e89b0 commit 361ef2a
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion library/alloc/src/vec/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1372,9 +1372,12 @@ impl<T, A: Allocator> Vec<T, A> {
///
/// Note: Because this shifts over the remaining elements, it has a
/// worst-case performance of *O*(*n*). If you don't need the order of elements
/// to be preserved, use [`swap_remove`] instead.
/// to be preserved, use [`swap_remove`] instead. If you'd like to remove
/// elements from the beginning of the `Vec`, consider using
/// [`VecDeque::pop_front`] instead.
///
/// [`swap_remove`]: Vec::swap_remove
/// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
///
/// # Panics
///
Expand Down Expand Up @@ -1735,6 +1738,11 @@ impl<T, A: Allocator> Vec<T, A> {
/// Removes the last element from a vector and returns it, or [`None`] if it
/// is empty.
///
/// If you'd like to pop the first element, consider using
/// [`VecDeque::pop_front`] instead.
///
/// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
///
/// # Examples
///
/// ```
Expand Down

0 comments on commit 361ef2a

Please sign in to comment.