bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Docs: recommend VecDeque instead of Vec::remove(0)

Browse source
This commit is contained in:
Kornel 2022-01-16 16:51:55 +00:00
parent 48e89b00ca
commit 361ef2aadc
1 changed files with 9 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

10
library/alloc/src/vec/mod.rs
View file

@ -1372,9 +1372,12 @@ impl<T, A: Allocator> Vec<T, A> {
/// ///
/// Note: Because this shifts over the remaining elements, it has 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 /// 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 /// [`swap_remove`]: Vec::swap_remove
/// [`VecDeque::pop_front`]: crate::collections::VecDeque::pop_front
/// ///
/// # Panics /// # Panics
/// ///
@ -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 /// Removes the last element from a vector and returns it, or [`None`] if it
/// is empty. /// 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 /// # Examples
/// ///
/// ``` /// ```