src/libcollections/slice.rs

   1 // Copyright 2012-2015 The Rust Project Developers. See the COPYRIGHT
   2 // file at the top-level directory of this distribution and at
   3 // http://rust-lang.org/COPYRIGHT.
   4 //
   5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
   6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
   7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
   8 // option. This file may not be copied, modified, or distributed
   9 // except according to those terms.
  10
  11 //! A dynamically-sized view into a contiguous sequence, `[T]`.
  12 //!
  13 //! Slices are a view into a block of memory represented as a pointer and a
  14 //! length.
  15 //!
  16 //! ```
  17 //! // slicing a Vec
  18 //! let vec = vec![1, 2, 3];
  19 //! let int_slice = &vec[..];
  20 //! // coercing an array to a slice
  21 //! let str_slice: &[&str] = &["one", "two", "three"];
  22 //! ```
  23 //!
  24 //! Slices are either mutable or shared. The shared slice type is `&[T]`,
  25 //! while the mutable slice type is `&mut [T]`, where `T` represents the element
  26 //! type. For example, you can mutate the block of memory that a mutable slice
  27 //! points to:
  28 //!
  29 //! ```
  30 //! let x = &mut [1, 2, 3];
  31 //! x[1] = 7;
  32 //! assert_eq!(x, &[1, 7, 3]);
  33 //! ```
  34 //!
  35 //! Here are some of the things this module contains:
  36 //!
  37 //! ## Structs
  38 //!
  39 //! There are several structs that are useful for slices, such as `Iter`, which
  40 //! represents iteration over a slice.
  41 //!
  42 //! ## Trait Implementations
  43 //!
  44 //! There are several implementations of common traits for slices. Some examples
  45 //! include:
  46 //!
  47 //! * `Clone`
  48 //! * `Eq`, `Ord` - for slices whose element type are `Eq` or `Ord`.
  49 //! * `Hash` - for slices whose element type is `Hash`
  50 //!
  51 //! ## Iteration
  52 //!
  53 //! The slices implement `IntoIterator`. The iterator yields references to the
  54 //! slice elements.
  55 //!
  56 //! ```
  57 //! let numbers = &[0, 1, 2];
  58 //! for n in numbers {
  59 //!     println!("{} is a number!", n);
  60 //! }
  61 //! ```
  62 //!
  63 //! The mutable slice yields mutable references to the elements:
  64 //!
  65 //! ```
  66 //! let mut scores = [7, 8, 9];
  67 //! for score in &mut scores[..] {
  68 //!     *score += 1;
  69 //! }
  70 //! ```
  71 //!
  72 //! This iterator yields mutable references to the slice's elements, so while
  73 //! the element type of the slice is `i32`, the element type of the iterator is
  74 //! `&mut i32`.
  75 //!
  76 //! * `.iter()` and `.iter_mut()` are the explicit methods to return the default
  77 //!   iterators.
  78 //! * Further methods that return iterators are `.split()`, `.splitn()`,
  79 //!   `.chunks()`, `.windows()` and more.
  80 //!
  81 //! *[See also the slice primitive type](../../std/primitive.slice.html).*
  82 #![stable(feature = "rust1", since = "1.0.0")]
  83
  84 // Many of the usings in this module are only used in the test configuration.
  85 // It's cleaner to just turn off the unused_imports warning than to fix them.
  86 #![cfg_attr(test, allow(unused_imports, dead_code))]
  87
  88 use alloc::boxed::Box;
  89 use core::cmp::Ordering::{self, Greater, Less};
  90 use core::cmp;
  91 use core::mem::size_of;
  92 use core::mem;
  93 use core::ptr;
  94 use core::slice as core_slice;
  95
  96 use borrow::{Borrow, BorrowMut, ToOwned};
  97 use vec::Vec;
  98
  99 #[stable(feature = "rust1", since = "1.0.0")]
 100 pub use core::slice::{Chunks, Windows};
 101 #[stable(feature = "rust1", since = "1.0.0")]
 102 pub use core::slice::{Iter, IterMut};
 103 #[stable(feature = "rust1", since = "1.0.0")]
 104 pub use core::slice::{SplitMut, ChunksMut, Split};
 105 #[stable(feature = "rust1", since = "1.0.0")]
 106 pub use core::slice::{SplitN, RSplitN, SplitNMut, RSplitNMut};
 107 #[stable(feature = "rust1", since = "1.0.0")]
 108 pub use core::slice::{from_raw_parts, from_raw_parts_mut};
 109
 110 ////////////////////////////////////////////////////////////////////////////////
 111 // Basic slice extension methods
 112 ////////////////////////////////////////////////////////////////////////////////
 113
 114 // HACK(japaric) needed for the implementation of `vec!` macro during testing
 115 // NB see the hack module in this file for more details
 116 #[cfg(test)]
 117 pub use self::hack::into_vec;
 118
 119 // HACK(japaric) needed for the implementation of `Vec::clone` during testing
 120 // NB see the hack module in this file for more details
 121 #[cfg(test)]
 122 pub use self::hack::to_vec;
 123
 124 // HACK(japaric): With cfg(test) `impl [T]` is not available, these three
 125 // functions are actually methods that are in `impl [T]` but not in
 126 // `core::slice::SliceExt` - we need to supply these functions for the
 127 // `test_permutations` test
 128 mod hack {
 129     use alloc::boxed::Box;
 130     use core::mem;
 131
 132     #[cfg(test)]
 133     use string::ToString;
 134     use vec::Vec;
 135
 136     pub fn into_vec<T>(mut b: Box<[T]>) -> Vec<T> {
 137         unsafe {
 138             let xs = Vec::from_raw_parts(b.as_mut_ptr(), b.len(), b.len());
 139             mem::forget(b);
 140             xs
 141         }
 142     }
 143
 144     #[inline]
 145     pub fn to_vec<T>(s: &[T]) -> Vec<T>
 146         where T: Clone
 147     {
 148         let mut vector = Vec::with_capacity(s.len());
 149         vector.extend_from_slice(s);
 150         vector
 151     }
 152 }
 153
 154 #[lang = "slice"]
 155 #[cfg(not(test))]
 156 impl<T> [T] {
 157     /// Returns the number of elements in the slice.
 158     ///
 159     /// # Example
 160     ///
 161     /// ```
 162     /// let a = [1, 2, 3];
 163     /// assert_eq!(a.len(), 3);
 164     /// ```
 165     #[stable(feature = "rust1", since = "1.0.0")]
 166     #[inline]
 167     pub fn len(&self) -> usize {
 168         core_slice::SliceExt::len(self)
 169     }
 170
 171     /// Returns true if the slice has a length of 0
 172     ///
 173     /// # Example
 174     ///
 175     /// ```
 176     /// let a = [1, 2, 3];
 177     /// assert!(!a.is_empty());
 178     /// ```
 179     #[stable(feature = "rust1", since = "1.0.0")]
 180     #[inline]
 181     pub fn is_empty(&self) -> bool {
 182         core_slice::SliceExt::is_empty(self)
 183     }
 184
 185     /// Returns the first element of a slice, or `None` if it is empty.
 186     ///
 187     /// # Examples
 188     ///
 189     /// ```
 190     /// let v = [10, 40, 30];
 191     /// assert_eq!(Some(&10), v.first());
 192     ///
 193     /// let w: &[i32] = &[];
 194     /// assert_eq!(None, w.first());
 195     /// ```
 196     #[stable(feature = "rust1", since = "1.0.0")]
 197     #[inline]
 198     pub fn first(&self) -> Option<&T> {
 199         core_slice::SliceExt::first(self)
 200     }
 201
 202     /// Returns a mutable pointer to the first element of a slice, or `None` if it is empty.
 203     ///
 204     /// # Examples
 205     ///
 206     /// ```
 207     /// let x = &mut [0, 1, 2];
 208     ///
 209     /// if let Some(first) = x.first_mut() {
 210     ///     *first = 5;
 211     /// }
 212     /// assert_eq!(x, &[5, 1, 2]);
 213     /// ```
 214     #[stable(feature = "rust1", since = "1.0.0")]
 215     #[inline]
 216     pub fn first_mut(&mut self) -> Option<&mut T> {
 217         core_slice::SliceExt::first_mut(self)
 218     }
 219
 220     /// Returns the first and all the rest of the elements of a slice.
 221     ///
 222     /// # Examples
 223     ///
 224     /// ```
 225     /// let x = &[0, 1, 2];
 226     ///
 227     /// if let Some((first, elements)) = x.split_first() {
 228     ///     assert_eq!(first, &0);
 229     ///     assert_eq!(elements, &[1, 2]);
 230     /// }
 231     /// ```
 232     #[stable(feature = "slice_splits", since = "1.5.0")]
 233     #[inline]
 234     pub fn split_first(&self) -> Option<(&T, &[T])> {
 235         core_slice::SliceExt::split_first(self)
 236     }
 237
 238     /// Returns the first and all the rest of the elements of a slice.
 239     ///
 240     /// # Examples
 241     ///
 242     /// ```
 243     /// let x = &mut [0, 1, 2];
 244     ///
 245     /// if let Some((first, elements)) = x.split_first_mut() {
 246     ///     *first = 3;
 247     ///     elements[0] = 4;
 248     ///     elements[1] = 5;
 249     /// }
 250     /// assert_eq!(x, &[3, 4, 5]);
 251     /// ```
 252     #[stable(feature = "slice_splits", since = "1.5.0")]
 253     #[inline]
 254     pub fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])> {
 255         core_slice::SliceExt::split_first_mut(self)
 256     }
 257
 258     /// Returns the last and all the rest of the elements of a slice.
 259     ///
 260     /// # Examples
 261     ///
 262     /// ```
 263     /// let x = &[0, 1, 2];
 264     ///
 265     /// if let Some((last, elements)) = x.split_last() {
 266     ///     assert_eq!(last, &2);
 267     ///     assert_eq!(elements, &[0, 1]);
 268     /// }
 269     /// ```
 270     #[stable(feature = "slice_splits", since = "1.5.0")]
 271     #[inline]
 272     pub fn split_last(&self) -> Option<(&T, &[T])> {
 273         core_slice::SliceExt::split_last(self)
 274
 275     }
 276
 277     /// Returns the last and all the rest of the elements of a slice.
 278     ///
 279     /// # Examples
 280     ///
 281     /// ```
 282     /// let x = &mut [0, 1, 2];
 283     ///
 284     /// if let Some((last, elements)) = x.split_last_mut() {
 285     ///     *last = 3;
 286     ///     elements[0] = 4;
 287     ///     elements[1] = 5;
 288     /// }
 289     /// assert_eq!(x, &[4, 5, 3]);
 290     /// ```
 291     #[stable(feature = "slice_splits", since = "1.5.0")]
 292     #[inline]
 293     pub fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])> {
 294         core_slice::SliceExt::split_last_mut(self)
 295     }
 296
 297     /// Returns the last element of a slice, or `None` if it is empty.
 298     ///
 299     /// # Examples
 300     ///
 301     /// ```
 302     /// let v = [10, 40, 30];
 303     /// assert_eq!(Some(&30), v.last());
 304     ///
 305     /// let w: &[i32] = &[];
 306     /// assert_eq!(None, w.last());
 307     /// ```
 308     #[stable(feature = "rust1", since = "1.0.0")]
 309     #[inline]
 310     pub fn last(&self) -> Option<&T> {
 311         core_slice::SliceExt::last(self)
 312     }
 313
 314     /// Returns a mutable pointer to the last item in the slice.
 315     ///
 316     /// # Examples
 317     ///
 318     /// ```
 319     /// let x = &mut [0, 1, 2];
 320     ///
 321     /// if let Some(last) = x.last_mut() {
 322     ///     *last = 10;
 323     /// }
 324     /// assert_eq!(x, &[0, 1, 10]);
 325     /// ```
 326     #[stable(feature = "rust1", since = "1.0.0")]
 327     #[inline]
 328     pub fn last_mut(&mut self) -> Option<&mut T> {
 329         core_slice::SliceExt::last_mut(self)
 330     }
 331
 332     /// Returns the element of a slice at the given index, or `None` if the
 333     /// index is out of bounds.
 334     ///
 335     /// # Examples
 336     ///
 337     /// ```
 338     /// let v = [10, 40, 30];
 339     /// assert_eq!(Some(&40), v.get(1));
 340     /// assert_eq!(None, v.get(3));
 341     /// ```
 342     #[stable(feature = "rust1", since = "1.0.0")]
 343     #[inline]
 344     pub fn get(&self, index: usize) -> Option<&T> {
 345         core_slice::SliceExt::get(self, index)
 346     }
 347
 348     /// Returns a mutable reference to the element at the given index.
 349     ///
 350     /// # Examples
 351     ///
 352     /// ```
 353     /// let x = &mut [0, 1, 2];
 354     ///
 355     /// if let Some(elem) = x.get_mut(1) {
 356     ///     *elem = 42;
 357     /// }
 358     /// assert_eq!(x, &[0, 42, 2]);
 359     /// ```
 360     /// or `None` if the index is out of bounds
 361     #[stable(feature = "rust1", since = "1.0.0")]
 362     #[inline]
 363     pub fn get_mut(&mut self, index: usize) -> Option<&mut T> {
 364         core_slice::SliceExt::get_mut(self, index)
 365     }
 366
 367     /// Returns a pointer to the element at the given index, without doing
 368     /// bounds checking. So use it very carefully!
 369     ///
 370     /// # Examples
 371     ///
 372     /// ```
 373     /// let x = &[1, 2, 4];
 374     ///
 375     /// unsafe {
 376     ///     assert_eq!(x.get_unchecked(1), &2);
 377     /// }
 378     /// ```
 379     #[stable(feature = "rust1", since = "1.0.0")]
 380     #[inline]
 381     pub unsafe fn get_unchecked(&self, index: usize) -> &T {
 382         core_slice::SliceExt::get_unchecked(self, index)
 383     }
 384
 385     /// Returns an unsafe mutable pointer to the element in index. So use it
 386     /// very carefully!
 387     ///
 388     /// # Examples
 389     ///
 390     /// ```
 391     /// let x = &mut [1, 2, 4];
 392     ///
 393     /// unsafe {
 394     ///     let elem = x.get_unchecked_mut(1);
 395     ///     *elem = 13;
 396     /// }
 397     /// assert_eq!(x, &[1, 13, 4]);
 398     /// ```
 399     #[stable(feature = "rust1", since = "1.0.0")]
 400     #[inline]
 401     pub unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
 402         core_slice::SliceExt::get_unchecked_mut(self, index)
 403     }
 404
 405     /// Returns an raw pointer to the slice's buffer
 406     ///
 407     /// The caller must ensure that the slice outlives the pointer this
 408     /// function returns, or else it will end up pointing to garbage.
 409     ///
 410     /// Modifying the slice may cause its buffer to be reallocated, which
 411     /// would also make any pointers to it invalid.
 412     ///
 413     /// # Examples
 414     ///
 415     /// ```
 416     /// let x = &[1, 2, 4];
 417     /// let x_ptr = x.as_ptr();
 418     ///
 419     /// unsafe {
 420     ///     for i in 0..x.len() {
 421     ///         assert_eq!(x.get_unchecked(i), &*x_ptr.offset(i as isize));
 422     ///     }
 423     /// }
 424     /// ```
 425     #[stable(feature = "rust1", since = "1.0.0")]
 426     #[inline]
 427     pub fn as_ptr(&self) -> *const T {
 428         core_slice::SliceExt::as_ptr(self)
 429     }
 430
 431     /// Returns an unsafe mutable pointer to the slice's buffer.
 432     ///
 433     /// The caller must ensure that the slice outlives the pointer this
 434     /// function returns, or else it will end up pointing to garbage.
 435     ///
 436     /// Modifying the slice may cause its buffer to be reallocated, which
 437     /// would also make any pointers to it invalid.
 438     ///
 439     /// # Examples
 440     ///
 441     /// ```
 442     /// let x = &mut [1, 2, 4];
 443     /// let x_ptr = x.as_mut_ptr();
 444     ///
 445     /// unsafe {
 446     ///     for i in 0..x.len() {
 447     ///         *x_ptr.offset(i as isize) += 2;
 448     ///     }
 449     /// }
 450     /// assert_eq!(x, &[3, 4, 6]);
 451     /// ```
 452     #[stable(feature = "rust1", since = "1.0.0")]
 453     #[inline]
 454     pub fn as_mut_ptr(&mut self) -> *mut T {
 455         core_slice::SliceExt::as_mut_ptr(self)
 456     }
 457
 458     /// Swaps two elements in a slice.
 459     ///
 460     /// # Arguments
 461     ///
 462     /// * a - The index of the first element
 463     /// * b - The index of the second element
 464     ///
 465     /// # Panics
 466     ///
 467     /// Panics if `a` or `b` are out of bounds.
 468     ///
 469     /// # Examples
 470     ///
 471     /// ```rust
 472     /// let mut v = ["a", "b", "c", "d"];
 473     /// v.swap(1, 3);
 474     /// assert!(v == ["a", "d", "c", "b"]);
 475     /// ```
 476     #[stable(feature = "rust1", since = "1.0.0")]
 477     #[inline]
 478     pub fn swap(&mut self, a: usize, b: usize) {
 479         core_slice::SliceExt::swap(self, a, b)
 480     }
 481
 482     /// Reverse the order of elements in a slice, in place.
 483     ///
 484     /// # Example
 485     ///
 486     /// ```rust
 487     /// let mut v = [1, 2, 3];
 488     /// v.reverse();
 489     /// assert!(v == [3, 2, 1]);
 490     /// ```
 491     #[stable(feature = "rust1", since = "1.0.0")]
 492     #[inline]
 493     pub fn reverse(&mut self) {
 494         core_slice::SliceExt::reverse(self)
 495     }
 496
 497     /// Returns an iterator over the slice.
 498     ///
 499     /// # Examples
 500     ///
 501     /// ```
 502     /// let x = &[1, 2, 4];
 503     /// let mut iterator = x.iter();
 504     ///
 505     /// assert_eq!(iterator.next(), Some(&1));
 506     /// assert_eq!(iterator.next(), Some(&2));
 507     /// assert_eq!(iterator.next(), Some(&4));
 508     /// assert_eq!(iterator.next(), None);
 509     /// ```
 510     #[stable(feature = "rust1", since = "1.0.0")]
 511     #[inline]
 512     pub fn iter(&self) -> Iter<T> {
 513         core_slice::SliceExt::iter(self)
 514     }
 515
 516     /// Returns an iterator that allows modifying each value.
 517     ///
 518     /// # Examples
 519     ///
 520     /// ```
 521     /// let x = &mut [1, 2, 4];
 522     /// {
 523     ///     let iterator = x.iter_mut();
 524     ///
 525     ///     for elem in iterator {
 526     ///         *elem += 2;
 527     ///     }
 528     /// }
 529     /// assert_eq!(x, &[3, 4, 6]);
 530     /// ```
 531     #[stable(feature = "rust1", since = "1.0.0")]
 532     #[inline]
 533     pub fn iter_mut(&mut self) -> IterMut<T> {
 534         core_slice::SliceExt::iter_mut(self)
 535     }
 536
 537     /// Returns an iterator over all contiguous windows of length
 538     /// `size`. The windows overlap. If the slice is shorter than
 539     /// `size`, the iterator returns no values.
 540     ///
 541     /// # Panics
 542     ///
 543     /// Panics if `size` is 0.
 544     ///
 545     /// # Example
 546     ///
 547     /// Print the adjacent pairs of a slice (i.e. `[1,2]`, `[2,3]`,
 548     /// `[3,4]`):
 549     ///
 550     /// ```rust
 551     /// let v = &[1, 2, 3, 4];
 552     /// for win in v.windows(2) {
 553     ///     println!("{:?}", win);
 554     /// }
 555     /// ```
 556     #[stable(feature = "rust1", since = "1.0.0")]
 557     #[inline]
 558     pub fn windows(&self, size: usize) -> Windows<T> {
 559         core_slice::SliceExt::windows(self, size)
 560     }
 561
 562     /// Returns an iterator over `size` elements of the slice at a
 563     /// time. The chunks are slices and do not overlap. If `size` does not divide the
 564     /// length of the slice, then the last chunk will not have length
 565     /// `size`.
 566     ///
 567     /// # Panics
 568     ///
 569     /// Panics if `size` is 0.
 570     ///
 571     /// # Example
 572     ///
 573     /// Print the slice two elements at a time (i.e. `[1,2]`,
 574     /// `[3,4]`, `[5]`):
 575     ///
 576     /// ```rust
 577     /// let v = &[1, 2, 3, 4, 5];
 578     ///
 579     /// for chunk in v.chunks(2) {
 580     ///     println!("{:?}", chunk);
 581     /// }
 582     /// ```
 583     #[stable(feature = "rust1", since = "1.0.0")]
 584     #[inline]
 585     pub fn chunks(&self, size: usize) -> Chunks<T> {
 586         core_slice::SliceExt::chunks(self, size)
 587     }
 588
 589     /// Returns an iterator over `chunk_size` elements of the slice at a time.
 590     /// The chunks are mutable slices, and do not overlap. If `chunk_size` does
 591     /// not divide the length of the slice, then the last chunk will not
 592     /// have length `chunk_size`.
 593     ///
 594     /// # Panics
 595     ///
 596     /// Panics if `chunk_size` is 0.
 597     ///
 598     /// # Examples
 599     ///
 600     /// ```
 601     /// let v = &mut [0, 0, 0, 0, 0];
 602     /// let mut count = 1;
 603     ///
 604     /// for chunk in v.chunks_mut(2) {
 605     ///     for elem in chunk.iter_mut() {
 606     ///         *elem += count;
 607     ///     }
 608     ///     count += 1;
 609     /// }
 610     /// assert_eq!(v, &[1, 1, 2, 2, 3]);
 611     /// ```
 612     #[stable(feature = "rust1", since = "1.0.0")]
 613     #[inline]
 614     pub fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<T> {
 615         core_slice::SliceExt::chunks_mut(self, chunk_size)
 616     }
 617
 618     /// Divides one slice into two at an index.
 619     ///
 620     /// The first will contain all indices from `[0, mid)` (excluding
 621     /// the index `mid` itself) and the second will contain all
 622     /// indices from `[mid, len)` (excluding the index `len` itself).
 623     ///
 624     /// # Panics
 625     ///
 626     /// Panics if `mid > len`.
 627     ///
 628     /// # Examples
 629     ///
 630     /// ```
 631     /// let v = [10, 40, 30, 20, 50];
 632     /// let (v1, v2) = v.split_at(2);
 633     /// assert_eq!([10, 40], v1);
 634     /// assert_eq!([30, 20, 50], v2);
 635     /// ```
 636     #[stable(feature = "rust1", since = "1.0.0")]
 637     #[inline]
 638     pub fn split_at(&self, mid: usize) -> (&[T], &[T]) {
 639         core_slice::SliceExt::split_at(self, mid)
 640     }
 641
 642     /// Divides one `&mut` into two at an index.
 643     ///
 644     /// The first will contain all indices from `[0, mid)` (excluding
 645     /// the index `mid` itself) and the second will contain all
 646     /// indices from `[mid, len)` (excluding the index `len` itself).
 647     ///
 648     /// # Panics
 649     ///
 650     /// Panics if `mid > len`.
 651     ///
 652     /// # Examples
 653     ///
 654     /// ```rust
 655     /// let mut v = [1, 2, 3, 4, 5, 6];
 656     ///
 657     /// // scoped to restrict the lifetime of the borrows
 658     /// {
 659     ///    let (left, right) = v.split_at_mut(0);
 660     ///    assert!(left == []);
 661     ///    assert!(right == [1, 2, 3, 4, 5, 6]);
 662     /// }
 663     ///
 664     /// {
 665     ///     let (left, right) = v.split_at_mut(2);
 666     ///     assert!(left == [1, 2]);
 667     ///     assert!(right == [3, 4, 5, 6]);
 668     /// }
 669     ///
 670     /// {
 671     ///     let (left, right) = v.split_at_mut(6);
 672     ///     assert!(left == [1, 2, 3, 4, 5, 6]);
 673     ///     assert!(right == []);
 674     /// }
 675     /// ```
 676     #[stable(feature = "rust1", since = "1.0.0")]
 677     #[inline]
 678     pub fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T]) {
 679         core_slice::SliceExt::split_at_mut(self, mid)
 680     }
 681
 682     /// Returns an iterator over subslices separated by elements that match
 683     /// `pred`. The matched element is not contained in the subslices.
 684     ///
 685     /// # Examples
 686     ///
 687     /// Print the slice split by numbers divisible by 3 (i.e. `[10, 40]`,
 688     /// `[20]`, `[50]`):
 689     ///
 690     /// ```
 691     /// let v = [10, 40, 30, 20, 60, 50];
 692     ///
 693     /// for group in v.split(|num| *num % 3 == 0) {
 694     ///     println!("{:?}", group);
 695     /// }
 696     /// ```
 697     #[stable(feature = "rust1", since = "1.0.0")]
 698     #[inline]
 699     pub fn split<F>(&self, pred: F) -> Split<T, F>
 700         where F: FnMut(&T) -> bool
 701     {
 702         core_slice::SliceExt::split(self, pred)
 703     }
 704
 705     /// Returns an iterator over mutable subslices separated by elements that
 706     /// match `pred`. The matched element is not contained in the subslices.
 707     ///
 708     /// # Examples
 709     ///
 710     /// ```
 711     /// let mut v = [10, 40, 30, 20, 60, 50];
 712     ///
 713     /// for group in v.split_mut(|num| *num % 3 == 0) {
 714     ///     group[0] = 1;
 715     /// }
 716     /// assert_eq!(v, [1, 40, 30, 1, 60, 1]);
 717     /// ```
 718     #[stable(feature = "rust1", since = "1.0.0")]
 719     #[inline]
 720     pub fn split_mut<F>(&mut self, pred: F) -> SplitMut<T, F>
 721         where F: FnMut(&T) -> bool
 722     {
 723         core_slice::SliceExt::split_mut(self, pred)
 724     }
 725
 726     /// Returns an iterator over subslices separated by elements that match
 727     /// `pred`, limited to returning at most `n` items.  The matched element is
 728     /// not contained in the subslices.
 729     ///
 730     /// The last element returned, if any, will contain the remainder of the
 731     /// slice.
 732     ///
 733     /// # Examples
 734     ///
 735     /// Print the slice split once by numbers divisible by 3 (i.e. `[10, 40]`,
 736     /// `[20, 60, 50]`):
 737     ///
 738     /// ```
 739     /// let v = [10, 40, 30, 20, 60, 50];
 740     ///
 741     /// for group in v.splitn(2, |num| *num % 3 == 0) {
 742     ///     println!("{:?}", group);
 743     /// }
 744     /// ```
 745     #[stable(feature = "rust1", since = "1.0.0")]
 746     #[inline]
 747     pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<T, F>
 748         where F: FnMut(&T) -> bool
 749     {
 750         core_slice::SliceExt::splitn(self, n, pred)
 751     }
 752
 753     /// Returns an iterator over subslices separated by elements that match
 754     /// `pred`, limited to returning at most `n` items.  The matched element is
 755     /// not contained in the subslices.
 756     ///
 757     /// The last element returned, if any, will contain the remainder of the
 758     /// slice.
 759     ///
 760     /// # Examples
 761     ///
 762     /// ```
 763     /// let mut v = [10, 40, 30, 20, 60, 50];
 764     ///
 765     /// for group in v.splitn_mut(2, |num| *num % 3 == 0) {
 766     ///     group[0] = 1;
 767     /// }
 768     /// assert_eq!(v, [1, 40, 30, 1, 60, 50]);
 769     /// ```
 770     #[stable(feature = "rust1", since = "1.0.0")]
 771     #[inline]
 772     pub fn splitn_mut<F>(&mut self, n: usize, pred: F) -> SplitNMut<T, F>
 773         where F: FnMut(&T) -> bool
 774     {
 775         core_slice::SliceExt::splitn_mut(self, n, pred)
 776     }
 777
 778     /// Returns an iterator over subslices separated by elements that match
 779     /// `pred` limited to returning at most `n` items. This starts at the end of
 780     /// the slice and works backwards.  The matched element is not contained in
 781     /// the subslices.
 782     ///
 783     /// The last element returned, if any, will contain the remainder of the
 784     /// slice.
 785     ///
 786     /// # Examples
 787     ///
 788     /// Print the slice split once, starting from the end, by numbers divisible
 789     /// by 3 (i.e. `[50]`, `[10, 40, 30, 20]`):
 790     ///
 791     /// ```
 792     /// let v = [10, 40, 30, 20, 60, 50];
 793     ///
 794     /// for group in v.rsplitn(2, |num| *num % 3 == 0) {
 795     ///     println!("{:?}", group);
 796     /// }
 797     /// ```
 798     #[stable(feature = "rust1", since = "1.0.0")]
 799     #[inline]
 800     pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<T, F>
 801         where F: FnMut(&T) -> bool
 802     {
 803         core_slice::SliceExt::rsplitn(self, n, pred)
 804     }
 805
 806     /// Returns an iterator over subslices separated by elements that match
 807     /// `pred` limited to returning at most `n` items. This starts at the end of
 808     /// the slice and works backwards.  The matched element is not contained in
 809     /// the subslices.
 810     ///
 811     /// The last element returned, if any, will contain the remainder of the
 812     /// slice.
 813     ///
 814     /// # Examples
 815     ///
 816     /// ```
 817     /// let mut s = [10, 40, 30, 20, 60, 50];
 818     ///
 819     /// for group in s.rsplitn_mut(2, |num| *num % 3 == 0) {
 820     ///     group[0] = 1;
 821     /// }
 822     /// assert_eq!(s, [1, 40, 30, 20, 60, 1]);
 823     /// ```
 824     #[stable(feature = "rust1", since = "1.0.0")]
 825     #[inline]
 826     pub fn rsplitn_mut<F>(&mut self, n: usize, pred: F) -> RSplitNMut<T, F>
 827         where F: FnMut(&T) -> bool
 828     {
 829         core_slice::SliceExt::rsplitn_mut(self, n, pred)
 830     }
 831
 832     /// Returns true if the slice contains an element with the given value.
 833     ///
 834     /// # Examples
 835     ///
 836     /// ```
 837     /// let v = [10, 40, 30];
 838     /// assert!(v.contains(&30));
 839     /// assert!(!v.contains(&50));
 840     /// ```
 841     #[stable(feature = "rust1", since = "1.0.0")]
 842     pub fn contains(&self, x: &T) -> bool
 843         where T: PartialEq
 844     {
 845         core_slice::SliceExt::contains(self, x)
 846     }
 847
 848     /// Returns true if `needle` is a prefix of the slice.
 849     ///
 850     /// # Examples
 851     ///
 852     /// ```
 853     /// let v = [10, 40, 30];
 854     /// assert!(v.starts_with(&[10]));
 855     /// assert!(v.starts_with(&[10, 40]));
 856     /// assert!(!v.starts_with(&[50]));
 857     /// assert!(!v.starts_with(&[10, 50]));
 858     /// ```
 859     #[stable(feature = "rust1", since = "1.0.0")]
 860     pub fn starts_with(&self, needle: &[T]) -> bool
 861         where T: PartialEq
 862     {
 863         core_slice::SliceExt::starts_with(self, needle)
 864     }
 865
 866     /// Returns true if `needle` is a suffix of the slice.
 867     ///
 868     /// # Examples
 869     ///
 870     /// ```
 871     /// let v = [10, 40, 30];
 872     /// assert!(v.ends_with(&[30]));
 873     /// assert!(v.ends_with(&[40, 30]));
 874     /// assert!(!v.ends_with(&[50]));
 875     /// assert!(!v.ends_with(&[50, 30]));
 876     /// ```
 877     #[stable(feature = "rust1", since = "1.0.0")]
 878     pub fn ends_with(&self, needle: &[T]) -> bool
 879         where T: PartialEq
 880     {
 881         core_slice::SliceExt::ends_with(self, needle)
 882     }
 883
 884     /// Binary search a sorted slice for a given element.
 885     ///
 886     /// If the value is found then `Ok` is returned, containing the
 887     /// index of the matching element; if the value is not found then
 888     /// `Err` is returned, containing the index where a matching
 889     /// element could be inserted while maintaining sorted order.
 890     ///
 891     /// # Example
 892     ///
 893     /// Looks up a series of four elements. The first is found, with a
 894     /// uniquely determined position; the second and third are not
 895     /// found; the fourth could match any position in `[1,4]`.
 896     ///
 897     /// ```rust
 898     /// let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
 899     ///
 900     /// assert_eq!(s.binary_search(&13),  Ok(9));
 901     /// assert_eq!(s.binary_search(&4),   Err(7));
 902     /// assert_eq!(s.binary_search(&100), Err(13));
 903     /// let r = s.binary_search(&1);
 904     /// assert!(match r { Ok(1...4) => true, _ => false, });
 905     /// ```
 906     #[stable(feature = "rust1", since = "1.0.0")]
 907     pub fn binary_search(&self, x: &T) -> Result<usize, usize>
 908         where T: Ord
 909     {
 910         core_slice::SliceExt::binary_search(self, x)
 911     }
 912
 913     /// Binary search a sorted slice with a comparator function.
 914     ///
 915     /// The comparator function should implement an order consistent
 916     /// with the sort order of the underlying slice, returning an
 917     /// order code that indicates whether its argument is `Less`,
 918     /// `Equal` or `Greater` the desired target.
 919     ///
 920     /// If a matching value is found then returns `Ok`, containing
 921     /// the index for the matched element; if no match is found then
 922     /// `Err` is returned, containing the index where a matching
 923     /// element could be inserted while maintaining sorted order.
 924     ///
 925     /// # Example
 926     ///
 927     /// Looks up a series of four elements. The first is found, with a
 928     /// uniquely determined position; the second and third are not
 929     /// found; the fourth could match any position in `[1,4]`.
 930     ///
 931     /// ```rust
 932     /// let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
 933     ///
 934     /// let seek = 13;
 935     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Ok(9));
 936     /// let seek = 4;
 937     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(7));
 938     /// let seek = 100;
 939     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(13));
 940     /// let seek = 1;
 941     /// let r = s.binary_search_by(|probe| probe.cmp(&seek));
 942     /// assert!(match r { Ok(1...4) => true, _ => false, });
 943     /// ```
 944     #[stable(feature = "rust1", since = "1.0.0")]
 945     #[inline]
 946     pub fn binary_search_by<F>(&self, f: F) -> Result<usize, usize>
 947         where F: FnMut(&T) -> Ordering
 948     {
 949         core_slice::SliceExt::binary_search_by(self, f)
 950     }
 951
 952     /// Binary search a sorted slice with a key extraction function.
 953     ///
 954     /// Assumes that the slice is sorted by the key, for instance with
 955     /// `sort_by_key` using the same key extraction function.
 956     ///
 957     /// If a matching value is found then returns `Ok`, containing the
 958     /// index for the matched element; if no match is found then `Err`
 959     /// is returned, containing the index where a matching element could
 960     /// be inserted while maintaining sorted order.
 961     ///
 962     /// # Examples
 963     ///
 964     /// Looks up a series of four elements in a slice of pairs sorted by
 965     /// their second elements. The first is found, with a uniquely
 966     /// determined position; the second and third are not found; the
 967     /// fourth could match any position in `[1,4]`.
 968     ///
 969     /// ```rust
 970     /// let s = [(0, 0), (2, 1), (4, 1), (5, 1), (3, 1),
 971     ///          (1, 2), (2, 3), (4, 5), (5, 8), (3, 13),
 972     ///          (1, 21), (2, 34), (4, 55)];
 973     ///
 974     /// assert_eq!(s.binary_search_by_key(&13, |&(a,b)| b),  Ok(9));
 975     /// assert_eq!(s.binary_search_by_key(&4, |&(a,b)| b),   Err(7));
 976     /// assert_eq!(s.binary_search_by_key(&100, |&(a,b)| b), Err(13));
 977     /// let r = s.binary_search_by_key(&1, |&(a,b)| b);
 978     /// assert!(match r { Ok(1...4) => true, _ => false, });
 979     /// ```
 980     #[stable(feature = "slice_binary_search_by_key", since = "1.10.0")]
 981     #[inline]
 982     pub fn binary_search_by_key<B, F>(&self, b: &B, f: F) -> Result<usize, usize>
 983         where F: FnMut(&T) -> B,
 984               B: Ord
 985     {
 986         core_slice::SliceExt::binary_search_by_key(self, b, f)
 987     }
 988
 989     /// This is equivalent to `self.sort_by(|a, b| a.cmp(b))`.
 990     ///
 991     /// This sort is stable and `O(n log n)` worst-case but allocates
 992     /// approximately `2 * n` where `n` is the length of `self`.
 993     ///
 994     /// # Examples
 995     ///
 996     /// ```rust
 997     /// let mut v = [-5, 4, 1, -3, 2];
 998     ///
 999     /// v.sort();
