Skip to content

Commit 8888bfc

Browse files
committed
don't mention the number of allocations
this is primarily about unused capacity having its lifetime extended
1 parent c92f814 commit 8888bfc

File tree

1 file changed

+6
-7
lines changed

1 file changed

+6
-7
lines changed

library/alloc/src/vec/mod.rs

+6-7
Original file line numberDiff line numberDiff line change
@@ -2803,11 +2803,11 @@ impl<T, I: SliceIndex<[T]>, A: Allocator> IndexMut<I> for Vec<T, A> {
28032803
/// * perform the iteration in-place on the original allocation backing the iterator
28042804
///
28052805
/// The last case warrants some attention. It is an optimization that in many cases reduces peak memory
2806-
/// consumption and improves cache locality. But when a large number of big, short-lived
2807-
/// allocations are created, only a small fraction of their items gets collected, no further use
2808-
/// is made of the spare capacity and the resulting `Vec` is moved into a longer-lived structure
2809-
/// this can lead to the large allocations having their lifetimes unnecessarily extended which
2810-
/// can result in increased memory footprint.
2806+
/// consumption and improves cache locality. But when big, short-lived allocations are created,
2807+
/// only a small fraction of their items gets collected, no further use is made of the spare capacity
2808+
/// and the resulting `Vec` is moved into a longer-lived structure this can lead to the large
2809+
/// allocations having their lifetimes unnecessarily extended which can result in increased memory
2810+
/// footprint.
28112811
///
28122812
/// In cases where this is an issue, the excess capacity can be discarded with [`Vec::shrink_to()`],
28132813
/// [`Vec::shrink_to_fit()`] or by collecting into [`Box<[T]>`][owned slice] instead, which additionally reduces
@@ -2819,8 +2819,7 @@ impl<T, I: SliceIndex<[T]>, A: Allocator> IndexMut<I> for Vec<T, A> {
28192819
/// # use std::sync::Mutex;
28202820
/// static LONG_LIVED: Mutex<Vec<Vec<u16>>> = Mutex::new(Vec::new());
28212821
///
2822-
/// // many short-lived allocations
2823-
/// for i in 0..100 {
2822+
/// for i in 0..10 {
28242823
/// let big_temporary: Vec<u16> = (0..1024).collect();
28252824
/// // discard most items
28262825
/// let mut result: Vec<_> = big_temporary.into_iter().filter(|i| i % 100 == 0).collect();

0 commit comments

Comments
 (0)