library/alloc/src/slice.rs

   1 //! A dynamically-sized view into a contiguous sequence, `[T]`.
   2 //!
   3 //! *[See also the slice primitive type](slice).*
   4 //!
   5 //! Slices are a view into a block of memory represented as a pointer and a
   6 //! length.
   7 //!
   8 //! ```
   9 //! // slicing a Vec
  10 //! let vec = vec![1, 2, 3];
  11 //! let int_slice = &vec[..];
  12 //! // coercing an array to a slice
  13 //! let str_slice: &[&str] = &["one", "two", "three"];
  14 //! ```
  15 //!
  16 //! Slices are either mutable or shared. The shared slice type is `&[T]`,
  17 //! while the mutable slice type is `&mut [T]`, where `T` represents the element
  18 //! type. For example, you can mutate the block of memory that a mutable slice
  19 //! points to:
  20 //!
  21 //! ```
  22 //! let x = &mut [1, 2, 3];
  23 //! x[1] = 7;
  24 //! assert_eq!(x, &[1, 7, 3]);
  25 //! ```
  26 //!
  27 //! Here are some of the things this module contains:
  28 //!
  29 //! ## Structs
  30 //!
  31 //! There are several structs that are useful for slices, such as [`Iter`], which
  32 //! represents iteration over a slice.
  33 //!
  34 //! ## Trait Implementations
  35 //!
  36 //! There are several implementations of common traits for slices. Some examples
  37 //! include:
  38 //!
  39 //! * [`Clone`]
  40 //! * [`Eq`], [`Ord`] - for slices whose element type are [`Eq`] or [`Ord`].
  41 //! * [`Hash`] - for slices whose element type is [`Hash`].
  42 //!
  43 //! ## Iteration
  44 //!
  45 //! The slices implement `IntoIterator`. The iterator yields references to the
  46 //! slice elements.
  47 //!
  48 //! ```
  49 //! let numbers = &[0, 1, 2];
  50 //! for n in numbers {
  51 //!     println!("{n} is a number!");
  52 //! }
  53 //! ```
  54 //!
  55 //! The mutable slice yields mutable references to the elements:
  56 //!
  57 //! ```
  58 //! let mut scores = [7, 8, 9];
  59 //! for score in &mut scores[..] {
  60 //!     *score += 1;
  61 //! }
  62 //! ```
  63 //!
  64 //! This iterator yields mutable references to the slice's elements, so while
  65 //! the element type of the slice is `i32`, the element type of the iterator is
  66 //! `&mut i32`.
  67 //!
  68 //! * [`.iter`] and [`.iter_mut`] are the explicit methods to return the default
  69 //!   iterators.
  70 //! * Further methods that return iterators are [`.split`], [`.splitn`],
  71 //!   [`.chunks`], [`.windows`] and more.
  72 //!
  73 //! [`Hash`]: core::hash::Hash
  74 //! [`.iter`]: slice::iter
  75 //! [`.iter_mut`]: slice::iter_mut
  76 //! [`.split`]: slice::split
  77 //! [`.splitn`]: slice::splitn
  78 //! [`.chunks`]: slice::chunks
  79 //! [`.windows`]: slice::windows
  80 #![stable(feature = "rust1", since = "1.0.0")]
  81 // Many of the usings in this module are only used in the test configuration.
  82 // It's cleaner to just turn off the unused_imports warning than to fix them.
  83 #![cfg_attr(test, allow(unused_imports, dead_code))]
  84
  85 use core::borrow::{Borrow, BorrowMut};
  86 #[cfg(not(no_global_oom_handling))]
  87 use core::cmp::Ordering::{self, Less};
  88 #[cfg(not(no_global_oom_handling))]
  89 use core::mem;
  90 #[cfg(not(no_global_oom_handling))]
  91 use core::mem::size_of;
  92 #[cfg(not(no_global_oom_handling))]
  93 use core::ptr;
  94
  95 use crate::alloc::Allocator;
  96 #[cfg(not(no_global_oom_handling))]
  97 use crate::alloc::Global;
  98 #[cfg(not(no_global_oom_handling))]
  99 use crate::borrow::ToOwned;
 100 use crate::boxed::Box;
 101 use crate::vec::Vec;
 102
 103 #[unstable(feature = "slice_range", issue = "76393")]
 104 pub use core::slice::range;
 105 #[unstable(feature = "array_chunks", issue = "74985")]
 106 pub use core::slice::ArrayChunks;
 107 #[unstable(feature = "array_chunks", issue = "74985")]
 108 pub use core::slice::ArrayChunksMut;
 109 #[unstable(feature = "array_windows", issue = "75027")]
 110 pub use core::slice::ArrayWindows;
 111 #[stable(feature = "inherent_ascii_escape", since = "1.60.0")]
 112 pub use core::slice::EscapeAscii;
 113 #[stable(feature = "slice_get_slice", since = "1.28.0")]
 114 pub use core::slice::SliceIndex;
 115 #[stable(feature = "from_ref", since = "1.28.0")]
 116 pub use core::slice::{from_mut, from_ref};
 117 #[stable(feature = "rust1", since = "1.0.0")]
 118 pub use core::slice::{from_raw_parts, from_raw_parts_mut};
 119 #[stable(feature = "rust1", since = "1.0.0")]
 120 pub use core::slice::{Chunks, Windows};
 121 #[stable(feature = "chunks_exact", since = "1.31.0")]
 122 pub use core::slice::{ChunksExact, ChunksExactMut};
 123 #[stable(feature = "rust1", since = "1.0.0")]
 124 pub use core::slice::{ChunksMut, Split, SplitMut};
 125 #[unstable(feature = "slice_group_by", issue = "80552")]
 126 pub use core::slice::{GroupBy, GroupByMut};
 127 #[stable(feature = "rust1", since = "1.0.0")]
 128 pub use core::slice::{Iter, IterMut};
 129 #[stable(feature = "rchunks", since = "1.31.0")]
 130 pub use core::slice::{RChunks, RChunksExact, RChunksExactMut, RChunksMut};
 131 #[stable(feature = "slice_rsplit", since = "1.27.0")]
 132 pub use core::slice::{RSplit, RSplitMut};
 133 #[stable(feature = "rust1", since = "1.0.0")]
 134 pub use core::slice::{RSplitN, RSplitNMut, SplitN, SplitNMut};
 135 #[stable(feature = "split_inclusive", since = "1.51.0")]
 136 pub use core::slice::{SplitInclusive, SplitInclusiveMut};
 137
 138 ////////////////////////////////////////////////////////////////////////////////
 139 // Basic slice extension methods
 140 ////////////////////////////////////////////////////////////////////////////////
 141
 142 // HACK(japaric) needed for the implementation of `vec!` macro during testing
 143 // N.B., see the `hack` module in this file for more details.
 144 #[cfg(test)]
 145 pub use hack::into_vec;
 146
 147 // HACK(japaric) needed for the implementation of `Vec::clone` during testing
 148 // N.B., see the `hack` module in this file for more details.
 149 #[cfg(test)]
 150 pub use hack::to_vec;
 151
 152 // HACK(japaric): With cfg(test) `impl [T]` is not available, these three
 153 // functions are actually methods that are in `impl [T]` but not in
 154 // `core::slice::SliceExt` - we need to supply these functions for the
 155 // `test_permutations` test
 156 mod hack {
 157     use core::alloc::Allocator;
 158
 159     use crate::boxed::Box;
 160     use crate::vec::Vec;
 161
 162     // We shouldn't add inline attribute to this since this is used in
 163     // `vec!` macro mostly and causes perf regression. See #71204 for
 164     // discussion and perf results.
 165     pub fn into_vec<T, A: Allocator>(b: Box<[T], A>) -> Vec<T, A> {
 166         unsafe {
 167             let len = b.len();
 168             let (b, alloc) = Box::into_raw_with_allocator(b);
 169             Vec::from_raw_parts_in(b as *mut T, len, len, alloc)
 170         }
 171     }
 172
 173     #[cfg(not(no_global_oom_handling))]
 174     #[inline]
 175     pub fn to_vec<T: ConvertVec, A: Allocator>(s: &[T], alloc: A) -> Vec<T, A> {
 176         T::to_vec(s, alloc)
 177     }
 178
 179     #[cfg(not(no_global_oom_handling))]
 180     pub trait ConvertVec {
 181         fn to_vec<A: Allocator>(s: &[Self], alloc: A) -> Vec<Self, A>
 182         where
 183             Self: Sized;
 184     }
 185
 186     #[cfg(not(no_global_oom_handling))]
 187     impl<T: Clone> ConvertVec for T {
 188         #[inline]
 189         default fn to_vec<A: Allocator>(s: &[Self], alloc: A) -> Vec<Self, A> {
 190             struct DropGuard<'a, T, A: Allocator> {
 191                 vec: &'a mut Vec<T, A>,
 192                 num_init: usize,
 193             }
 194             impl<'a, T, A: Allocator> Drop for DropGuard<'a, T, A> {
 195                 #[inline]
 196                 fn drop(&mut self) {
 197                     // SAFETY:
 198                     // items were marked initialized in the loop below
 199                     unsafe {
 200                         self.vec.set_len(self.num_init);
 201                     }
 202                 }
 203             }
 204             let mut vec = Vec::with_capacity_in(s.len(), alloc);
 205             let mut guard = DropGuard { vec: &mut vec, num_init: 0 };
 206             let slots = guard.vec.spare_capacity_mut();
 207             // .take(slots.len()) is necessary for LLVM to remove bounds checks
 208             // and has better codegen than zip.
 209             for (i, b) in s.iter().enumerate().take(slots.len()) {
 210                 guard.num_init = i;
 211                 slots[i].write(b.clone());
 212             }
 213             core::mem::forget(guard);
 214             // SAFETY:
 215             // the vec was allocated and initialized above to at least this length.
 216             unsafe {
 217                 vec.set_len(s.len());
 218             }
 219             vec
 220         }
 221     }
 222
 223     #[cfg(not(no_global_oom_handling))]
 224     impl<T: Copy> ConvertVec for T {
 225         #[inline]
 226         fn to_vec<A: Allocator>(s: &[Self], alloc: A) -> Vec<Self, A> {
 227             let mut v = Vec::with_capacity_in(s.len(), alloc);
 228             // SAFETY:
 229             // allocated above with the capacity of `s`, and initialize to `s.len()` in
 230             // ptr::copy_to_non_overlapping below.
 231             unsafe {
 232                 s.as_ptr().copy_to_nonoverlapping(v.as_mut_ptr(), s.len());
 233                 v.set_len(s.len());
 234             }
 235             v
 236         }
 237     }
 238 }
 239
 240 #[lang = "slice_alloc"]
 241 #[cfg(not(test))]
 242 impl<T> [T] {
 243     /// Sorts the slice.
 244     ///
 245     /// This sort is stable (i.e., does not reorder equal elements) and *O*(*n* \* log(*n*)) worst-case.
 246     ///
 247     /// When applicable, unstable sorting is preferred because it is generally faster than stable
 248     /// sorting and it doesn't allocate auxiliary memory.
 249     /// See [`sort_unstable`](slice::sort_unstable).
 250     ///
 251     /// # Current implementation
 252     ///
 253     /// The current algorithm is an adaptive, iterative merge sort inspired by
 254     /// [timsort](https://en.wikipedia.org/wiki/Timsort).
 255     /// It is designed to be very fast in cases where the slice is nearly sorted, or consists of
 256     /// two or more sorted sequences concatenated one after another.
 257     ///
 258     /// Also, it allocates temporary storage half the size of `self`, but for short slices a
 259     /// non-allocating insertion sort is used instead.
 260     ///
 261     /// # Examples
 262     ///
 263     /// ```
 264     /// let mut v = [-5, 4, 1, -3, 2];
 265     ///
 266     /// v.sort();
 267     /// assert!(v == [-5, -3, 1, 2, 4]);
 268     /// ```
 269     #[cfg(not(no_global_oom_handling))]
 270     #[stable(feature = "rust1", since = "1.0.0")]
 271     #[inline]
 272     pub fn sort(&mut self)
 273     where
 274         T: Ord,
 275     {
 276         merge_sort(self, |a, b| a.lt(b));
 277     }
 278
 279     /// Sorts the slice with a comparator function.
 280     ///
 281     /// This sort is stable (i.e., does not reorder equal elements) and *O*(*n* \* log(*n*)) worst-case.
 282     ///
 283     /// The comparator function must define a total ordering for the elements in the slice. If
 284     /// the ordering is not total, the order of the elements is unspecified. An order is a
 285     /// total order if it is (for all `a`, `b` and `c`):
 286     ///
 287     /// * total and antisymmetric: exactly one of `a < b`, `a == b` or `a > b` is true, and
 288     /// * transitive, `a < b` and `b < c` implies `a < c`. The same must hold for both `==` and `>`.
 289     ///
 290     /// For example, while [`f64`] doesn't implement [`Ord`] because `NaN != NaN`, we can use
 291     /// `partial_cmp` as our sort function when we know the slice doesn't contain a `NaN`.
 292     ///
 293     /// ```
 294     /// let mut floats = [5f64, 4.0, 1.0, 3.0, 2.0];
 295     /// floats.sort_by(|a, b| a.partial_cmp(b).unwrap());
 296     /// assert_eq!(floats, [1.0, 2.0, 3.0, 4.0, 5.0]);
 297     /// ```
 298     ///
 299     /// When applicable, unstable sorting is preferred because it is generally faster than stable
 300     /// sorting and it doesn't allocate auxiliary memory.
 301     /// See [`sort_unstable_by`](slice::sort_unstable_by).
 302     ///
 303     /// # Current implementation
 304     ///
 305     /// The current algorithm is an adaptive, iterative merge sort inspired by
 306     /// [timsort](https://en.wikipedia.org/wiki/Timsort).
 307     /// It is designed to be very fast in cases where the slice is nearly sorted, or consists of
 308     /// two or more sorted sequences concatenated one after another.
 309     ///
 310     /// Also, it allocates temporary storage half the size of `self`, but for short slices a
 311     /// non-allocating insertion sort is used instead.
 312     ///
 313     /// # Examples
 314     ///
 315     /// ```
 316     /// let mut v = [5, 4, 1, 3, 2];
 317     /// v.sort_by(|a, b| a.cmp(b));
 318     /// assert!(v == [1, 2, 3, 4, 5]);
 319     ///
 320     /// // reverse sorting
 321     /// v.sort_by(|a, b| b.cmp(a));
 322     /// assert!(v == [5, 4, 3, 2, 1]);
 323     /// ```
 324     #[cfg(not(no_global_oom_handling))]
 325     #[stable(feature = "rust1", since = "1.0.0")]
 326     #[inline]
 327     pub fn sort_by<F>(&mut self, mut compare: F)
 328     where
 329         F: FnMut(&T, &T) -> Ordering,
 330     {
 331         merge_sort(self, |a, b| compare(a, b) == Less);
 332     }
 333
 334     /// Sorts the slice with a key extraction function.
 335     ///
 336     /// This sort is stable (i.e., does not reorder equal elements) and *O*(*m* \* *n* \* log(*n*))
 337     /// worst-case, where the key function is *O*(*m*).
 338     ///
 339     /// For expensive key functions (e.g. functions that are not simple property accesses or
 340     /// basic operations), [`sort_by_cached_key`](slice::sort_by_cached_key) is likely to be
 341     /// significantly faster, as it does not recompute element keys.
 342     ///
 343     /// When applicable, unstable sorting is preferred because it is generally faster than stable
 344     /// sorting and it doesn't allocate auxiliary memory.
 345     /// See [`sort_unstable_by_key`](slice::sort_unstable_by_key).
 346     ///
 347     /// # Current implementation
 348     ///
 349     /// The current algorithm is an adaptive, iterative merge sort inspired by
 350     /// [timsort](https://en.wikipedia.org/wiki/Timsort).
 351     /// It is designed to be very fast in cases where the slice is nearly sorted, or consists of
 352     /// two or more sorted sequences concatenated one after another.
 353     ///
 354     /// Also, it allocates temporary storage half the size of `self`, but for short slices a
 355     /// non-allocating insertion sort is used instead.
 356     ///
 357     /// # Examples
 358     ///
 359     /// ```
 360     /// let mut v = [-5i32, 4, 1, -3, 2];
 361     ///
 362     /// v.sort_by_key(|k| k.abs());
 363     /// assert!(v == [1, 2, -3, 4, -5]);
 364     /// ```
 365     #[cfg(not(no_global_oom_handling))]
 366     #[stable(feature = "slice_sort_by_key", since = "1.7.0")]
 367     #[inline]
 368     pub fn sort_by_key<K, F>(&mut self, mut f: F)
 369     where
 370         F: FnMut(&T) -> K,
 371         K: Ord,
 372     {
 373         merge_sort(self, |a, b| f(a).lt(&f(b)));
 374     }
 375
 376     /// Sorts the slice with a key extraction function.
 377     ///
 378     /// During sorting, the key function is called at most once per element, by using
 379     /// temporary storage to remember the results of key evaluation.
 380     /// The order of calls to the key function is unspecified and may change in future versions
 381     /// of the standard library.
 382     ///
 383     /// This sort is stable (i.e., does not reorder equal elements) and *O*(*m* \* *n* + *n* \* log(*n*))
 384     /// worst-case, where the key function is *O*(*m*).
 385     ///
 386     /// For simple key functions (e.g., functions that are property accesses or
 387     /// basic operations), [`sort_by_key`](slice::sort_by_key) is likely to be
 388     /// faster.
 389     ///
 390     /// # Current implementation
 391     ///
 392     /// The current algorithm is based on [pattern-defeating quicksort][pdqsort] by Orson Peters,
 393     /// which combines the fast average case of randomized quicksort with the fast worst case of
 394     /// heapsort, while achieving linear time on slices with certain patterns. It uses some
 395     /// randomization to avoid degenerate cases, but with a fixed seed to always provide
 396     /// deterministic behavior.
 397     ///
 398     /// In the worst case, the algorithm allocates temporary storage in a `Vec<(K, usize)>` the
 399     /// length of the slice.
 400     ///
 401     /// # Examples
 402     ///
 403     /// ```
 404     /// let mut v = [-5i32, 4, 32, -3, 2];
 405     ///
 406     /// v.sort_by_cached_key(|k| k.to_string());
 407     /// assert!(v == [-3, -5, 2, 32, 4]);
 408     /// ```
 409     ///
 410     /// [pdqsort]: https://github.com/orlp/pdqsort
 411     #[cfg(not(no_global_oom_handling))]
 412     #[stable(feature = "slice_sort_by_cached_key", since = "1.34.0")]
 413     #[inline]
 414     pub fn sort_by_cached_key<K, F>(&mut self, f: F)
 415     where
 416         F: FnMut(&T) -> K,
 417         K: Ord,
 418     {
 419         // Helper macro for indexing our vector by the smallest possible type, to reduce allocation.
 420         macro_rules! sort_by_key {
 421             ($t:ty, $slice:ident, $f:ident) => {{
 422                 let mut indices: Vec<_> =
 423                     $slice.iter().map($f).enumerate().map(|(i, k)| (k, i as $t)).collect();
 424                 // The elements of `indices` are unique, as they are indexed, so any sort will be
 425                 // stable with respect to the original slice. We use `sort_unstable` here because
 426                 // it requires less memory allocation.
 427                 indices.sort_unstable();
 428                 for i in 0..$slice.len() {
 429                     let mut index = indices[i].1;
 430                     while (index as usize) < i {
 431                         index = indices[index as usize].1;
 432                     }
 433                     indices[i].1 = index;
 434                     $slice.swap(i, index as usize);
 435                 }
 436             }};
 437         }
 438
 439         let sz_u8 = mem::size_of::<(K, u8)>();
 440         let sz_u16 = mem::size_of::<(K, u16)>();
 441         let sz_u32 = mem::size_of::<(K, u32)>();
 442         let sz_usize = mem::size_of::<(K, usize)>();
 443
 444         let len = self.len();
 445         if len < 2 {
 446             return;
 447         }
 448         if sz_u8 < sz_u16 && len <= (u8::MAX as usize) {
 449             return sort_by_key!(u8, self, f);
 450         }
 451         if sz_u16 < sz_u32 && len <= (u16::MAX as usize) {
 452             return sort_by_key!(u16, self, f);
 453         }
 454         if sz_u32 < sz_usize && len <= (u32::MAX as usize) {
 455             return sort_by_key!(u32, self, f);
 456         }
 457         sort_by_key!(usize, self, f)
 458     }
 459
 460     /// Copies `self` into a new `Vec`.
 461     ///
 462     /// # Examples
 463     ///
 464     /// ```
 465     /// let s = [10, 40, 30];
 466     /// let x = s.to_vec();
 467     /// // Here, `s` and `x` can be modified independently.
 468     /// ```
 469     #[cfg(not(no_global_oom_handling))]
 470     #[rustc_conversion_suggestion]
 471     #[stable(feature = "rust1", since = "1.0.0")]
 472     #[inline]
 473     pub fn to_vec(&self) -> Vec<T>
 474     where
 475         T: Clone,
 476     {
 477         self.to_vec_in(Global)
 478     }
 479
 480     /// Copies `self` into a new `Vec` with an allocator.
 481     ///
 482     /// # Examples
 483     ///
 484     /// ```
 485     /// #![feature(allocator_api)]
 486     ///
 487     /// use std::alloc::System;
 488     ///
 489     /// let s = [10, 40, 30];
 490     /// let x = s.to_vec_in(System);
 491     /// // Here, `s` and `x` can be modified independently.
 492     /// ```
 493     #[cfg(not(no_global_oom_handling))]
 494     #[inline]
 495     #[unstable(feature = "allocator_api", issue = "32838")]
 496     pub fn to_vec_in<A: Allocator>(&self, alloc: A) -> Vec<T, A>
 497     where
 498         T: Clone,
 499     {
 500         // N.B., see the `hack` module in this file for more details.
 501         hack::to_vec(self, alloc)
 502     }
 503
 504     /// Converts `self` into a vector without clones or allocation.
 505     ///
 506     /// The resulting vector can be converted back into a box via
 507     /// `Vec<T>`'s `into_boxed_slice` method.
 508     ///
 509     /// # Examples
 510     ///
 511     /// ```
 512     /// let s: Box<[i32]> = Box::new([10, 40, 30]);
 513     /// let x = s.into_vec();
 514     /// // `s` cannot be used anymore because it has been converted into `x`.
 515     ///
 516     /// assert_eq!(x, vec![10, 40, 30]);
 517     /// ```
 518     #[stable(feature = "rust1", since = "1.0.0")]
 519     #[inline]
 520     pub fn into_vec<A: Allocator>(self: Box<Self, A>) -> Vec<T, A> {
 521         // N.B., see the `hack` module in this file for more details.
 522         hack::into_vec(self)
 523     }
 524
 525     /// Creates a vector by repeating a slice `n` times.
 526     ///
 527     /// # Panics
 528     ///
 529     /// This function will panic if the capacity would overflow.
 530     ///
 531     /// # Examples
 532     ///
 533     /// Basic usage:
 534     ///
 535     /// ```
 536     /// assert_eq!([1, 2].repeat(3), vec![1, 2, 1, 2, 1, 2]);
 537     /// ```
 538     ///
 539     /// A panic upon overflow:
 540     ///
 541     /// ```should_panic
 542     /// // this will panic at runtime
 543     /// b"0123456789abcdef".repeat(usize::MAX);
 544     /// ```
 545     #[cfg(not(no_global_oom_handling))]
 546     #[stable(feature = "repeat_generic_slice", since = "1.40.0")]
 547     pub fn repeat(&self, n: usize) -> Vec<T>
 548     where
 549         T: Copy,
 550     {
 551         if n == 0 {
 552             return Vec::new();
 553         }
 554
 555         // If `n` is larger than zero, it can be split as
 556         // `n = 2^expn + rem (2^expn > rem, expn >= 0, rem >= 0)`.
 557         // `2^expn` is the number represented by the leftmost '1' bit of `n`,
 558         // and `rem` is the remaining part of `n`.
 559
 560         // Using `Vec` to access `set_len()`.
 561         let capacity = self.len().checked_mul(n).expect("capacity overflow");
 562         let mut buf = Vec::with_capacity(capacity);
 563
 564         // `2^expn` repetition is done by doubling `buf` `expn`-times.
 565         buf.extend(self);
 566         {
 567             let mut m = n >> 1;
 568             // If `m > 0`, there are remaining bits up to the leftmost '1'.
 569             while m > 0 {
 570                 // `buf.extend(buf)`:
 571                 unsafe {
 572                     ptr::copy_nonoverlapping(
 573                         buf.as_ptr(),
 574                         (buf.as_mut_ptr() as *mut T).add(buf.len()),
 575                         buf.len(),
 576                     );
 577                     // `buf` has capacity of `self.len() * n`.
 578                     let buf_len = buf.len();
 579                     buf.set_len(buf_len * 2);
 580                 }
 581
 582                 m >>= 1;
 583             }
 584         }
 585
 586         // `rem` (`= n - 2^expn`) repetition is done by copying
 587         // first `rem` repetitions from `buf` itself.
 588         let rem_len = capacity - buf.len(); // `self.len() * rem`
 589         if rem_len > 0 {
 590             // `buf.extend(buf[0 .. rem_len])`:
 591             unsafe {
 592                 // This is non-overlapping since `2^expn > rem`.
 593                 ptr::copy_nonoverlapping(
 594                     buf.as_ptr(),
 595                     (buf.as_mut_ptr() as *mut T).add(buf.len()),
 596                     rem_len,
 597                 );
 598                 // `buf.len() + rem_len` equals to `buf.capacity()` (`= self.len() * n`).
 599                 buf.set_len(capacity);
 600             }
 601         }
 602         buf
 603     }
 604
 605     /// Flattens a slice of `T` into a single value `Self::Output`.
 606     ///
 607     /// # Examples
 608     ///
 609     /// ```
 610     /// assert_eq!(["hello", "world"].concat(), "helloworld");
 611     /// assert_eq!([[1, 2], [3, 4]].concat(), [1, 2, 3, 4]);
 612     /// ```
 613     #[stable(feature = "rust1", since = "1.0.0")]
 614     pub fn concat<Item: ?Sized>(&self) -> <Self as Concat<Item>>::Output
 615     where
 616         Self: Concat<Item>,
 617     {
 618         Concat::concat(self)
 619     }
 620
 621     /// Flattens a slice of `T` into a single value `Self::Output`, placing a
 622     /// given separator between each.
 623     ///
 624     /// # Examples
 625     ///
 626     /// ```
 627     /// assert_eq!(["hello", "world"].join(" "), "hello world");
 628     /// assert_eq!([[1, 2], [3, 4]].join(&0), [1, 2, 0, 3, 4]);
 629     /// assert_eq!([[1, 2], [3, 4]].join(&[0, 0][..]), [1, 2, 0, 0, 3, 4]);
 630     /// ```
 631     #[stable(feature = "rename_connect_to_join", since = "1.3.0")]
 632     pub fn join<Separator>(&self, sep: Separator) -> <Self as Join<Separator>>::Output
 633     where
 634         Self: Join<Separator>,
 635     {
 636         Join::join(self, sep)
 637     }
 638
 639     /// Flattens a slice of `T` into a single value `Self::Output`, placing a
 640     /// given separator between each.
 641     ///
 642     /// # Examples
 643     ///
 644     /// ```
 645     /// # #![allow(deprecated)]
 646     /// assert_eq!(["hello", "world"].connect(" "), "hello world");
 647     /// assert_eq!([[1, 2], [3, 4]].connect(&0), [1, 2, 0, 3, 4]);
 648     /// ```
 649     #[stable(feature = "rust1", since = "1.0.0")]
 650     #[rustc_deprecated(since = "1.3.0", reason = "renamed to join")]
 651     pub fn connect<Separator>(&self, sep: Separator) -> <Self as Join<Separator>>::Output
 652     where
 653         Self: Join<Separator>,
 654     {
 655         Join::join(self, sep)
 656     }
 657 }
 658
 659 #[lang = "slice_u8_alloc"]
 660 #[cfg(not(test))]
 661 impl [u8] {
 662     /// Returns a vector containing a copy of this slice where each byte
 663     /// is mapped to its ASCII upper case equivalent.
 664     ///
 665     /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
 666     /// but non-ASCII letters are unchanged.
 667     ///
 668     /// To uppercase the value in-place, use [`make_ascii_uppercase`].
 669     ///
 670     /// [`make_ascii_uppercase`]: slice::make_ascii_uppercase
 671     #[cfg(not(no_global_oom_handling))]
 672     #[must_use = "this returns the uppercase bytes as a new Vec, \
 673                   without modifying the original"]
 674     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
 675     #[inline]
 676     pub fn to_ascii_uppercase(&self) -> Vec<u8> {
 677         let mut me = self.to_vec();
 678         me.make_ascii_uppercase();
 679         me
 680     }
 681
 682     /// Returns a vector containing a copy of this slice where each byte
 683     /// is mapped to its ASCII lower case equivalent.
 684     ///
 685     /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
 686     /// but non-ASCII letters are unchanged.
 687     ///
 688     /// To lowercase the value in-place, use [`make_ascii_lowercase`].
 689     ///
 690     /// [`make_ascii_lowercase`]: slice::make_ascii_lowercase
 691     #[cfg(not(no_global_oom_handling))]
 692     #[must_use = "this returns the lowercase bytes as a new Vec, \
 693                   without modifying the original"]
 694     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
 695     #[inline]
 696     pub fn to_ascii_lowercase(&self) -> Vec<u8> {
 697         let mut me = self.to_vec();
 698         me.make_ascii_lowercase();
 699         me
 700     }
 701 }
 702
 703 ////////////////////////////////////////////////////////////////////////////////
 704 // Extension traits for slices over specific kinds of data
 705 ////////////////////////////////////////////////////////////////////////////////
 706
 707 /// Helper trait for [`[T]::concat`](slice::concat).
 708 ///
 709 /// Note: the `Item` type parameter is not used in this trait,
 710 /// but it allows impls to be more generic.
 711 /// Without it, we get this error:
 712 ///
 713 /// ```error
 714 /// error[E0207]: the type parameter `T` is not constrained by the impl trait, self type, or predica
 715 ///    --> src/liballoc/slice.rs:608:6
 716 ///     |
 717 /// 608 | impl<T: Clone, V: Borrow<[T]>> Concat for [V] {
 718 ///     |      ^ unconstrained type parameter
 719 /// ```
 720 ///
 721 /// This is because there could exist `V` types with multiple `Borrow<[_]>` impls,
 722 /// such that multiple `T` types would apply:
 723 ///
 724 /// ```
 725 /// # #[allow(dead_code)]
 726 /// pub struct Foo(Vec<u32>, Vec<String>);
 727 ///
 728 /// impl std::borrow::Borrow<[u32]> for Foo {
 729 ///     fn borrow(&self) -> &[u32] { &self.0 }
 730 /// }
 731 ///
 732 /// impl std::borrow::Borrow<[String]> for Foo {
 733 ///     fn borrow(&self) -> &[String] { &self.1 }
 734 /// }
 735 /// ```
 736 #[unstable(feature = "slice_concat_trait", issue = "27747")]
 737 pub trait Concat<Item: ?Sized> {
 738     #[unstable(feature = "slice_concat_trait", issue = "27747")]
 739     /// The resulting type after concatenation
 740     type Output;
 741
 742     /// Implementation of [`[T]::concat`](slice::concat)
 743     #[unstable(feature = "slice_concat_trait", issue = "27747")]
 744     fn concat(slice: &Self) -> Self::Output;
 745 }
 746
 747 /// Helper trait for [`[T]::join`](slice::join)
 748 #[unstable(feature = "slice_concat_trait", issue = "27747")]
 749 pub trait Join<Separator> {
 750     #[unstable(feature = "slice_concat_trait", issue = "27747")]
 751     /// The resulting type after concatenation
 752     type Output;
 753
 754     /// Implementation of [`[T]::join`](slice::join)
 755     #[unstable(feature = "slice_concat_trait", issue = "27747")]
 756     fn join(slice: &Self, sep: Separator) -> Self::Output;
 757 }
 758
 759 #[cfg(not(no_global_oom_handling))]
 760 #[unstable(feature = "slice_concat_ext", issue = "27747")]
 761 impl<T: Clone, V: Borrow<[T]>> Concat<T> for [V] {
 762     type Output = Vec<T>;
 763
 764     fn concat(slice: &Self) -> Vec<T> {
 765         let size = slice.iter().map(|slice| slice.borrow().len()).sum();
 766         let mut result = Vec::with_capacity(size);
 767         for v in slice {
 768             result.extend_from_slice(v.borrow())
 769         }
 770         result
 771     }
 772 }
 773
 774 #[cfg(not(no_global_oom_handling))]
 775 #[unstable(feature = "slice_concat_ext", issue = "27747")]
 776 impl<T: Clone, V: Borrow<[T]>> Join<&T> for [V] {
 777     type Output = Vec<T>;
 778
 779     fn join(slice: &Self, sep: &T) -> Vec<T> {
 780         let mut iter = slice.iter();
 781         let first = match iter.next() {
 782             Some(first) => first,
 783             None => return vec![],
 784         };
 785         let size = slice.iter().map(|v| v.borrow().len()).sum::<usize>() + slice.len() - 1;
 786         let mut result = Vec::with_capacity(size);
 787         result.extend_from_slice(first.borrow());
 788
 789         for v in iter {
 790             result.push(sep.clone());
 791             result.extend_from_slice(v.borrow())
 792         }
 793         result
 794     }
 795 }
 796
 797 #[cfg(not(no_global_oom_handling))]
 798 #[unstable(feature = "slice_concat_ext", issue = "27747")]
 799 impl<T: Clone, V: Borrow<[T]>> Join<&[T]> for [V] {
 800     type Output = Vec<T>;
 801
 802     fn join(slice: &Self, sep: &[T]) -> Vec<T> {
 803         let mut iter = slice.iter();
 804         let first = match iter.next() {
 805             Some(first) => first,
 806             None => return vec![],
 807         };
 808         let size =
 809             slice.iter().map(|v| v.borrow().len()).sum::<usize>() + sep.len() * (slice.len() - 1);
 810         let mut result = Vec::with_capacity(size);
 811         result.extend_from_slice(first.borrow());
 812
 813         for v in iter {
 814             result.extend_from_slice(sep);
 815             result.extend_from_slice(v.borrow())
 816         }
 817         result
 818     }
 819 }
 820
 821 ////////////////////////////////////////////////////////////////////////////////
 822 // Standard trait implementations for slices
 823 ////////////////////////////////////////////////////////////////////////////////
 824
 825 #[stable(feature = "rust1", since = "1.0.0")]
 826 impl<T> Borrow<[T]> for Vec<T> {
 827     fn borrow(&self) -> &[T] {
 828         &self[..]
 829     }
 830 }
 831
 832 #[stable(feature = "rust1", since = "1.0.0")]
 833 impl<T> BorrowMut<[T]> for Vec<T> {
 834     fn borrow_mut(&mut self) -> &mut [T] {
 835         &mut self[..]
 836     }
 837 }
 838
 839 #[cfg(not(no_global_oom_handling))]
 840 #[stable(feature = "rust1", since = "1.0.0")]
 841 impl<T: Clone> ToOwned for [T] {
 842     type Owned = Vec<T>;
 843     #[cfg(not(test))]
 844     fn to_owned(&self) -> Vec<T> {
 845         self.to_vec()
 846     }
 847
 848     #[cfg(test)]
 849     fn to_owned(&self) -> Vec<T> {
 850         hack::to_vec(self, Global)
 851     }
 852
 853     fn clone_into(&self, target: &mut Vec<T>) {
 854         // drop anything in target that will not be overwritten
 855         target.truncate(self.len());
 856
 857         // target.len <= self.len due to the truncate above, so the
 858         // slices here are always in-bounds.
 859         let (init, tail) = self.split_at(target.len());
 860
 861         // reuse the contained values' allocations/resources.
 862         target.clone_from_slice(init);
 863         target.extend_from_slice(tail);
 864     }
 865 }
 866
 867 ////////////////////////////////////////////////////////////////////////////////
 868 // Sorting
 869 ////////////////////////////////////////////////////////////////////////////////
 870
 871 /// Inserts `v[0]` into pre-sorted sequence `v[1..]` so that whole `v[..]` becomes sorted.
 872 ///
 873 /// This is the integral subroutine of insertion sort.
 874 #[cfg(not(no_global_oom_handling))]
 875 fn insert_head<T, F>(v: &mut [T], is_less: &mut F)
 876 where
 877     F: FnMut(&T, &T) -> bool,
 878 {
 879     if v.len() >= 2 && is_less(&v[1], &v[0]) {
 880         unsafe {
 881             // There are three ways to implement insertion here:
 882             //
 883             // 1. Swap adjacent elements until the first one gets to its final destination.
 884             //    However, this way we copy data around more than is necessary. If elements are big
 885             //    structures (costly to copy), this method will be slow.
 886             //
 887             // 2. Iterate until the right place for the first element is found. Then shift the
 888             //    elements succeeding it to make room for it and finally place it into the
 889             //    remaining hole. This is a good method.
 890             //
 891             // 3. Copy the first element into a temporary variable. Iterate until the right place
 892             //    for it is found. As we go along, copy every traversed element into the slot
 893             //    preceding it. Finally, copy data from the temporary variable into the remaining
 894             //    hole. This method is very good. Benchmarks demonstrated slightly better
 895             //    performance than with the 2nd method.
 896             //
 897             // All methods were benchmarked, and the 3rd showed best results. So we chose that one.
 898             let tmp = mem::ManuallyDrop::new(ptr::read(&v[0]));
 899
 900             // Intermediate state of the insertion process is always tracked by `hole`, which
 901             // serves two purposes:
 902             // 1. Protects integrity of `v` from panics in `is_less`.
 903             // 2. Fills the remaining hole in `v` in the end.
 904             //
 905             // Panic safety:
 906             //
 907             // If `is_less` panics at any point during the process, `hole` will get dropped and
 908             // fill the hole in `v` with `tmp`, thus ensuring that `v` still holds every object it
 909             // initially held exactly once.
 910             let mut hole = InsertionHole { src: &*tmp, dest: &mut v[1] };
 911             ptr::copy_nonoverlapping(&v[1], &mut v[0], 1);
 912
 913             for i in 2..v.len() {
 914                 if !is_less(&v[i], &*tmp) {
 915                     break;
 916                 }
 917                 ptr::copy_nonoverlapping(&v[i], &mut v[i - 1], 1);
 918                 hole.dest = &mut v[i];
 919             }
 920             // `hole` gets dropped and thus copies `tmp` into the remaining hole in `v`.
 921         }
 922     }
 923
 924     // When dropped, copies from `src` into `dest`.
 925     struct InsertionHole<T> {
 926         src: *const T,
 927         dest: *mut T,
 928     }
 929
 930     impl<T> Drop for InsertionHole<T> {
 931         fn drop(&mut self) {
 932             unsafe {
 933                 ptr::copy_nonoverlapping(self.src, self.dest, 1);
 934             }
 935         }
 936     }
 937 }
 938
 939 /// Merges non-decreasing runs `v[..mid]` and `v[mid..]` using `buf` as temporary storage, and
 940 /// stores the result into `v[..]`.
 941 ///
 942 /// # Safety
 943 ///
 944 /// The two slices must be non-empty and `mid` must be in bounds. Buffer `buf` must be long enough
 945 /// to hold a copy of the shorter slice. Also, `T` must not be a zero-sized type.
 946 #[cfg(not(no_global_oom_handling))]
 947 unsafe fn merge<T, F>(v: &mut [T], mid: usize, buf: *mut T, is_less: &mut F)
 948 where
 949     F: FnMut(&T, &T) -> bool,
 950 {
 951     let len = v.len();
 952     let v = v.as_mut_ptr();
 953     let (v_mid, v_end) = unsafe { (v.add(mid), v.add(len)) };
 954
 955     // The merge process first copies the shorter run into `buf`. Then it traces the newly copied
 956     // run and the longer run forwards (or backwards), comparing their next unconsumed elements and
 957     // copying the lesser (or greater) one into `v`.
 958     //
 959     // As soon as the shorter run is fully consumed, the process is done. If the longer run gets
 960     // consumed first, then we must copy whatever is left of the shorter run into the remaining
 961     // hole in `v`.
 962     //
 963     // Intermediate state of the process is always tracked by `hole`, which serves two purposes:
 964     // 1. Protects integrity of `v` from panics in `is_less`.
 965     // 2. Fills the remaining hole in `v` if the longer run gets consumed first.
 966     //
 967     // Panic safety:
 968     //
 969     // If `is_less` panics at any point during the process, `hole` will get dropped and fill the
 970     // hole in `v` with the unconsumed range in `buf`, thus ensuring that `v` still holds every
 971     // object it initially held exactly once.
 972     let mut hole;
 973
 974     if mid <= len - mid {
 975         // The left run is shorter.
 976         unsafe {
 977             ptr::copy_nonoverlapping(v, buf, mid);
 978             hole = MergeHole { start: buf, end: buf.add(mid), dest: v };
 979         }
 980
 981         // Initially, these pointers point to the beginnings of their arrays.
 982         let left = &mut hole.start;
 983         let mut right = v_mid;
 984         let out = &mut hole.dest;
 985
 986         while *left < hole.end && right < v_end {
 987             // Consume the lesser side.
 988             // If equal, prefer the left run to maintain stability.
 989             unsafe {
 990                 let to_copy = if is_less(&*right, &**left) {
 991                     get_and_increment(&mut right)
 992                 } else {
 993                     get_and_increment(left)
 994                 };
 995                 ptr::copy_nonoverlapping(to_copy, get_and_increment(out), 1);
 996             }
 997         }
 998     } else {
 999         // The right run is shorter.
1000         unsafe {
1001             ptr::copy_nonoverlapping(v_mid, buf, len - mid);
1002             hole = MergeHole { start: buf, end: buf.add(len - mid), dest: v_mid };
1003         }
1004
1005         // Initially, these pointers point past the ends of their arrays.
1006         let left = &mut hole.dest;
1007         let right = &mut hole.end;
1008         let mut out = v_end;
1009
1010         while v < *left && buf < *right {
1011             // Consume the greater side.
1012             // If equal, prefer the right run to maintain stability.
1013             unsafe {
1014                 let to_copy = if is_less(&*right.offset(-1), &*left.offset(-1)) {
1015                     decrement_and_get(left)
1016                 } else {
1017                     decrement_and_get(right)
1018                 };
1019                 ptr::copy_nonoverlapping(to_copy, decrement_and_get(&mut out), 1);
1020             }
1021         }
1022     }
1023     // Finally, `hole` gets dropped. If the shorter run was not fully consumed, whatever remains of
1024     // it will now be copied into the hole in `v`.
1025
1026     unsafe fn get_and_increment<T>(ptr: &mut *mut T) -> *mut T {
1027         let old = *ptr;
1028         *ptr = unsafe { ptr.offset(1) };
1029         old
1030     }
1031
1032     unsafe fn decrement_and_get<T>(ptr: &mut *mut T) -> *mut T {
1033         *ptr = unsafe { ptr.offset(-1) };
1034         *ptr
1035     }
1036
1037     // When dropped, copies the range `start..end` into `dest..`.
1038     struct MergeHole<T> {
1039         start: *mut T,
1040         end: *mut T,
1041         dest: *mut T,
1042     }
1043
1044     impl<T> Drop for MergeHole<T> {
1045         fn drop(&mut self) {
1046             // `T` is not a zero-sized type, so it's okay to divide by its size.
1047             let len = (self.end as usize - self.start as usize) / mem::size_of::<T>();
1048             unsafe {
1049                 ptr::copy_nonoverlapping(self.start, self.dest, len);
1050             }
1051         }
1052     }
1053 }
1054
1055 /// This merge sort borrows some (but not all) ideas from TimSort, which is described in detail
1056 /// [here](https://github.com/python/cpython/blob/main/Objects/listsort.txt).
1057 ///
1058 /// The algorithm identifies strictly descending and non-descending subsequences, which are called
1059 /// natural runs. There is a stack of pending runs yet to be merged. Each newly found run is pushed
1060 /// onto the stack, and then some pairs of adjacent runs are merged until these two invariants are
1061 /// satisfied:
1062 ///
1063 /// 1. for every `i` in `1..runs.len()`: `runs[i - 1].len > runs[i].len`
1064 /// 2. for every `i` in `2..runs.len()`: `runs[i - 2].len > runs[i - 1].len + runs[i].len`
1065 ///
1066 /// The invariants ensure that the total running time is *O*(*n* \* log(*n*)) worst-case.
1067 #[cfg(not(no_global_oom_handling))]
1068 fn merge_sort<T, F>(v: &mut [T], mut is_less: F)
1069 where
1070     F: FnMut(&T, &T) -> bool,
1071 {
1072     // Slices of up to this length get sorted using insertion sort.
1073     const MAX_INSERTION: usize = 20;
1074     // Very short runs are extended using insertion sort to span at least this many elements.
1075     const MIN_RUN: usize = 10;
1076
1077     // Sorting has no meaningful behavior on zero-sized types.
1078     if size_of::<T>() == 0 {
1079         return;
1080     }
1081
1082     let len = v.len();
1083
1084     // Short arrays get sorted in-place via insertion sort to avoid allocations.
1085     if len <= MAX_INSERTION {
1086         if len >= 2 {
1087             for i in (0..len - 1).rev() {
1088                 insert_head(&mut v[i..], &mut is_less);
1089             }
1090         }
1091         return;
1092     }
1093
1094     // Allocate a buffer to use as scratch memory. We keep the length 0 so we can keep in it
1095     // shallow copies of the contents of `v` without risking the dtors running on copies if
1096     // `is_less` panics. When merging two sorted runs, this buffer holds a copy of the shorter run,
1097     // which will always have length at most `len / 2`.
1098     let mut buf = Vec::with_capacity(len / 2);
1099
1100     // In order to identify natural runs in `v`, we traverse it backwards. That might seem like a
1101     // strange decision, but consider the fact that merges more often go in the opposite direction
1102     // (forwards). According to benchmarks, merging forwards is slightly faster than merging
1103     // backwards. To conclude, identifying runs by traversing backwards improves performance.
1104     let mut runs = vec![];
1105     let mut end = len;
1106     while end > 0 {
1107         // Find the next natural run, and reverse it if it's strictly descending.
1108         let mut start = end - 1;
1109         if start > 0 {
1110             start -= 1;
1111             unsafe {
1112                 if is_less(v.get_unchecked(start + 1), v.get_unchecked(start)) {
1113                     while start > 0 && is_less(v.get_unchecked(start), v.get_unchecked(start - 1)) {
1114                         start -= 1;
1115                     }
1116                     v[start..end].reverse();
1117                 } else {
1118                     while start > 0 && !is_less(v.get_unchecked(start), v.get_unchecked(start - 1))
1119                     {
1120                         start -= 1;
1121                     }
1122                 }
1123             }
1124         }
1125
1126         // Insert some more elements into the run if it's too short. Insertion sort is faster than
1127         // merge sort on short sequences, so this significantly improves performance.
1128         while start > 0 && end - start < MIN_RUN {
1129             start -= 1;
1130             insert_head(&mut v[start..end], &mut is_less);
1131         }
1132
1133         // Push this run onto the stack.
1134         runs.push(Run { start, len: end - start });
1135         end = start;
1136
1137         // Merge some pairs of adjacent runs to satisfy the invariants.
1138         while let Some(r) = collapse(&runs) {
1139             let left = runs[r + 1];
1140             let right = runs[r];
1141             unsafe {
1142                 merge(
1143                     &mut v[left.start..right.start + right.len],
1144                     left.len,
1145                     buf.as_mut_ptr(),
1146                     &mut is_less,
1147                 );
1148             }
1149             runs[r] = Run { start: left.start, len: left.len + right.len };
1150             runs.remove(r + 1);
1151         }
1152     }
1153
1154     // Finally, exactly one run must remain in the stack.
1155     debug_assert!(runs.len() == 1 && runs[0].start == 0 && runs[0].len == len);
1156
1157     // Examines the stack of runs and identifies the next pair of runs to merge. More specifically,
1158     // if `Some(r)` is returned, that means `runs[r]` and `runs[r + 1]` must be merged next. If the
1159     // algorithm should continue building a new run instead, `None` is returned.
1160     //
1161     // TimSort is infamous for its buggy implementations, as described here:
1162     // http://envisage-project.eu/timsort-specification-and-verification/
1163     //
1164     // The gist of the story is: we must enforce the invariants on the top four runs on the stack.
1165     // Enforcing them on just top three is not sufficient to ensure that the invariants will still
1166     // hold for *all* runs in the stack.
1167     //
1168     // This function correctly checks invariants for the top four runs. Additionally, if the top
1169     // run starts at index 0, it will always demand a merge operation until the stack is fully
1170     // collapsed, in order to complete the sort.
1171     #[inline]
1172     fn collapse(runs: &[Run]) -> Option<usize> {
1173         let n = runs.len();
1174         if n >= 2
1175             && (runs[n - 1].start == 0
1176                 || runs[n - 2].len <= runs[n - 1].len
1177                 || (n >= 3 && runs[n - 3].len <= runs[n - 2].len + runs[n - 1].len)
1178                 || (n >= 4 && runs[n - 4].len <= runs[n - 3].len + runs[n - 2].len))
1179         {
1180             if n >= 3 && runs[n - 3].len < runs[n - 1].len { Some(n - 3) } else { Some(n - 2) }
1181         } else {
1182             None
1183         }
1184     }
1185
1186     #[derive(Clone, Copy)]
1187     struct Run {
1188         start: usize,
1189         len: usize,
1190     }
1191 }