1000     /// assert!(v == [-5, -3, 1, 2, 4]);
1001     /// ```
1002     #[stable(feature = "rust1", since = "1.0.0")]
1003     #[inline]
1004     pub fn sort(&mut self)
1005         where T: Ord
1006     {
1007         self.sort_by(|a, b| a.cmp(b))
1008     }
1009
1010     /// Sorts the slice, in place, using `key` to extract a key by which to
1011     /// order the sort by.
1012     ///
1013     /// This sort is stable and `O(n log n)` worst-case but allocates
1014     /// approximately `2 * n`, where `n` is the length of `self`.
1015     ///
1016     /// # Examples
1017     ///
1018     /// ```rust
1019     /// let mut v = [-5i32, 4, 1, -3, 2];
1020     ///
1021     /// v.sort_by_key(|k| k.abs());
1022     /// assert!(v == [1, 2, -3, 4, -5]);
1023     /// ```
1024     #[stable(feature = "slice_sort_by_key", since = "1.7.0")]
1025     #[inline]
1026     pub fn sort_by_key<B, F>(&mut self, mut f: F)
1027         where F: FnMut(&T) -> B, B: Ord
1028     {
1029         self.sort_by(|a, b| f(a).cmp(&f(b)))
1030     }
1031
1032     /// Sorts the slice, in place, using `compare` to compare
1033     /// elements.
1034     ///
1035     /// This sort is stable and `O(n log n)` worst-case but allocates
1036     /// approximately `2 * n`, where `n` is the length of `self`.
1037     ///
1038     /// # Examples
1039     ///
1040     /// ```rust
1041     /// let mut v = [5, 4, 1, 3, 2];
1042     /// v.sort_by(|a, b| a.cmp(b));
1043     /// assert!(v == [1, 2, 3, 4, 5]);
1044     ///
1045     /// // reverse sorting
1046     /// v.sort_by(|a, b| b.cmp(a));
1047     /// assert!(v == [5, 4, 3, 2, 1]);
1048     /// ```
1049     #[stable(feature = "rust1", since = "1.0.0")]
1050     #[inline]
1051     pub fn sort_by<F>(&mut self, compare: F)
1052         where F: FnMut(&T, &T) -> Ordering
1053     {
1054         merge_sort(self, compare)
1055     }
1056
1057     /// Copies the elements from `src` into `self`.
1058     ///
1059     /// The length of `src` must be the same as `self`.
1060     ///
1061     /// # Panics
1062     ///
1063     /// This function will panic if the two slices have different lengths.
1064     ///
1065     /// # Example
1066     ///
1067     /// ```rust
1068     /// let mut dst = [0, 0, 0];
1069     /// let src = [1, 2, 3];
1070     ///
1071     /// dst.clone_from_slice(&src);
1072     /// assert!(dst == [1, 2, 3]);
1073     /// ```
1074     #[stable(feature = "clone_from_slice", since = "1.7.0")]
1075     pub fn clone_from_slice(&mut self, src: &[T]) where T: Clone {
1076         core_slice::SliceExt::clone_from_slice(self, src)
1077     }
1078
1079     /// Copies all elements from `src` into `self`, using a memcpy.
1080     ///
1081     /// The length of `src` must be the same as `self`.
1082     ///
1083     /// # Panics
1084     ///
1085     /// This function will panic if the two slices have different lengths.
1086     ///
1087     /// # Example
1088     ///
1089     /// ```rust
1090     /// let mut dst = [0, 0, 0];
1091     /// let src = [1, 2, 3];
1092     ///
1093     /// dst.copy_from_slice(&src);
1094     /// assert_eq!(src, dst);
1095     /// ```
1096     #[stable(feature = "copy_from_slice", since = "1.9.0")]
1097     pub fn copy_from_slice(&mut self, src: &[T]) where T: Copy {
1098         core_slice::SliceExt::copy_from_slice(self, src)
1099     }
1100
1101
1102     /// Copies `self` into a new `Vec`.
1103     ///
1104     /// # Examples
1105     ///
1106     /// ```
1107     /// let s = [10, 40, 30];
1108     /// let x = s.to_vec();
1109     /// // Here, `s` and `x` can be modified independently.
1110     /// ```
1111     #[stable(feature = "rust1", since = "1.0.0")]
1112     #[inline]
1113     pub fn to_vec(&self) -> Vec<T>
1114         where T: Clone
1115     {
1116         // NB see hack module in this file
1117         hack::to_vec(self)
1118     }
1119
1120     /// Converts `self` into a vector without clones or allocation.
1121     ///
1122     /// # Examples
1123     ///
1124     /// ```
1125     /// let s: Box<[i32]> = Box::new([10, 40, 30]);
1126     /// let x = s.into_vec();
1127     /// // `s` cannot be used anymore because it has been converted into `x`.
1128     ///
1129     /// assert_eq!(x, vec!(10, 40, 30));
1130     /// ```
1131     #[stable(feature = "rust1", since = "1.0.0")]
1132     #[inline]
1133     pub fn into_vec(self: Box<Self>) -> Vec<T> {
1134         // NB see hack module in this file
1135         hack::into_vec(self)
1136     }
1137 }
1138
1139 ////////////////////////////////////////////////////////////////////////////////
1140 // Extension traits for slices over specific kinds of data
1141 ////////////////////////////////////////////////////////////////////////////////
1142 #[unstable(feature = "slice_concat_ext",
1143            reason = "trait should not have to exist",
1144            issue = "27747")]
1145 /// An extension trait for concatenating slices
1146 pub trait SliceConcatExt<T: ?Sized> {
1147     #[unstable(feature = "slice_concat_ext",
1148                reason = "trait should not have to exist",
1149                issue = "27747")]
1150     /// The resulting type after concatenation
1151     type Output;
1152
1153     /// Flattens a slice of `T` into a single value `Self::Output`.
1154     ///
1155     /// # Examples
1156     ///
1157     /// ```
1158     /// assert_eq!(["hello", "world"].concat(), "helloworld");
1159     /// ```
1160     #[stable(feature = "rust1", since = "1.0.0")]
1161     fn concat(&self) -> Self::Output;
1162
1163     /// Flattens a slice of `T` into a single value `Self::Output`, placing a
1164     /// given separator between each.
1165     ///
1166     /// # Examples
1167     ///
1168     /// ```
1169     /// assert_eq!(["hello", "world"].join(" "), "hello world");
1170     /// ```
1171     #[stable(feature = "rename_connect_to_join", since = "1.3.0")]
1172     fn join(&self, sep: &T) -> Self::Output;
1173
1174     #[stable(feature = "rust1", since = "1.0.0")]
1175     #[rustc_deprecated(since = "1.3.0", reason = "renamed to join")]
1176     fn connect(&self, sep: &T) -> Self::Output;
1177 }
1178
1179 #[unstable(feature = "slice_concat_ext",
1180            reason = "trait should not have to exist",
1181            issue = "27747")]
1182 impl<T: Clone, V: Borrow<[T]>> SliceConcatExt<T> for [V] {
1183     type Output = Vec<T>;
1184
1185     fn concat(&self) -> Vec<T> {
1186         let size = self.iter().fold(0, |acc, v| acc + v.borrow().len());
1187         let mut result = Vec::with_capacity(size);
1188         for v in self {
1189             result.extend_from_slice(v.borrow())
1190         }
1191         result
1192     }
1193
1194     fn join(&self, sep: &T) -> Vec<T> {
1195         let size = self.iter().fold(0, |acc, v| acc + v.borrow().len());
1196         let mut result = Vec::with_capacity(size + self.len());
1197         let mut first = true;
1198         for v in self {
1199             if first {
1200                 first = false
1201             } else {
1202                 result.push(sep.clone())
1203             }
1204             result.extend_from_slice(v.borrow())
1205         }
1206         result
1207     }
1208
1209     fn connect(&self, sep: &T) -> Vec<T> {
1210         self.join(sep)
1211     }
1212 }
1213
1214 ////////////////////////////////////////////////////////////////////////////////
1215 // Standard trait implementations for slices
1216 ////////////////////////////////////////////////////////////////////////////////
1217
1218 #[stable(feature = "rust1", since = "1.0.0")]
1219 impl<T> Borrow<[T]> for Vec<T> {
1220     fn borrow(&self) -> &[T] {
1221         &self[..]
1222     }
1223 }
1224
1225 #[stable(feature = "rust1", since = "1.0.0")]
1226 impl<T> BorrowMut<[T]> for Vec<T> {
1227     fn borrow_mut(&mut self) -> &mut [T] {
1228         &mut self[..]
1229     }
1230 }
1231
1232 #[stable(feature = "rust1", since = "1.0.0")]
1233 impl<T: Clone> ToOwned for [T] {
1234     type Owned = Vec<T>;
1235     #[cfg(not(test))]
1236     fn to_owned(&self) -> Vec<T> {
1237         self.to_vec()
1238     }
1239
1240     // HACK(japaric): with cfg(test) the inherent `[T]::to_vec`, which is required for this method
1241     // definition, is not available. Since we don't require this method for testing purposes, I'll
1242     // just stub it
1243     // NB see the slice::hack module in slice.rs for more information
1244     #[cfg(test)]
1245     fn to_owned(&self) -> Vec<T> {
1246         panic!("not available with cfg(test)")
1247     }
1248 }
1249
1250 ////////////////////////////////////////////////////////////////////////////////
1251 // Sorting
1252 ////////////////////////////////////////////////////////////////////////////////
1253
1254 fn insertion_sort<T, F>(v: &mut [T], mut compare: F)
1255     where F: FnMut(&T, &T) -> Ordering
1256 {
1257     let len = v.len() as isize;
1258     let buf_v = v.as_mut_ptr();
1259
1260     // 1 <= i < len;
1261     for i in 1..len {
1262         // j satisfies: 0 <= j <= i;
1263         let mut j = i;
1264         unsafe {
1265             // `i` is in bounds.
1266             let read_ptr = buf_v.offset(i) as *const T;
1267
1268             // find where to insert, we need to do strict <,
1269             // rather than <=, to maintain stability.
1270
1271             // 0 <= j - 1 < len, so .offset(j - 1) is in bounds.
1272             while j > 0 && compare(&*read_ptr, &*buf_v.offset(j - 1)) == Less {
1273                 j -= 1;
1274             }
1275
1276             // shift everything to the right, to make space to
1277             // insert this value.
1278
1279             // j + 1 could be `len` (for the last `i`), but in
1280             // that case, `i == j` so we don't copy. The
1281             // `.offset(j)` is always in bounds.
1282
1283             if i != j {
1284                 let tmp = ptr::read(read_ptr);
1285                 ptr::copy(&*buf_v.offset(j), buf_v.offset(j + 1), (i - j) as usize);
1286                 ptr::copy_nonoverlapping(&tmp, buf_v.offset(j), 1);
1287                 mem::forget(tmp);
1288             }
1289         }
1290     }
1291 }
1292
1293 fn merge_sort<T, F>(v: &mut [T], mut compare: F)
1294     where F: FnMut(&T, &T) -> Ordering
1295 {
1296     // warning: this wildly uses unsafe.
1297     const BASE_INSERTION: usize = 32;
1298     const LARGE_INSERTION: usize = 16;
1299
1300     // FIXME #12092: smaller insertion runs seems to make sorting
1301     // vectors of large elements a little faster on some platforms,
1302     // but hasn't been tested/tuned extensively
1303     let insertion = if size_of::<T>() <= 16 {
1304         BASE_INSERTION
1305     } else {
1306         LARGE_INSERTION
1307     };
1308
1309     let len = v.len();
1310
1311     // short vectors get sorted in-place via insertion sort to avoid allocations
1312     if len <= insertion {
1313         insertion_sort(v, compare);
1314         return;
1315     }
1316
1317     // allocate some memory to use as scratch memory, we keep the
1318     // length 0 so we can keep shallow copies of the contents of `v`
1319     // without risking the dtors running on an object twice if
1320     // `compare` panics.
1321     let mut working_space = Vec::with_capacity(2 * len);
1322     // these both are buffers of length `len`.
1323     let mut buf_dat = working_space.as_mut_ptr();
1324     let mut buf_tmp = unsafe { buf_dat.offset(len as isize) };
1325
1326     // length `len`.
1327     let buf_v = v.as_ptr();
1328
1329     // step 1. sort short runs with insertion sort. This takes the
1330     // values from `v` and sorts them into `buf_dat`, leaving that
1331     // with sorted runs of length INSERTION.
1332
1333     // We could hardcode the sorting comparisons here, and we could
1334     // manipulate/step the pointers themselves, rather than repeatedly
1335     // .offset-ing.
1336     for start in (0..len).step_by(insertion) {
1337         // start <= i < len;
1338         for i in start..cmp::min(start + insertion, len) {
1339             // j satisfies: start <= j <= i;
1340             let mut j = i as isize;
1341             unsafe {
1342                 // `i` is in bounds.
1343                 let read_ptr = buf_v.offset(i as isize);
1344
1345                 // find where to insert, we need to do strict <,
1346                 // rather than <=, to maintain stability.
1347
1348                 // start <= j - 1 < len, so .offset(j - 1) is in
1349                 // bounds.
1350                 while j > start as isize && compare(&*read_ptr, &*buf_dat.offset(j - 1)) == Less {
1351                     j -= 1;
1352                 }
1353
1354                 // shift everything to the right, to make space to
1355                 // insert this value.
1356
1357                 // j + 1 could be `len` (for the last `i`), but in
1358                 // that case, `i == j` so we don't copy. The
1359                 // `.offset(j)` is always in bounds.
1360                 ptr::copy(&*buf_dat.offset(j), buf_dat.offset(j + 1), i - j as usize);
1361                 ptr::copy_nonoverlapping(read_ptr, buf_dat.offset(j), 1);
1362             }
1363         }
1364     }
1365
1366     // step 2. merge the sorted runs.
1367     let mut width = insertion;
1368     while width < len {
1369         // merge the sorted runs of length `width` in `buf_dat` two at
1370         // a time, placing the result in `buf_tmp`.
1371
1372         // 0 <= start <= len.
1373         for start in (0..len).step_by(2 * width) {
1374             // manipulate pointers directly for speed (rather than
1375             // using a `for` loop with `range` and `.offset` inside
1376             // that loop).
1377             unsafe {
1378                 // the end of the first run & start of the
1379                 // second. Offset of `len` is defined, since this is
1380                 // precisely one byte past the end of the object.
1381                 let right_start = buf_dat.offset(cmp::min(start + width, len) as isize);
1382                 // end of the second. Similar reasoning to the above re safety.
1383                 let right_end_idx = cmp::min(start + 2 * width, len);
1384                 let right_end = buf_dat.offset(right_end_idx as isize);
1385
1386                 // the pointers to the elements under consideration
1387                 // from the two runs.
1388
1389                 // both of these are in bounds.
1390                 let mut left = buf_dat.offset(start as isize);
1391                 let mut right = right_start;
1392
1393                 // where we're putting the results, it is a run of
1394                 // length `2*width`, so we step it once for each step
1395                 // of either `left` or `right`.  `buf_tmp` has length
1396                 // `len`, so these are in bounds.
1397                 let mut out = buf_tmp.offset(start as isize);
1398                 let out_end = buf_tmp.offset(right_end_idx as isize);
1399
1400                 // If left[last] <= right[0], they are already in order:
1401                 // fast-forward the left side (the right side is handled
1402                 // in the loop).
1403                 // If `right` is not empty then left is not empty, and
1404                 // the offsets are in bounds.
1405                 if right != right_end && compare(&*right.offset(-1), &*right) != Greater {
1406                     let elems = (right_start as usize - left as usize) / mem::size_of::<T>();
1407                     ptr::copy_nonoverlapping(&*left, out, elems);
1408                     out = out.offset(elems as isize);
1409                     left = right_start;
1410                 }
1411
1412                 while out < out_end {
1413                     // Either the left or the right run are exhausted,
1414                     // so just copy the remainder from the other run
1415                     // and move on; this gives a huge speed-up (order
1416                     // of 25%) for mostly sorted vectors (the best
1417                     // case).
1418                     if left == right_start {
1419                         // the number remaining in this run.
1420                         let elems = (right_end as usize - right as usize) / mem::size_of::<T>();
1421                         ptr::copy_nonoverlapping(&*right, out, elems);
1422                         break;
1423                     } else if right == right_end {
1424                         let elems = (right_start as usize - left as usize) / mem::size_of::<T>();
1425                         ptr::copy_nonoverlapping(&*left, out, elems);
1426                         break;
1427                     }
1428
1429                     // check which side is smaller, and that's the
1430                     // next element for the new run.
1431
1432                     // `left < right_start` and `right < right_end`,
1433                     // so these are valid.
1434                     let to_copy = if compare(&*left, &*right) == Greater {
1435                         step(&mut right)
1436                     } else {
1437                         step(&mut left)
1438                     };
1439                     ptr::copy_nonoverlapping(&*to_copy, out, 1);
1440                     step(&mut out);
1441                 }
1442             }
1443         }
1444
1445         mem::swap(&mut buf_dat, &mut buf_tmp);
1446
1447         width *= 2;
1448     }
1449
1450     // write the result to `v` in one go, so that there are never two copies
1451     // of the same object in `v`.
1452     unsafe {
1453         ptr::copy_nonoverlapping(&*buf_dat, v.as_mut_ptr(), len);
1454     }
1455
1456     // increment the pointer, returning the old pointer.
1457     #[inline(always)]
1458     unsafe fn step<T>(ptr: &mut *mut T) -> *mut T {
1459         let old = *ptr;
1460         *ptr = ptr.offset(1);
1461         old
1462     }
1463 }