src/libcore/slice/mod.rs

   1 // Copyright 2012-2017 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 //! Slice management and manipulation
  12 //!
  13 //! For more details see [`std::slice`].
  14 //!
  15 //! [`std::slice`]: ../../std/slice/index.html
  16
  17 #![stable(feature = "rust1", since = "1.0.0")]
  18
  19 // How this module is organized.
  20 //
  21 // The library infrastructure for slices is fairly messy. There's
  22 // a lot of stuff defined here. Let's keep it clean.
  23 //
  24 // The layout of this file is thus:
  25 //
  26 // * Inherent methods. This is where most of the slice API resides.
  27 // * Implementations of a few common traits with important slice ops.
  28 // * Definitions of a bunch of iterators.
  29 // * Free functions.
  30 // * The `raw` and `bytes` submodules.
  31 // * Boilerplate trait implementations.
  32
  33 use cmp::Ordering::{self, Less, Equal, Greater};
  34 use cmp;
  35 use fmt;
  36 use intrinsics::assume;
  37 use iter::*;
  38 use ops::{FnMut, Try, self};
  39 use option::Option;
  40 use option::Option::{None, Some};
  41 use result::Result;
  42 use result::Result::{Ok, Err};
  43 use ptr;
  44 use mem;
  45 use marker::{Copy, Send, Sync, Sized, self};
  46 use iter_private::TrustedRandomAccess;
  47
  48 #[unstable(feature = "slice_internals", issue = "0",
  49            reason = "exposed from core to be reused in std; use the memchr crate")]
  50 /// Pure rust memchr implementation, taken from rust-memchr
  51 pub mod memchr;
  52
  53 mod rotate;
  54 mod sort;
  55
  56 #[repr(C)]
  57 union Repr<'a, T: 'a> {
  58     rust: &'a [T],
  59     rust_mut: &'a mut [T],
  60     raw: FatPtr<T>,
  61 }
  62
  63 #[repr(C)]
  64 struct FatPtr<T> {
  65     data: *const T,
  66     len: usize,
  67 }
  68
  69 //
  70 // Extension traits
  71 //
  72
  73 #[lang = "slice"]
  74 #[cfg(not(test))]
  75 impl<T> [T] {
  76     /// Returns the number of elements in the slice.
  77     ///
  78     /// # Examples
  79     ///
  80     /// ```
  81     /// let a = [1, 2, 3];
  82     /// assert_eq!(a.len(), 3);
  83     /// ```
  84     #[stable(feature = "rust1", since = "1.0.0")]
  85     #[inline]
  86     #[rustc_const_unstable(feature = "const_slice_len")]
  87     pub const fn len(&self) -> usize {
  88         unsafe {
  89             Repr { rust: self }.raw.len
  90         }
  91     }
  92
  93     /// Returns `true` if the slice has a length of 0.
  94     ///
  95     /// # Examples
  96     ///
  97     /// ```
  98     /// let a = [1, 2, 3];
  99     /// assert!(!a.is_empty());
 100     /// ```
 101     #[stable(feature = "rust1", since = "1.0.0")]
 102     #[inline]
 103     #[rustc_const_unstable(feature = "const_slice_len")]
 104     pub const fn is_empty(&self) -> bool {
 105         self.len() == 0
 106     }
 107
 108     /// Returns the first element of the slice, or `None` if it is empty.
 109     ///
 110     /// # Examples
 111     ///
 112     /// ```
 113     /// let v = [10, 40, 30];
 114     /// assert_eq!(Some(&10), v.first());
 115     ///
 116     /// let w: &[i32] = &[];
 117     /// assert_eq!(None, w.first());
 118     /// ```
 119     #[stable(feature = "rust1", since = "1.0.0")]
 120     #[inline]
 121     pub fn first(&self) -> Option<&T> {
 122         self.get(0)
 123     }
 124
 125     /// Returns a mutable pointer to the first element of the slice, or `None` if it is empty.
 126     ///
 127     /// # Examples
 128     ///
 129     /// ```
 130     /// let x = &mut [0, 1, 2];
 131     ///
 132     /// if let Some(first) = x.first_mut() {
 133     ///     *first = 5;
 134     /// }
 135     /// assert_eq!(x, &[5, 1, 2]);
 136     /// ```
 137     #[stable(feature = "rust1", since = "1.0.0")]
 138     #[inline]
 139     pub fn first_mut(&mut self) -> Option<&mut T> {
 140         self.get_mut(0)
 141     }
 142
 143     /// Returns the first and all the rest of the elements of the slice, or `None` if it is empty.
 144     ///
 145     /// # Examples
 146     ///
 147     /// ```
 148     /// let x = &[0, 1, 2];
 149     ///
 150     /// if let Some((first, elements)) = x.split_first() {
 151     ///     assert_eq!(first, &0);
 152     ///     assert_eq!(elements, &[1, 2]);
 153     /// }
 154     /// ```
 155     #[stable(feature = "slice_splits", since = "1.5.0")]
 156     #[inline]
 157     pub fn split_first(&self) -> Option<(&T, &[T])> {
 158         if self.is_empty() { None } else { Some((&self[0], &self[1..])) }
 159     }
 160
 161     /// Returns the first and all the rest of the elements of the slice, or `None` if it is empty.
 162     ///
 163     /// # Examples
 164     ///
 165     /// ```
 166     /// let x = &mut [0, 1, 2];
 167     ///
 168     /// if let Some((first, elements)) = x.split_first_mut() {
 169     ///     *first = 3;
 170     ///     elements[0] = 4;
 171     ///     elements[1] = 5;
 172     /// }
 173     /// assert_eq!(x, &[3, 4, 5]);
 174     /// ```
 175     #[stable(feature = "slice_splits", since = "1.5.0")]
 176     #[inline]
 177     pub fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])> {
 178         if self.is_empty() { None } else {
 179             let split = self.split_at_mut(1);
 180             Some((&mut split.0[0], split.1))
 181         }
 182     }
 183
 184     /// Returns the last and all the rest of the elements of the slice, or `None` if it is empty.
 185     ///
 186     /// # Examples
 187     ///
 188     /// ```
 189     /// let x = &[0, 1, 2];
 190     ///
 191     /// if let Some((last, elements)) = x.split_last() {
 192     ///     assert_eq!(last, &2);
 193     ///     assert_eq!(elements, &[0, 1]);
 194     /// }
 195     /// ```
 196     #[stable(feature = "slice_splits", since = "1.5.0")]
 197     #[inline]
 198     pub fn split_last(&self) -> Option<(&T, &[T])> {
 199         let len = self.len();
 200         if len == 0 { None } else { Some((&self[len - 1], &self[..(len - 1)])) }
 201     }
 202
 203     /// Returns the last and all the rest of the elements of the slice, or `None` if it is empty.
 204     ///
 205     /// # Examples
 206     ///
 207     /// ```
 208     /// let x = &mut [0, 1, 2];
 209     ///
 210     /// if let Some((last, elements)) = x.split_last_mut() {
 211     ///     *last = 3;
 212     ///     elements[0] = 4;
 213     ///     elements[1] = 5;
 214     /// }
 215     /// assert_eq!(x, &[4, 5, 3]);
 216     /// ```
 217     #[stable(feature = "slice_splits", since = "1.5.0")]
 218     #[inline]
 219     pub fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])> {
 220         let len = self.len();
 221         if len == 0 { None } else {
 222             let split = self.split_at_mut(len - 1);
 223             Some((&mut split.1[0], split.0))
 224         }
 225
 226     }
 227
 228     /// Returns the last element of the slice, or `None` if it is empty.
 229     ///
 230     /// # Examples
 231     ///
 232     /// ```
 233     /// let v = [10, 40, 30];
 234     /// assert_eq!(Some(&30), v.last());
 235     ///
 236     /// let w: &[i32] = &[];
 237     /// assert_eq!(None, w.last());
 238     /// ```
 239     #[stable(feature = "rust1", since = "1.0.0")]
 240     #[inline]
 241     pub fn last(&self) -> Option<&T> {
 242         let last_idx = self.len().checked_sub(1)?;
 243         self.get(last_idx)
 244     }
 245
 246     /// Returns a mutable pointer to the last item in the slice.
 247     ///
 248     /// # Examples
 249     ///
 250     /// ```
 251     /// let x = &mut [0, 1, 2];
 252     ///
 253     /// if let Some(last) = x.last_mut() {
 254     ///     *last = 10;
 255     /// }
 256     /// assert_eq!(x, &[0, 1, 10]);
 257     /// ```
 258     #[stable(feature = "rust1", since = "1.0.0")]
 259     #[inline]
 260     pub fn last_mut(&mut self) -> Option<&mut T> {
 261         let last_idx = self.len().checked_sub(1)?;
 262         self.get_mut(last_idx)
 263     }
 264
 265     /// Returns a reference to an element or subslice depending on the type of
 266     /// index.
 267     ///
 268     /// - If given a position, returns a reference to the element at that
 269     ///   position or `None` if out of bounds.
 270     /// - If given a range, returns the subslice corresponding to that range,
 271     ///   or `None` if out of bounds.
 272     ///
 273     /// # Examples
 274     ///
 275     /// ```
 276     /// let v = [10, 40, 30];
 277     /// assert_eq!(Some(&40), v.get(1));
 278     /// assert_eq!(Some(&[10, 40][..]), v.get(0..2));
 279     /// assert_eq!(None, v.get(3));
 280     /// assert_eq!(None, v.get(0..4));
 281     /// ```
 282     #[stable(feature = "rust1", since = "1.0.0")]
 283     #[inline]
 284     pub fn get<I>(&self, index: I) -> Option<&I::Output>
 285         where I: SliceIndex<Self>
 286     {
 287         index.get(self)
 288     }
 289
 290     /// Returns a mutable reference to an element or subslice depending on the
 291     /// type of index (see [`get`]) or `None` if the index is out of bounds.
 292     ///
 293     /// [`get`]: #method.get
 294     ///
 295     /// # Examples
 296     ///
 297     /// ```
 298     /// let x = &mut [0, 1, 2];
 299     ///
 300     /// if let Some(elem) = x.get_mut(1) {
 301     ///     *elem = 42;
 302     /// }
 303     /// assert_eq!(x, &[0, 42, 2]);
 304     /// ```
 305     #[stable(feature = "rust1", since = "1.0.0")]
 306     #[inline]
 307     pub fn get_mut<I>(&mut self, index: I) -> Option<&mut I::Output>
 308         where I: SliceIndex<Self>
 309     {
 310         index.get_mut(self)
 311     }
 312
 313     /// Returns a reference to an element or subslice, without doing bounds
 314     /// checking.
 315     ///
 316     /// This is generally not recommended, use with caution! For a safe
 317     /// alternative see [`get`].
 318     ///
 319     /// [`get`]: #method.get
 320     ///
 321     /// # Examples
 322     ///
 323     /// ```
 324     /// let x = &[1, 2, 4];
 325     ///
 326     /// unsafe {
 327     ///     assert_eq!(x.get_unchecked(1), &2);
 328     /// }
 329     /// ```
 330     #[stable(feature = "rust1", since = "1.0.0")]
 331     #[inline]
 332     pub unsafe fn get_unchecked<I>(&self, index: I) -> &I::Output
 333         where I: SliceIndex<Self>
 334     {
 335         index.get_unchecked(self)
 336     }
 337
 338     /// Returns a mutable reference to an element or subslice, without doing
 339     /// bounds checking.
 340     ///
 341     /// This is generally not recommended, use with caution! For a safe
 342     /// alternative see [`get_mut`].
 343     ///
 344     /// [`get_mut`]: #method.get_mut
 345     ///
 346     /// # Examples
 347     ///
 348     /// ```
 349     /// let x = &mut [1, 2, 4];
 350     ///
 351     /// unsafe {
 352     ///     let elem = x.get_unchecked_mut(1);
 353     ///     *elem = 13;
 354     /// }
 355     /// assert_eq!(x, &[1, 13, 4]);
 356     /// ```
 357     #[stable(feature = "rust1", since = "1.0.0")]
 358     #[inline]
 359     pub unsafe fn get_unchecked_mut<I>(&mut self, index: I) -> &mut I::Output
 360         where I: SliceIndex<Self>
 361     {
 362         index.get_unchecked_mut(self)
 363     }
 364
 365     /// Returns a raw pointer to the slice's buffer.
 366     ///
 367     /// The caller must ensure that the slice outlives the pointer this
 368     /// function returns, or else it will end up pointing to garbage.
 369     ///
 370     /// Modifying the container referenced by this slice may cause its buffer
 371     /// to be reallocated, which would also make any pointers to it invalid.
 372     ///
 373     /// # Examples
 374     ///
 375     /// ```
 376     /// let x = &[1, 2, 4];
 377     /// let x_ptr = x.as_ptr();
 378     ///
 379     /// unsafe {
 380     ///     for i in 0..x.len() {
 381     ///         assert_eq!(x.get_unchecked(i), &*x_ptr.add(i));
 382     ///     }
 383     /// }
 384     /// ```
 385     #[stable(feature = "rust1", since = "1.0.0")]
 386     #[inline]
 387     #[rustc_const_unstable(feature = "const_slice_as_ptr")]
 388     pub const fn as_ptr(&self) -> *const T {
 389         self as *const [T] as *const T
 390     }
 391
 392     /// Returns an unsafe mutable pointer to the slice's buffer.
 393     ///
 394     /// The caller must ensure that the slice outlives the pointer this
 395     /// function returns, or else it will end up pointing to garbage.
 396     ///
 397     /// Modifying the container referenced by this slice may cause its buffer
 398     /// to be reallocated, which would also make any pointers to it invalid.
 399     ///
 400     /// # Examples
 401     ///
 402     /// ```
 403     /// let x = &mut [1, 2, 4];
 404     /// let x_ptr = x.as_mut_ptr();
 405     ///
 406     /// unsafe {
 407     ///     for i in 0..x.len() {
 408     ///         *x_ptr.add(i) += 2;
 409     ///     }
 410     /// }
 411     /// assert_eq!(x, &[3, 4, 6]);
 412     /// ```
 413     #[stable(feature = "rust1", since = "1.0.0")]
 414     #[inline]
 415     pub fn as_mut_ptr(&mut self) -> *mut T {
 416         self as *mut [T] as *mut T
 417     }
 418
 419     /// Swaps two elements in the slice.
 420     ///
 421     /// # Arguments
 422     ///
 423     /// * a - The index of the first element
 424     /// * b - The index of the second element
 425     ///
 426     /// # Panics
 427     ///
 428     /// Panics if `a` or `b` are out of bounds.
 429     ///
 430     /// # Examples
 431     ///
 432     /// ```
 433     /// let mut v = ["a", "b", "c", "d"];
 434     /// v.swap(1, 3);
 435     /// assert!(v == ["a", "d", "c", "b"]);
 436     /// ```
 437     #[stable(feature = "rust1", since = "1.0.0")]
 438     #[inline]
 439     pub fn swap(&mut self, a: usize, b: usize) {
 440         unsafe {
 441             // Can't take two mutable loans from one vector, so instead just cast
 442             // them to their raw pointers to do the swap
 443             let pa: *mut T = &mut self[a];
 444             let pb: *mut T = &mut self[b];
 445             ptr::swap(pa, pb);
 446         }
 447     }
 448
 449     /// Reverses the order of elements in the slice, in place.
 450     ///
 451     /// # Examples
 452     ///
 453     /// ```
 454     /// let mut v = [1, 2, 3];
 455     /// v.reverse();
 456     /// assert!(v == [3, 2, 1]);
 457     /// ```
 458     #[stable(feature = "rust1", since = "1.0.0")]
 459     #[inline]
 460     pub fn reverse(&mut self) {
 461         let mut i: usize = 0;
 462         let ln = self.len();
 463
 464         // For very small types, all the individual reads in the normal
 465         // path perform poorly.  We can do better, given efficient unaligned
 466         // load/store, by loading a larger chunk and reversing a register.
 467
 468         // Ideally LLVM would do this for us, as it knows better than we do
 469         // whether unaligned reads are efficient (since that changes between
 470         // different ARM versions, for example) and what the best chunk size
 471         // would be.  Unfortunately, as of LLVM 4.0 (2017-05) it only unrolls
 472         // the loop, so we need to do this ourselves.  (Hypothesis: reverse
 473         // is troublesome because the sides can be aligned differently --
 474         // will be, when the length is odd -- so there's no way of emitting
 475         // pre- and postludes to use fully-aligned SIMD in the middle.)
 476
 477         let fast_unaligned =
 478             cfg!(any(target_arch = "x86", target_arch = "x86_64"));
 479
 480         if fast_unaligned && mem::size_of::<T>() == 1 {
 481             // Use the llvm.bswap intrinsic to reverse u8s in a usize
 482             let chunk = mem::size_of::<usize>();
 483             while i + chunk - 1 < ln / 2 {
 484                 unsafe {
 485                     let pa: *mut T = self.get_unchecked_mut(i);
 486                     let pb: *mut T = self.get_unchecked_mut(ln - i - chunk);
 487                     let va = ptr::read_unaligned(pa as *mut usize);
 488                     let vb = ptr::read_unaligned(pb as *mut usize);
 489                     ptr::write_unaligned(pa as *mut usize, vb.swap_bytes());
 490                     ptr::write_unaligned(pb as *mut usize, va.swap_bytes());
 491                 }
 492                 i += chunk;
 493             }
 494         }
 495
 496         if fast_unaligned && mem::size_of::<T>() == 2 {
 497             // Use rotate-by-16 to reverse u16s in a u32
 498             let chunk = mem::size_of::<u32>() / 2;
 499             while i + chunk - 1 < ln / 2 {
 500                 unsafe {
 501                     let pa: *mut T = self.get_unchecked_mut(i);
 502                     let pb: *mut T = self.get_unchecked_mut(ln - i - chunk);
 503                     let va = ptr::read_unaligned(pa as *mut u32);
 504                     let vb = ptr::read_unaligned(pb as *mut u32);
 505                     ptr::write_unaligned(pa as *mut u32, vb.rotate_left(16));
 506                     ptr::write_unaligned(pb as *mut u32, va.rotate_left(16));
 507                 }
 508                 i += chunk;
 509             }
 510         }
 511
 512         while i < ln / 2 {
 513             // Unsafe swap to avoid the bounds check in safe swap.
 514             unsafe {
 515                 let pa: *mut T = self.get_unchecked_mut(i);
 516                 let pb: *mut T = self.get_unchecked_mut(ln - i - 1);
 517                 ptr::swap(pa, pb);
 518             }
 519             i += 1;
 520         }
 521     }
 522
 523     /// Returns an iterator over the slice.
 524     ///
 525     /// # Examples
 526     ///
 527     /// ```
 528     /// let x = &[1, 2, 4];
 529     /// let mut iterator = x.iter();
 530     ///
 531     /// assert_eq!(iterator.next(), Some(&1));
 532     /// assert_eq!(iterator.next(), Some(&2));
 533     /// assert_eq!(iterator.next(), Some(&4));
 534     /// assert_eq!(iterator.next(), None);
 535     /// ```
 536     #[stable(feature = "rust1", since = "1.0.0")]
 537     #[inline]
 538     pub fn iter(&self) -> Iter<T> {
 539         unsafe {
 540             let ptr = self.as_ptr();
 541             assume(!ptr.is_null());
 542
 543             let end = if mem::size_of::<T>() == 0 {
 544                 (ptr as *const u8).wrapping_add(self.len()) as *const T
 545             } else {
 546                 ptr.add(self.len())
 547             };
 548
 549             Iter {
 550                 ptr,
 551                 end,
 552                 _marker: marker::PhantomData
 553             }
 554         }
 555     }
 556
 557     /// Returns an iterator that allows modifying each value.
 558     ///
 559     /// # Examples
 560     ///
 561     /// ```
 562     /// let x = &mut [1, 2, 4];
 563     /// for elem in x.iter_mut() {
 564     ///     *elem += 2;
 565     /// }
 566     /// assert_eq!(x, &[3, 4, 6]);
 567     /// ```
 568     #[stable(feature = "rust1", since = "1.0.0")]
 569     #[inline]
 570     pub fn iter_mut(&mut self) -> IterMut<T> {
 571         unsafe {
 572             let ptr = self.as_mut_ptr();
 573             assume(!ptr.is_null());
 574
 575             let end = if mem::size_of::<T>() == 0 {
 576                 (ptr as *mut u8).wrapping_add(self.len()) as *mut T
 577             } else {
 578                 ptr.add(self.len())
 579             };
 580
 581             IterMut {
 582                 ptr,
 583                 end,
 584                 _marker: marker::PhantomData
 585             }
 586         }
 587     }
 588
 589     /// Returns an iterator over all contiguous windows of length
 590     /// `size`. The windows overlap. If the slice is shorter than
 591     /// `size`, the iterator returns no values.
 592     ///
 593     /// # Panics
 594     ///
 595     /// Panics if `size` is 0.
 596     ///
 597     /// # Examples
 598     ///
 599     /// ```
 600     /// let slice = ['r', 'u', 's', 't'];
 601     /// let mut iter = slice.windows(2);
 602     /// assert_eq!(iter.next().unwrap(), &['r', 'u']);
 603     /// assert_eq!(iter.next().unwrap(), &['u', 's']);
 604     /// assert_eq!(iter.next().unwrap(), &['s', 't']);
 605     /// assert!(iter.next().is_none());
 606     /// ```
 607     ///
 608     /// If the slice is shorter than `size`:
 609     ///
 610     /// ```
 611     /// let slice = ['f', 'o', 'o'];
 612     /// let mut iter = slice.windows(4);
 613     /// assert!(iter.next().is_none());
 614     /// ```
 615     #[stable(feature = "rust1", since = "1.0.0")]
 616     #[inline]
 617     pub fn windows(&self, size: usize) -> Windows<T> {
 618         assert!(size != 0);
 619         Windows { v: self, size }
 620     }
 621
 622     /// Returns an iterator over `chunk_size` elements of the slice at a
 623     /// time. The chunks are slices and do not overlap. If `chunk_size` does
 624     /// not divide the length of the slice, then the last chunk will
 625     /// not have length `chunk_size`.
 626     ///
 627     /// See [`exact_chunks`] for a variant of this iterator that returns chunks
 628     /// of always exactly `chunk_size` elements.
 629     ///
 630     /// # Panics
 631     ///
 632     /// Panics if `chunk_size` is 0.
 633     ///
 634     /// # Examples
 635     ///
 636     /// ```
 637     /// let slice = ['l', 'o', 'r', 'e', 'm'];
 638     /// let mut iter = slice.chunks(2);
 639     /// assert_eq!(iter.next().unwrap(), &['l', 'o']);
 640     /// assert_eq!(iter.next().unwrap(), &['r', 'e']);
 641     /// assert_eq!(iter.next().unwrap(), &['m']);
 642     /// assert!(iter.next().is_none());
 643     /// ```
 644     ///
 645     /// [`exact_chunks`]: #method.exact_chunks
 646     #[stable(feature = "rust1", since = "1.0.0")]
 647     #[inline]
 648     pub fn chunks(&self, chunk_size: usize) -> Chunks<T> {
 649         assert!(chunk_size != 0);
 650         Chunks { v: self, chunk_size }
 651     }
 652
 653     /// Returns an iterator over `chunk_size` elements of the slice at a time.
 654     /// The chunks are mutable slices, and do not overlap. If `chunk_size` does
 655     /// not divide the length of the slice, then the last chunk will not
 656     /// have length `chunk_size`.
 657     ///
 658     /// See [`exact_chunks_mut`] for a variant of this iterator that returns chunks
 659     /// of always exactly `chunk_size` elements.
 660     ///
 661     /// # Panics
 662     ///
 663     /// Panics if `chunk_size` is 0.
 664     ///
 665     /// # Examples
 666     ///
 667     /// ```
 668     /// let v = &mut [0, 0, 0, 0, 0];
 669     /// let mut count = 1;
 670     ///
 671     /// for chunk in v.chunks_mut(2) {
 672     ///     for elem in chunk.iter_mut() {
 673     ///         *elem += count;
 674     ///     }
 675     ///     count += 1;
 676     /// }
 677     /// assert_eq!(v, &[1, 1, 2, 2, 3]);
 678     /// ```
 679     ///
 680     /// [`exact_chunks_mut`]: #method.exact_chunks_mut
 681     #[stable(feature = "rust1", since = "1.0.0")]
 682     #[inline]
 683     pub fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<T> {
 684         assert!(chunk_size != 0);
 685         ChunksMut { v: self, chunk_size }
 686     }
 687
 688     /// Returns an iterator over `chunk_size` elements of the slice at a
 689     /// time. The chunks are slices and do not overlap. If `chunk_size` does
 690     /// not divide the length of the slice, then the last up to `chunk_size-1`
 691     /// elements will be omitted and can be retrieved from the `remainder`
 692     /// function of the iterator.
 693     ///
 694     /// Due to each chunk having exactly `chunk_size` elements, the compiler
 695     /// can often optimize the resulting code better than in the case of
 696     /// [`chunks`].
 697     ///
 698     /// # Panics
 699     ///
 700     /// Panics if `chunk_size` is 0.
 701     ///
 702     /// # Examples
 703     ///
 704     /// ```
 705     /// #![feature(exact_chunks)]
 706     ///
 707     /// let slice = ['l', 'o', 'r', 'e', 'm'];
 708     /// let mut iter = slice.exact_chunks(2);
 709     /// assert_eq!(iter.next().unwrap(), &['l', 'o']);
 710     /// assert_eq!(iter.next().unwrap(), &['r', 'e']);
 711     /// assert!(iter.next().is_none());
 712     /// ```
 713     ///
 714     /// [`chunks`]: #method.chunks
 715     #[unstable(feature = "exact_chunks", issue = "47115")]
 716     #[inline]
 717     pub fn exact_chunks(&self, chunk_size: usize) -> ExactChunks<T> {
 718         assert!(chunk_size != 0);
 719         let rem = self.len() % chunk_size;
 720         let len = self.len() - rem;
 721         let (fst, snd) = self.split_at(len);
 722         ExactChunks { v: fst, rem: snd, chunk_size }
 723     }
 724
 725     /// Returns an iterator over `chunk_size` elements of the slice at a time.
 726     /// The chunks are mutable slices, and do not overlap. If `chunk_size` does
 727     /// not divide the length of the slice, then the last up to `chunk_size-1`
 728     /// elements will be omitted and can be retrieved from the `into_remainder`
 729     /// function of the iterator.
 730     ///
 731     /// Due to each chunk having exactly `chunk_size` elements, the compiler
 732     /// can often optimize the resulting code better than in the case of
 733     /// [`chunks_mut`].
 734     ///
 735     /// # Panics
 736     ///
 737     /// Panics if `chunk_size` is 0.
 738     ///
 739     /// # Examples
 740     ///
 741     /// ```
 742     /// #![feature(exact_chunks)]
 743     ///
 744     /// let v = &mut [0, 0, 0, 0, 0];
 745     /// let mut count = 1;
 746     ///
 747     /// for chunk in v.exact_chunks_mut(2) {
 748     ///     for elem in chunk.iter_mut() {
 749     ///         *elem += count;
 750     ///     }
 751     ///     count += 1;
 752     /// }
 753     /// assert_eq!(v, &[1, 1, 2, 2, 0]);
 754     /// ```
 755     ///
 756     /// [`chunks_mut`]: #method.chunks_mut
 757     #[unstable(feature = "exact_chunks", issue = "47115")]
 758     #[inline]
 759     pub fn exact_chunks_mut(&mut self, chunk_size: usize) -> ExactChunksMut<T> {
 760         assert!(chunk_size != 0);
 761         let rem = self.len() % chunk_size;
 762         let len = self.len() - rem;
 763         let (fst, snd) = self.split_at_mut(len);
 764         ExactChunksMut { v: fst, rem: snd, chunk_size }
 765     }
 766
 767     /// Divides one slice into two at an index.
 768     ///
 769     /// The first will contain all indices from `[0, mid)` (excluding
 770     /// the index `mid` itself) and the second will contain all
 771     /// indices from `[mid, len)` (excluding the index `len` itself).
 772     ///
 773     /// # Panics
 774     ///
 775     /// Panics if `mid > len`.
 776     ///
 777     /// # Examples
 778     ///
 779     /// ```
 780     /// let v = [1, 2, 3, 4, 5, 6];
 781     ///
 782     /// {
 783     ///    let (left, right) = v.split_at(0);
 784     ///    assert!(left == []);
 785     ///    assert!(right == [1, 2, 3, 4, 5, 6]);
 786     /// }
 787     ///
 788     /// {
 789     ///     let (left, right) = v.split_at(2);
 790     ///     assert!(left == [1, 2]);
 791     ///     assert!(right == [3, 4, 5, 6]);
 792     /// }
 793     ///
 794     /// {
 795     ///     let (left, right) = v.split_at(6);
 796     ///     assert!(left == [1, 2, 3, 4, 5, 6]);
 797     ///     assert!(right == []);
 798     /// }
 799     /// ```
 800     #[stable(feature = "rust1", since = "1.0.0")]
 801     #[inline]
 802     pub fn split_at(&self, mid: usize) -> (&[T], &[T]) {
 803         (&self[..mid], &self[mid..])
 804     }
 805
 806     /// Divides one mutable slice into two at an index.
 807     ///
 808     /// The first will contain all indices from `[0, mid)` (excluding
 809     /// the index `mid` itself) and the second will contain all
 810     /// indices from `[mid, len)` (excluding the index `len` itself).
 811     ///
 812     /// # Panics
 813     ///
 814     /// Panics if `mid > len`.
 815     ///
 816     /// # Examples
 817     ///
 818     /// ```
 819     /// let mut v = [1, 0, 3, 0, 5, 6];
 820     /// // scoped to restrict the lifetime of the borrows
 821     /// {
 822     ///     let (left, right) = v.split_at_mut(2);
 823     ///     assert!(left == [1, 0]);
 824     ///     assert!(right == [3, 0, 5, 6]);
 825     ///     left[1] = 2;
 826     ///     right[1] = 4;
 827     /// }
 828     /// assert!(v == [1, 2, 3, 4, 5, 6]);
 829     /// ```
 830     #[stable(feature = "rust1", since = "1.0.0")]
 831     #[inline]
 832     pub fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T]) {
 833         let len = self.len();
 834         let ptr = self.as_mut_ptr();
 835
 836         unsafe {
 837             assert!(mid <= len);
 838
 839             (from_raw_parts_mut(ptr, mid),
 840              from_raw_parts_mut(ptr.add(mid), len - mid))
 841         }
 842     }
 843
 844     /// Returns an iterator over subslices separated by elements that match
 845     /// `pred`. The matched element is not contained in the subslices.
 846     ///
 847     /// # Examples
 848     ///
 849     /// ```
 850     /// let slice = [10, 40, 33, 20];
 851     /// let mut iter = slice.split(|num| num % 3 == 0);
 852     ///
 853     /// assert_eq!(iter.next().unwrap(), &[10, 40]);
 854     /// assert_eq!(iter.next().unwrap(), &[20]);
 855     /// assert!(iter.next().is_none());
 856     /// ```
 857     ///
 858     /// If the first element is matched, an empty slice will be the first item
 859     /// returned by the iterator. Similarly, if the last element in the slice
 860     /// is matched, an empty slice will be the last item returned by the
 861     /// iterator:
 862     ///
 863     /// ```
 864     /// let slice = [10, 40, 33];
 865     /// let mut iter = slice.split(|num| num % 3 == 0);
 866     ///
 867     /// assert_eq!(iter.next().unwrap(), &[10, 40]);
 868     /// assert_eq!(iter.next().unwrap(), &[]);
 869     /// assert!(iter.next().is_none());
 870     /// ```
 871     ///
 872     /// If two matched elements are directly adjacent, an empty slice will be
 873     /// present between them:
 874     ///
 875     /// ```
 876     /// let slice = [10, 6, 33, 20];
 877     /// let mut iter = slice.split(|num| num % 3 == 0);
 878     ///
 879     /// assert_eq!(iter.next().unwrap(), &[10]);
 880     /// assert_eq!(iter.next().unwrap(), &[]);
 881     /// assert_eq!(iter.next().unwrap(), &[20]);
 882     /// assert!(iter.next().is_none());
 883     /// ```
 884     #[stable(feature = "rust1", since = "1.0.0")]
 885     #[inline]
 886     pub fn split<F>(&self, pred: F) -> Split<T, F>
 887         where F: FnMut(&T) -> bool
 888     {
 889         Split {
 890             v: self,
 891             pred,
 892             finished: false
 893         }
 894     }
 895
 896     /// Returns an iterator over mutable subslices separated by elements that
 897     /// match `pred`. The matched element is not contained in the subslices.
 898     ///
 899     /// # Examples
 900     ///
 901     /// ```
 902     /// let mut v = [10, 40, 30, 20, 60, 50];
 903     ///
 904     /// for group in v.split_mut(|num| *num % 3 == 0) {
 905     ///     group[0] = 1;
 906     /// }
 907     /// assert_eq!(v, [1, 40, 30, 1, 60, 1]);
 908     /// ```
 909     #[stable(feature = "rust1", since = "1.0.0")]
 910     #[inline]
 911     pub fn split_mut<F>(&mut self, pred: F) -> SplitMut<T, F>
 912         where F: FnMut(&T) -> bool
 913     {
 914         SplitMut { v: self, pred, finished: false }
 915     }
 916
 917     /// Returns an iterator over subslices separated by elements that match
 918     /// `pred`, starting at the end of the slice and working backwards.
 919     /// The matched element is not contained in the subslices.
 920     ///
 921     /// # Examples
 922     ///
 923     /// ```
 924     /// let slice = [11, 22, 33, 0, 44, 55];
 925     /// let mut iter = slice.rsplit(|num| *num == 0);
 926     ///
 927     /// assert_eq!(iter.next().unwrap(), &[44, 55]);
 928     /// assert_eq!(iter.next().unwrap(), &[11, 22, 33]);
 929     /// assert_eq!(iter.next(), None);
 930     /// ```
 931     ///
 932     /// As with `split()`, if the first or last element is matched, an empty
 933     /// slice will be the first (or last) item returned by the iterator.
 934     ///
 935     /// ```
 936     /// let v = &[0, 1, 1, 2, 3, 5, 8];
 937     /// let mut it = v.rsplit(|n| *n % 2 == 0);
 938     /// assert_eq!(it.next().unwrap(), &[]);
 939     /// assert_eq!(it.next().unwrap(), &[3, 5]);
 940     /// assert_eq!(it.next().unwrap(), &[1, 1]);
 941     /// assert_eq!(it.next().unwrap(), &[]);
 942     /// assert_eq!(it.next(), None);
 943     /// ```
 944     #[stable(feature = "slice_rsplit", since = "1.27.0")]
 945     #[inline]
 946     pub fn rsplit<F>(&self, pred: F) -> RSplit<T, F>
 947         where F: FnMut(&T) -> bool
 948     {
 949         RSplit { inner: self.split(pred) }
 950     }
 951
 952     /// Returns an iterator over mutable subslices separated by elements that
 953     /// match `pred`, starting at the end of the slice and working
 954     /// backwards. The matched element is not contained in the subslices.
 955     ///
 956     /// # Examples
 957     ///
 958     /// ```
 959     /// let mut v = [100, 400, 300, 200, 600, 500];
 960     ///
 961     /// let mut count = 0;
 962     /// for group in v.rsplit_mut(|num| *num % 3 == 0) {
 963     ///     count += 1;
 964     ///     group[0] = count;
 965     /// }
 966     /// assert_eq!(v, [3, 400, 300, 2, 600, 1]);
 967     /// ```
 968     ///
 969     #[stable(feature = "slice_rsplit", since = "1.27.0")]
 970     #[inline]
 971     pub fn rsplit_mut<F>(&mut self, pred: F) -> RSplitMut<T, F>
 972         where F: FnMut(&T) -> bool
 973     {
 974         RSplitMut { inner: self.split_mut(pred) }
 975     }
 976
 977     /// Returns an iterator over subslices separated by elements that match
 978     /// `pred`, limited to returning at most `n` items. The matched element is
 979     /// not contained in the subslices.
 980     ///
 981     /// The last element returned, if any, will contain the remainder of the
 982     /// slice.
 983     ///
 984     /// # Examples
 985     ///
 986     /// Print the slice split once by numbers divisible by 3 (i.e. `[10, 40]`,
 987     /// `[20, 60, 50]`):
 988     ///
 989     /// ```
 990     /// let v = [10, 40, 30, 20, 60, 50];
 991     ///
 992     /// for group in v.splitn(2, |num| *num % 3 == 0) {
 993     ///     println!("{:?}", group);
 994     /// }
 995     /// ```
 996     #[stable(feature = "rust1", since = "1.0.0")]
 997     #[inline]
 998     pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<T, F>
 999         where F: FnMut(&T) -> bool
1000     {
1001         SplitN {
1002             inner: GenericSplitN {
1003                 iter: self.split(pred),
1004                 count: n
1005             }
1006         }
1007     }
1008
1009     /// Returns an iterator over subslices separated by elements that match
1010     /// `pred`, limited to returning at most `n` items. The matched element is
1011     /// not contained in the subslices.
1012     ///
1013     /// The last element returned, if any, will contain the remainder of the
1014     /// slice.
1015     ///
1016     /// # Examples
1017     ///
1018     /// ```
1019     /// let mut v = [10, 40, 30, 20, 60, 50];
1020     ///
1021     /// for group in v.splitn_mut(2, |num| *num % 3 == 0) {
1022     ///     group[0] = 1;
1023     /// }
1024     /// assert_eq!(v, [1, 40, 30, 1, 60, 50]);
1025     /// ```
1026     #[stable(feature = "rust1", since = "1.0.0")]
1027     #[inline]
1028     pub fn splitn_mut<F>(&mut self, n: usize, pred: F) -> SplitNMut<T, F>
1029         where F: FnMut(&T) -> bool
1030     {
1031         SplitNMut {
1032             inner: GenericSplitN {
1033                 iter: self.split_mut(pred),
1034                 count: n
1035             }
1036         }
1037     }
1038
1039     /// Returns an iterator over subslices separated by elements that match
1040     /// `pred` limited to returning at most `n` items. This starts at the end of
1041     /// the slice and works backwards.  The matched element is not contained in
1042     /// the subslices.
1043     ///
1044     /// The last element returned, if any, will contain the remainder of the
1045     /// slice.
1046     ///
1047     /// # Examples
1048     ///
1049     /// Print the slice split once, starting from the end, by numbers divisible
1050     /// by 3 (i.e. `[50]`, `[10, 40, 30, 20]`):
1051     ///
1052     /// ```
1053     /// let v = [10, 40, 30, 20, 60, 50];
1054     ///
1055     /// for group in v.rsplitn(2, |num| *num % 3 == 0) {
1056     ///     println!("{:?}", group);
1057     /// }
1058     /// ```
1059     #[stable(feature = "rust1", since = "1.0.0")]
1060     #[inline]
1061     pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<T, F>
1062         where F: FnMut(&T) -> bool
1063     {
1064         RSplitN {
1065             inner: GenericSplitN {
1066                 iter: self.rsplit(pred),
1067                 count: n
1068             }
1069         }
1070     }
1071
1072     /// Returns an iterator over subslices separated by elements that match
1073     /// `pred` limited to returning at most `n` items. This starts at the end of
1074     /// the slice and works backwards. The matched element is not contained in
1075     /// the subslices.
1076     ///
1077     /// The last element returned, if any, will contain the remainder of the
1078     /// slice.
1079     ///
1080     /// # Examples
1081     ///
1082     /// ```
1083     /// let mut s = [10, 40, 30, 20, 60, 50];
1084     ///
1085     /// for group in s.rsplitn_mut(2, |num| *num % 3 == 0) {
1086     ///     group[0] = 1;
1087     /// }
1088     /// assert_eq!(s, [1, 40, 30, 20, 60, 1]);
1089     /// ```
1090     #[stable(feature = "rust1", since = "1.0.0")]
1091     #[inline]
1092     pub fn rsplitn_mut<F>(&mut self, n: usize, pred: F) -> RSplitNMut<T, F>
1093         where F: FnMut(&T) -> bool
1094     {
1095         RSplitNMut {
1096             inner: GenericSplitN {
1097                 iter: self.rsplit_mut(pred),
1098                 count: n
1099             }
1100         }
1101     }
1102
1103     /// Returns `true` if the slice contains an element with the given value.
1104     ///
1105     /// # Examples
1106     ///
1107     /// ```
1108     /// let v = [10, 40, 30];
1109     /// assert!(v.contains(&30));
1110     /// assert!(!v.contains(&50));
1111     /// ```
1112     #[stable(feature = "rust1", since = "1.0.0")]
1113     pub fn contains(&self, x: &T) -> bool
1114         where T: PartialEq
1115     {
1116         x.slice_contains(self)
1117     }
1118
1119     /// Returns `true` if `needle` is a prefix of the slice.
1120     ///
1121     /// # Examples
1122     ///
1123     /// ```
1124     /// let v = [10, 40, 30];
1125     /// assert!(v.starts_with(&[10]));
1126     /// assert!(v.starts_with(&[10, 40]));
1127     /// assert!(!v.starts_with(&[50]));
1128     /// assert!(!v.starts_with(&[10, 50]));
1129     /// ```
1130     ///
1131     /// Always returns `true` if `needle` is an empty slice:
1132     ///
1133     /// ```
1134     /// let v = &[10, 40, 30];
1135     /// assert!(v.starts_with(&[]));
1136     /// let v: &[u8] = &[];
1137     /// assert!(v.starts_with(&[]));
1138     /// ```
1139     #[stable(feature = "rust1", since = "1.0.0")]
1140     pub fn starts_with(&self, needle: &[T]) -> bool
1141         where T: PartialEq
1142     {
1143         let n = needle.len();
1144         self.len() >= n && needle == &self[..n]
1145     }
1146
1147     /// Returns `true` if `needle` is a suffix of the slice.
1148     ///
1149     /// # Examples
1150     ///
1151     /// ```
1152     /// let v = [10, 40, 30];
1153     /// assert!(v.ends_with(&[30]));
1154     /// assert!(v.ends_with(&[40, 30]));
1155     /// assert!(!v.ends_with(&[50]));
1156     /// assert!(!v.ends_with(&[50, 30]));
1157     /// ```
1158     ///
1159     /// Always returns `true` if `needle` is an empty slice:
1160     ///
1161     /// ```
1162     /// let v = &[10, 40, 30];
1163     /// assert!(v.ends_with(&[]));
1164     /// let v: &[u8] = &[];
1165     /// assert!(v.ends_with(&[]));
1166     /// ```
1167     #[stable(feature = "rust1", since = "1.0.0")]
1168     pub fn ends_with(&self, needle: &[T]) -> bool
1169         where T: PartialEq
1170     {
1171         let (m, n) = (self.len(), needle.len());
1172         m >= n && needle == &self[m-n..]
1173     }
1174
1175     /// Binary searches this sorted slice for a given element.
1176     ///
1177     /// If the value is found then `Ok` is returned, containing the
1178     /// index of the matching element; if the value is not found then
1179     /// `Err` is returned, containing the index where a matching
1180     /// element could be inserted while maintaining sorted order.
1181     ///
1182     /// # Examples
1183     ///
1184     /// Looks up a series of four elements. The first is found, with a
1185     /// uniquely determined position; the second and third are not
1186     /// found; the fourth could match any position in `[1, 4]`.
1187     ///
1188     /// ```
1189     /// let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
1190     ///
1191     /// assert_eq!(s.binary_search(&13),  Ok(9));
1192     /// assert_eq!(s.binary_search(&4),   Err(7));
1193     /// assert_eq!(s.binary_search(&100), Err(13));
1194     /// let r = s.binary_search(&1);
1195     /// assert!(match r { Ok(1..=4) => true, _ => false, });
1196     /// ```
1197     #[stable(feature = "rust1", since = "1.0.0")]
1198     pub fn binary_search(&self, x: &T) -> Result<usize, usize>
1199         where T: Ord
1200     {
1201         self.binary_search_by(|p| p.cmp(x))
1202     }
1203
1204     /// Binary searches this sorted slice with a comparator function.
1205     ///
1206     /// The comparator function should implement an order consistent
1207     /// with the sort order of the underlying slice, returning an
1208     /// order code that indicates whether its argument is `Less`,
1209     /// `Equal` or `Greater` the desired target.
1210     ///
1211     /// If a matching value is found then returns `Ok`, containing
1212     /// the index for the matched element; if no match is found then
1213     /// `Err` is returned, containing the index where a matching
1214     /// element could be inserted while maintaining sorted order.
1215     ///
1216     /// # Examples
1217     ///
1218     /// Looks up a series of four elements. The first is found, with a
1219     /// uniquely determined position; the second and third are not
1220     /// found; the fourth could match any position in `[1, 4]`.
1221     ///
1222     /// ```
1223     /// let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
1224     ///
1225     /// let seek = 13;
1226     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Ok(9));
1227     /// let seek = 4;
1228     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(7));
1229     /// let seek = 100;
1230     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(13));
1231     /// let seek = 1;
1232     /// let r = s.binary_search_by(|probe| probe.cmp(&seek));
1233     /// assert!(match r { Ok(1..=4) => true, _ => false, });
1234     /// ```
1235     #[stable(feature = "rust1", since = "1.0.0")]
1236     #[inline]
1237     pub fn binary_search_by<'a, F>(&'a self, mut f: F) -> Result<usize, usize>
1238         where F: FnMut(&'a T) -> Ordering
1239     {
1240         let s = self;
1241         let mut size = s.len();
1242         if size == 0 {
1243             return Err(0);
1244         }
1245         let mut base = 0usize;
1246         while size > 1 {
1247             let half = size / 2;
1248             let mid = base + half;
1249             // mid is always in [0, size), that means mid is >= 0 and < size.
1250             // mid >= 0: by definition
1251             // mid < size: mid = size / 2 + size / 4 + size / 8 ...
1252             let cmp = f(unsafe { s.get_unchecked(mid) });
1253             base = if cmp == Greater { base } else { mid };
1254             size -= half;
1255         }
1256         // base is always in [0, size) because base <= mid.
1257         let cmp = f(unsafe { s.get_unchecked(base) });
1258         if cmp == Equal { Ok(base) } else { Err(base + (cmp == Less) as usize) }
1259
1260     }
1261
1262     /// Binary searches this sorted slice with a key extraction function.
1263     ///
1264     /// Assumes that the slice is sorted by the key, for instance with
1265     /// [`sort_by_key`] using the same key extraction function.
1266     ///
1267     /// If a matching value is found then returns `Ok`, containing the
1268     /// index for the matched element; if no match is found then `Err`
1269     /// is returned, containing the index where a matching element could
1270     /// be inserted while maintaining sorted order.
1271     ///
1272     /// [`sort_by_key`]: #method.sort_by_key
1273     ///
1274     /// # Examples
1275     ///
1276     /// Looks up a series of four elements in a slice of pairs sorted by
1277     /// their second elements. The first is found, with a uniquely
1278     /// determined position; the second and third are not found; the
1279     /// fourth could match any position in `[1, 4]`.
1280     ///
1281     /// ```
1282     /// let s = [(0, 0), (2, 1), (4, 1), (5, 1), (3, 1),
1283     ///          (1, 2), (2, 3), (4, 5), (5, 8), (3, 13),
1284     ///          (1, 21), (2, 34), (4, 55)];
1285     ///
1286     /// assert_eq!(s.binary_search_by_key(&13, |&(a,b)| b),  Ok(9));
1287     /// assert_eq!(s.binary_search_by_key(&4, |&(a,b)| b),   Err(7));
1288     /// assert_eq!(s.binary_search_by_key(&100, |&(a,b)| b), Err(13));
1289     /// let r = s.binary_search_by_key(&1, |&(a,b)| b);
1290     /// assert!(match r { Ok(1..=4) => true, _ => false, });
1291     /// ```
1292     #[stable(feature = "slice_binary_search_by_key", since = "1.10.0")]
1293     #[inline]
1294     pub fn binary_search_by_key<'a, B, F>(&'a self, b: &B, mut f: F) -> Result<usize, usize>
1295         where F: FnMut(&'a T) -> B,
1296               B: Ord
1297     {
1298         self.binary_search_by(|k| f(k).cmp(b))
1299     }
1300
1301     /// Sorts the slice, but may not preserve the order of equal elements.
1302     ///
1303     /// This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate),
1304     /// and `O(n log n)` worst-case.
1305     ///
1306     /// # Current implementation
1307     ///
1308     /// The current algorithm is based on [pattern-defeating quicksort][pdqsort] by Orson Peters,
1309     /// which combines the fast average case of randomized quicksort with the fast worst case of
1310     /// heapsort, while achieving linear time on slices with certain patterns. It uses some
1311     /// randomization to avoid degenerate cases, but with a fixed seed to always provide
1312     /// deterministic behavior.
1313     ///
1314     /// It is typically faster than stable sorting, except in a few special cases, e.g. when the
1315     /// slice consists of several concatenated sorted sequences.
1316     ///
1317     /// # Examples
1318     ///
1319     /// ```
1320     /// let mut v = [-5, 4, 1, -3, 2];
1321     ///
1322     /// v.sort_unstable();
1323     /// assert!(v == [-5, -3, 1, 2, 4]);
1324     /// ```
1325     ///
1326     /// [pdqsort]: https://github.com/orlp/pdqsort
1327     #[stable(feature = "sort_unstable", since = "1.20.0")]
1328     #[inline]
1329     pub fn sort_unstable(&mut self)
1330         where T: Ord
1331     {
1332         sort::quicksort(self, |a, b| a.lt(b));
1333     }
1334
1335     /// Sorts the slice with a comparator function, but may not preserve the order of equal
1336     /// elements.
1337     ///
1338     /// This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate),
1339     /// and `O(n log n)` worst-case.
1340     ///
1341     /// # Current implementation
1342     ///
1343     /// The current algorithm is based on [pattern-defeating quicksort][pdqsort] by Orson Peters,
1344     /// which combines the fast average case of randomized quicksort with the fast worst case of
1345     /// heapsort, while achieving linear time on slices with certain patterns. It uses some
1346     /// randomization to avoid degenerate cases, but with a fixed seed to always provide
1347     /// deterministic behavior.
1348     ///
1349     /// It is typically faster than stable sorting, except in a few special cases, e.g. when the
1350     /// slice consists of several concatenated sorted sequences.
1351     ///
1352     /// # Examples
1353     ///
1354     /// ```
1355     /// let mut v = [5, 4, 1, 3, 2];
1356     /// v.sort_unstable_by(|a, b| a.cmp(b));
1357     /// assert!(v == [1, 2, 3, 4, 5]);
1358     ///
1359     /// // reverse sorting
1360     /// v.sort_unstable_by(|a, b| b.cmp(a));
1361     /// assert!(v == [5, 4, 3, 2, 1]);
1362     /// ```
1363     ///
1364     /// [pdqsort]: https://github.com/orlp/pdqsort
1365     #[stable(feature = "sort_unstable", since = "1.20.0")]
1366     #[inline]
1367     pub fn sort_unstable_by<F>(&mut self, mut compare: F)
1368         where F: FnMut(&T, &T) -> Ordering
1369     {
1370         sort::quicksort(self, |a, b| compare(a, b) == Ordering::Less);
1371     }
1372
1373     /// Sorts the slice with a key extraction function, but may not preserve the order of equal
1374     /// elements.
1375     ///
1376     /// This sort is unstable (i.e. may reorder equal elements), in-place (i.e. does not allocate),
1377     /// and `O(m n log(m n))` worst-case, where the key function is `O(m)`.
1378     ///
1379     /// # Current implementation
1380     ///
1381     /// The current algorithm is based on [pattern-defeating quicksort][pdqsort] by Orson Peters,
1382     /// which combines the fast average case of randomized quicksort with the fast worst case of
1383     /// heapsort, while achieving linear time on slices with certain patterns. It uses some
1384     /// randomization to avoid degenerate cases, but with a fixed seed to always provide
1385     /// deterministic behavior.
1386     ///
1387     /// # Examples
1388     ///
1389     /// ```
1390     /// let mut v = [-5i32, 4, 1, -3, 2];
1391     ///
1392     /// v.sort_unstable_by_key(|k| k.abs());
1393     /// assert!(v == [1, 2, -3, 4, -5]);
1394     /// ```
1395     ///
1396     /// [pdqsort]: https://github.com/orlp/pdqsort
1397     #[stable(feature = "sort_unstable", since = "1.20.0")]
1398     #[inline]
1399     pub fn sort_unstable_by_key<K, F>(&mut self, mut f: F)
1400         where F: FnMut(&T) -> K, K: Ord
1401     {
1402         sort::quicksort(self, |a, b| f(a).lt(&f(b)));
1403     }
1404
1405     /// Rotates the slice in-place such that the first `mid` elements of the
1406     /// slice move to the end while the last `self.len() - mid` elements move to
1407     /// the front. After calling `rotate_left`, the element previously at index
1408     /// `mid` will become the first element in the slice.
1409     ///
1410     /// # Panics
1411     ///
1412     /// This function will panic if `mid` is greater than the length of the
1413     /// slice. Note that `mid == self.len()` does _not_ panic and is a no-op
1414     /// rotation.
1415     ///
1416     /// # Complexity
1417     ///
1418     /// Takes linear (in `self.len()`) time.
1419     ///
1420     /// # Examples
1421     ///
1422     /// ```
1423     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
1424     /// a.rotate_left(2);
1425     /// assert_eq!(a, ['c', 'd', 'e', 'f', 'a', 'b']);
1426     /// ```
1427     ///
1428     /// Rotating a subslice:
1429     ///
1430     /// ```
1431     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
1432     /// a[1..5].rotate_left(1);
1433     /// assert_eq!(a, ['a', 'c', 'd', 'e', 'b', 'f']);
1434    /// ```
1435     #[stable(feature = "slice_rotate", since = "1.26.0")]
1436     pub fn rotate_left(&mut self, mid: usize) {
1437         assert!(mid <= self.len());
1438         let k = self.len() - mid;
1439
1440         unsafe {
1441             let p = self.as_mut_ptr();
1442             rotate::ptr_rotate(mid, p.add(mid), k);
1443         }
1444     }
1445
1446     /// Rotates the slice in-place such that the first `self.len() - k`
1447     /// elements of the slice move to the end while the last `k` elements move
1448     /// to the front. After calling `rotate_right`, the element previously at
1449     /// index `self.len() - k` will become the first element in the slice.
1450     ///
1451     /// # Panics
1452     ///
1453     /// This function will panic if `k` is greater than the length of the
1454     /// slice. Note that `k == self.len()` does _not_ panic and is a no-op
1455     /// rotation.
1456     ///
1457     /// # Complexity
1458     ///
1459     /// Takes linear (in `self.len()`) time.
1460     ///
1461     /// # Examples
1462     ///
1463     /// ```
1464     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
1465     /// a.rotate_right(2);
1466     /// assert_eq!(a, ['e', 'f', 'a', 'b', 'c', 'd']);
1467     /// ```
1468     ///
1469     /// Rotate a subslice:
1470     ///
1471     /// ```
1472     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
1473     /// a[1..5].rotate_right(1);
1474     /// assert_eq!(a, ['a', 'e', 'b', 'c', 'd', 'f']);
1475     /// ```
1476     #[stable(feature = "slice_rotate", since = "1.26.0")]
1477     pub fn rotate_right(&mut self, k: usize) {
1478         assert!(k <= self.len());
1479         let mid = self.len() - k;
1480
1481         unsafe {
1482             let p = self.as_mut_ptr();
1483             rotate::ptr_rotate(mid, p.add(mid), k);
1484         }
1485     }
1486
1487     /// Copies the elements from `src` into `self`.
1488     ///
1489     /// The length of `src` must be the same as `self`.
1490     ///
1491     /// If `src` implements `Copy`, it can be more performant to use
1492     /// [`copy_from_slice`].
1493     ///
1494     /// # Panics
1495     ///
1496     /// This function will panic if the two slices have different lengths.
1497     ///
1498     /// # Examples
1499     ///
1500     /// Cloning two elements from a slice into another:
1501     ///
1502     /// ```
1503     /// let src = [1, 2, 3, 4];
1504     /// let mut dst = [0, 0];
1505     ///
1506     /// // Because the slices have to be the same length,
1507     /// // we slice the source slice from four elements
1508     /// // to two. It will panic if we don't do this.
1509     /// dst.clone_from_slice(&src[2..]);
1510     ///
1511     /// assert_eq!(src, [1, 2, 3, 4]);
1512     /// assert_eq!(dst, [3, 4]);
1513     /// ```
1514     ///
1515     /// Rust enforces that there can only be one mutable reference with no
1516     /// immutable references to a particular piece of data in a particular
1517     /// scope. Because of this, attempting to use `clone_from_slice` on a
1518     /// single slice will result in a compile failure:
1519     ///
1520     /// ```compile_fail
1521     /// let mut slice = [1, 2, 3, 4, 5];
1522     ///
1523     /// slice[..2].clone_from_slice(&slice[3..]); // compile fail!
1524     /// ```
1525     ///
1526     /// To work around this, we can use [`split_at_mut`] to create two distinct
1527     /// sub-slices from a slice:
1528     ///
1529     /// ```
1530     /// let mut slice = [1, 2, 3, 4, 5];
1531     ///
1532     /// {
1533     ///     let (left, right) = slice.split_at_mut(2);
1534     ///     left.clone_from_slice(&right[1..]);
1535     /// }
1536     ///
1537     /// assert_eq!(slice, [4, 5, 3, 4, 5]);
1538     /// ```
1539     ///
1540     /// [`copy_from_slice`]: #method.copy_from_slice
1541     /// [`split_at_mut`]: #method.split_at_mut
1542     #[stable(feature = "clone_from_slice", since = "1.7.0")]
1543     pub fn clone_from_slice(&mut self, src: &[T]) where T: Clone {
1544         assert!(self.len() == src.len(),
1545                 "destination and source slices have different lengths");
1546         // NOTE: We need to explicitly slice them to the same length
1547         // for bounds checking to be elided, and the optimizer will
1548         // generate memcpy for simple cases (for example T = u8).
1549         let len = self.len();
1550         let src = &src[..len];
1551         for i in 0..len {
1552             self[i].clone_from(&src[i]);
1553         }
1554
1555     }
1556
1557     /// Copies all elements from `src` into `self`, using a memcpy.
1558     ///
1559     /// The length of `src` must be the same as `self`.
1560     ///
1561     /// If `src` does not implement `Copy`, use [`clone_from_slice`].
1562     ///
1563     /// # Panics
1564     ///
1565     /// This function will panic if the two slices have different lengths.
1566     ///
1567     /// # Examples
1568     ///
1569     /// Copying two elements from a slice into another:
1570     ///
1571     /// ```
1572     /// let src = [1, 2, 3, 4];
1573     /// let mut dst = [0, 0];
1574     ///
1575     /// // Because the slices have to be the same length,
1576     /// // we slice the source slice from four elements
1577     /// // to two. It will panic if we don't do this.
1578     /// dst.copy_from_slice(&src[2..]);
1579     ///
1580     /// assert_eq!(src, [1, 2, 3, 4]);
1581     /// assert_eq!(dst, [3, 4]);
1582     /// ```
1583     ///
1584     /// Rust enforces that there can only be one mutable reference with no
1585     /// immutable references to a particular piece of data in a particular
1586     /// scope. Because of this, attempting to use `copy_from_slice` on a
1587     /// single slice will result in a compile failure:
1588     ///
1589     /// ```compile_fail
1590     /// let mut slice = [1, 2, 3, 4, 5];
1591     ///
1592     /// slice[..2].copy_from_slice(&slice[3..]); // compile fail!
1593     /// ```
1594     ///
1595     /// To work around this, we can use [`split_at_mut`] to create two distinct
1596     /// sub-slices from a slice:
1597     ///
1598     /// ```
1599     /// let mut slice = [1, 2, 3, 4, 5];
1600     ///
1601     /// {
1602     ///     let (left, right) = slice.split_at_mut(2);
1603     ///     left.copy_from_slice(&right[1..]);
1604     /// }
1605     ///
1606     /// assert_eq!(slice, [4, 5, 3, 4, 5]);
1607     /// ```
1608     ///
1609     /// [`clone_from_slice`]: #method.clone_from_slice
1610     /// [`split_at_mut`]: #method.split_at_mut
1611     #[stable(feature = "copy_from_slice", since = "1.9.0")]
1612     pub fn copy_from_slice(&mut self, src: &[T]) where T: Copy {
1613         assert_eq!(self.len(), src.len(),
1614                    "destination and source slices have different lengths");
1615         unsafe {
1616             ptr::copy_nonoverlapping(
1617                 src.as_ptr(), self.as_mut_ptr(), self.len());
1618         }
1619     }
1620
1621     /// Copies elements from one part of the slice to another part of itself,
1622     /// using a memmove.
1623     ///
1624     /// `src` is the range within `self` to copy from. `dest` is the starting
1625     /// index of the range within `self` to copy to, which will have the same
1626     /// length as `src`. The two ranges may overlap. The ends of the two ranges
1627     /// must be less than or equal to `self.len()`.
1628     ///
1629     /// # Panics
1630     ///
1631     /// This function will panic if either range exceeds the end of the slice,
1632     /// or if the end of `src` is before the start.
1633     ///
1634     /// # Examples
1635     ///
1636     /// Copying four bytes within a slice:
1637     ///
1638     /// ```
1639     /// # #![feature(copy_within)]
1640     /// let mut bytes = *b"Hello, World!";
1641     ///
1642     /// bytes.copy_within(1..5, 8);
1643     ///
1644     /// assert_eq!(&bytes, b"Hello, Wello!");
1645     /// ```
1646     #[unstable(feature = "copy_within", issue = "54236")]
1647     pub fn copy_within<R: ops::RangeBounds<usize>>(&mut self, src: R, dest: usize)
1648     where
1649         T: Copy,
1650     {
1651         let src_start = match src.start_bound() {
1652             ops::Bound::Included(&n) => n,
1653             ops::Bound::Excluded(&n) => n
1654                 .checked_add(1)
1655                 .unwrap_or_else(|| slice_index_overflow_fail()),
1656             ops::Bound::Unbounded => 0,
1657         };
1658         let src_end = match src.end_bound() {
1659             ops::Bound::Included(&n) => n
1660                 .checked_add(1)
1661                 .unwrap_or_else(|| slice_index_overflow_fail()),
1662             ops::Bound::Excluded(&n) => n,
1663             ops::Bound::Unbounded => self.len(),
1664         };
1665         assert!(src_start <= src_end, "src end is before src start");
1666         assert!(src_end <= self.len(), "src is out of bounds");
1667         let count = src_end - src_start;
1668         assert!(dest <= self.len() - count, "dest is out of bounds");
1669         unsafe {
1670             ptr::copy(
1671                 self.get_unchecked(src_start),
1672                 self.get_unchecked_mut(dest),
1673                 count,
1674             );
1675         }
1676     }
1677
1678     /// Swaps all elements in `self` with those in `other`.
1679     ///
1680     /// The length of `other` must be the same as `self`.
1681     ///
1682     /// # Panics
1683     ///
1684     /// This function will panic if the two slices have different lengths.
1685     ///
1686     /// # Example
1687     ///
1688     /// Swapping two elements across slices:
1689     ///
1690     /// ```
1691     /// let mut slice1 = [0, 0];
1692     /// let mut slice2 = [1, 2, 3, 4];
1693     ///
1694     /// slice1.swap_with_slice(&mut slice2[2..]);
1695     ///
1696     /// assert_eq!(slice1, [3, 4]);
1697     /// assert_eq!(slice2, [1, 2, 0, 0]);
1698     /// ```
1699     ///
1700     /// Rust enforces that there can only be one mutable reference to a
1701     /// particular piece of data in a particular scope. Because of this,
1702     /// attempting to use `swap_with_slice` on a single slice will result in
1703     /// a compile failure:
1704     ///
1705     /// ```compile_fail
1706     /// let mut slice = [1, 2, 3, 4, 5];
1707     /// slice[..2].swap_with_slice(&mut slice[3..]); // compile fail!
1708     /// ```
1709     ///
1710     /// To work around this, we can use [`split_at_mut`] to create two distinct
1711     /// mutable sub-slices from a slice:
1712     ///
1713     /// ```
1714     /// let mut slice = [1, 2, 3, 4, 5];
1715     ///
1716     /// {
1717     ///     let (left, right) = slice.split_at_mut(2);
1718     ///     left.swap_with_slice(&mut right[1..]);
1719     /// }
1720     ///
1721     /// assert_eq!(slice, [4, 5, 3, 1, 2]);
1722     /// ```
1723     ///
1724     /// [`split_at_mut`]: #method.split_at_mut
1725     #[stable(feature = "swap_with_slice", since = "1.27.0")]
1726     pub fn swap_with_slice(&mut self, other: &mut [T]) {
1727         assert!(self.len() == other.len(),
1728                 "destination and source slices have different lengths");
1729         unsafe {
1730             ptr::swap_nonoverlapping(
1731                 self.as_mut_ptr(), other.as_mut_ptr(), self.len());
1732         }
1733     }
1734
1735     /// Function to calculate lengths of the middle and trailing slice for `align_to{,_mut}`.
1736     fn align_to_offsets<U>(&self) -> (usize, usize) {
1737         // What we gonna do about `rest` is figure out what multiple of `U`s we can put in a
1738         // lowest number of `T`s. And how many `T`s we need for each such "multiple".
1739         //
1740         // Consider for example T=u8 U=u16. Then we can put 1 U in 2 Ts. Simple. Now, consider
1741         // for example a case where size_of::<T> = 16, size_of::<U> = 24. We can put 2 Us in
1742         // place of every 3 Ts in the `rest` slice. A bit more complicated.
1743         //
1744         // Formula to calculate this is:
1745         //
1746         // Us = lcm(size_of::<T>, size_of::<U>) / size_of::<U>
1747         // Ts = lcm(size_of::<T>, size_of::<U>) / size_of::<T>
1748         //
1749         // Expanded and simplified:
1750         //
1751         // Us = size_of::<T> / gcd(size_of::<T>, size_of::<U>)
1752         // Ts = size_of::<U> / gcd(size_of::<T>, size_of::<U>)
1753         //
1754         // Luckily since all this is constant-evaluated... performance here matters not!
1755         #[inline]
1756         fn gcd(a: usize, b: usize) -> usize {
1757             // iterative stein’s algorithm
1758             // We should still make this `const fn` (and revert to recursive algorithm if we do)
1759             // because relying on llvm to consteval all this is… well, it makes me
1760             let (ctz_a, mut ctz_b) = unsafe {
1761                 if a == 0 { return b; }
1762                 if b == 0 { return a; }
1763                 (::intrinsics::cttz_nonzero(a), ::intrinsics::cttz_nonzero(b))
1764             };
1765             let k = ctz_a.min(ctz_b);
1766             let mut a = a >> ctz_a;
1767             let mut b = b;
1768             loop {
1769                 // remove all factors of 2 from b
1770                 b >>= ctz_b;
1771                 if a > b {
1772                     ::mem::swap(&mut a, &mut b);
1773                 }
1774                 b = b - a;
1775                 unsafe {
1776                     if b == 0 {
1777                         break;
1778                     }
1779                     ctz_b = ::intrinsics::cttz_nonzero(b);
1780                 }
1781             }
1782             a << k
1783         }
1784         let gcd: usize = gcd(::mem::size_of::<T>(), ::mem::size_of::<U>());
1785         let ts: usize = ::mem::size_of::<U>() / gcd;
1786         let us: usize = ::mem::size_of::<T>() / gcd;
1787
1788         // Armed with this knowledge, we can find how many `U`s we can fit!
1789         let us_len = self.len() / ts * us;
1790         // And how many `T`s will be in the trailing slice!
1791         let ts_len = self.len() % ts;
1792         (us_len, ts_len)
1793     }
1794
1795     /// Transmute the slice to a slice of another type, ensuring alignment of the types is
1796     /// maintained.
1797     ///
1798     /// This method splits the slice into three distinct slices: prefix, correctly aligned middle
1799     /// slice of a new type, and the suffix slice. The method does a best effort to make the
1800     /// middle slice the greatest length possible for a given type and input slice, but only
1801     /// your algorithm's performance should depend on that, not its correctness.
1802     ///
1803     /// This method has no purpose when either input element `T` or output element `U` are
1804     /// zero-sized and will return the original slice without splitting anything.
1805     ///
1806     /// # Unsafety
1807     ///
1808     /// This method is essentially a `transmute` with respect to the elements in the returned
1809     /// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here.
1810     ///
1811     /// # Examples
1812     ///
1813     /// Basic usage:
1814     ///
1815     /// ```
1816     /// unsafe {
1817     ///     let bytes: [u8; 7] = [1, 2, 3, 4, 5, 6, 7];
1818     ///     let (prefix, shorts, suffix) = bytes.align_to::<u16>();
1819     ///     // less_efficient_algorithm_for_bytes(prefix);
1820     ///     // more_efficient_algorithm_for_aligned_shorts(shorts);
1821     ///     // less_efficient_algorithm_for_bytes(suffix);
1822     /// }
1823     /// ```
1824     #[stable(feature = "slice_align_to", since = "1.30.0")]
1825     pub unsafe fn align_to<U>(&self) -> (&[T], &[U], &[T]) {
1826         // Note that most of this function will be constant-evaluated,
1827         if ::mem::size_of::<U>() == 0 || ::mem::size_of::<T>() == 0 {
1828             // handle ZSTs specially, which is – don't handle them at all.
1829             return (self, &[], &[]);
1830         }
1831
1832         // First, find at what point do we split between the first and 2nd slice. Easy with
1833         // ptr.align_offset.
1834         let ptr = self.as_ptr();
1835         let offset = ::ptr::align_offset(ptr, ::mem::align_of::<U>());
1836         if offset > self.len() {
1837             (self, &[], &[])
1838         } else {
1839             let (left, rest) = self.split_at(offset);
1840             // now `rest` is definitely aligned, so `from_raw_parts_mut` below is okay
1841             let (us_len, ts_len) = rest.align_to_offsets::<U>();
1842             (left,
1843              from_raw_parts(rest.as_ptr() as *const U, us_len),
1844              from_raw_parts(rest.as_ptr().add(rest.len() - ts_len), ts_len))
1845         }
1846     }
1847
1848     /// Transmute the slice to a slice of another type, ensuring alignment of the types is
1849     /// maintained.
1850     ///
1851     /// This method splits the slice into three distinct slices: prefix, correctly aligned middle
1852     /// slice of a new type, and the suffix slice. The method does a best effort to make the
1853     /// middle slice the greatest length possible for a given type and input slice, but only
1854     /// your algorithm's performance should depend on that, not its correctness.
1855     ///
1856     /// This method has no purpose when either input element `T` or output element `U` are
1857     /// zero-sized and will return the original slice without splitting anything.
1858     ///
1859     /// # Unsafety
1860     ///
1861     /// This method is essentially a `transmute` with respect to the elements in the returned
1862     /// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here.
1863     ///
1864     /// # Examples
1865     ///
1866     /// Basic usage:
1867     ///
1868     /// ```
1869     /// unsafe {
1870     ///     let mut bytes: [u8; 7] = [1, 2, 3, 4, 5, 6, 7];
1871     ///     let (prefix, shorts, suffix) = bytes.align_to_mut::<u16>();
1872     ///     // less_efficient_algorithm_for_bytes(prefix);
1873     ///     // more_efficient_algorithm_for_aligned_shorts(shorts);
1874     ///     // less_efficient_algorithm_for_bytes(suffix);
1875     /// }
1876     /// ```
1877     #[stable(feature = "slice_align_to", since = "1.30.0")]
1878     pub unsafe fn align_to_mut<U>(&mut self) -> (&mut [T], &mut [U], &mut [T]) {
1879         // Note that most of this function will be constant-evaluated,
1880         if ::mem::size_of::<U>() == 0 || ::mem::size_of::<T>() == 0 {
1881             // handle ZSTs specially, which is – don't handle them at all.
1882             return (self, &mut [], &mut []);
1883         }
1884
1885         // First, find at what point do we split between the first and 2nd slice. Easy with
1886         // ptr.align_offset.
1887         let ptr = self.as_ptr();
1888         let offset = ::ptr::align_offset(ptr, ::mem::align_of::<U>());
1889         if offset > self.len() {
1890             (self, &mut [], &mut [])
1891         } else {
1892             let (left, rest) = self.split_at_mut(offset);
1893             // now `rest` is definitely aligned, so `from_raw_parts_mut` below is okay
1894             let (us_len, ts_len) = rest.align_to_offsets::<U>();
1895             let mut_ptr = rest.as_mut_ptr();
1896             (left,
1897              from_raw_parts_mut(mut_ptr as *mut U, us_len),
1898              from_raw_parts_mut(mut_ptr.add(rest.len() - ts_len), ts_len))
1899         }
1900     }
1901 }
1902
1903 #[lang = "slice_u8"]
1904 #[cfg(not(test))]
1905 impl [u8] {
1906     /// Checks if all bytes in this slice are within the ASCII range.
1907     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
1908     #[inline]
1909     pub fn is_ascii(&self) -> bool {
1910         self.iter().all(|b| b.is_ascii())
1911     }
1912
1913     /// Checks that two slices are an ASCII case-insensitive match.
1914     ///
1915     /// Same as `to_ascii_lowercase(a) == to_ascii_lowercase(b)`,
1916     /// but without allocating and copying temporaries.
1917     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
1918     #[inline]
1919     pub fn eq_ignore_ascii_case(&self, other: &[u8]) -> bool {
1920         self.len() == other.len() &&
1921             self.iter().zip(other).all(|(a, b)| {
1922                 a.eq_ignore_ascii_case(b)
1923             })
1924     }
1925
1926     /// Converts this slice to its ASCII upper case equivalent in-place.
1927     ///
1928     /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
1929     /// but non-ASCII letters are unchanged.
1930     ///
1931     /// To return a new uppercased value without modifying the existing one, use
1932     /// [`to_ascii_uppercase`].
1933     ///
1934     /// [`to_ascii_uppercase`]: #method.to_ascii_uppercase
1935     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
1936     #[inline]
1937     pub fn make_ascii_uppercase(&mut self) {
1938         for byte in self {
1939             byte.make_ascii_uppercase();
1940         }
1941     }
1942
1943     /// Converts this slice to its ASCII lower case equivalent in-place.
1944     ///
1945     /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
1946     /// but non-ASCII letters are unchanged.
1947     ///
1948     /// To return a new lowercased value without modifying the existing one, use
1949     /// [`to_ascii_lowercase`].
1950     ///
1951     /// [`to_ascii_lowercase`]: #method.to_ascii_lowercase
1952     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
1953     #[inline]
1954     pub fn make_ascii_lowercase(&mut self) {
1955         for byte in self {
1956             byte.make_ascii_lowercase();
1957         }
1958     }
1959
1960 }
1961
1962 #[stable(feature = "rust1", since = "1.0.0")]
1963 #[rustc_on_unimplemented = "slice indices are of type `usize` or ranges of `usize`"]
1964 impl<T, I> ops::Index<I> for [T]
1965     where I: SliceIndex<[T]>
1966 {
1967     type Output = I::Output;
1968
1969     #[inline]
1970     fn index(&self, index: I) -> &I::Output {
1971         index.index(self)
1972     }
1973 }
1974
1975 #[stable(feature = "rust1", since = "1.0.0")]
1976 #[rustc_on_unimplemented = "slice indices are of type `usize` or ranges of `usize`"]
1977 impl<T, I> ops::IndexMut<I> for [T]
1978     where I: SliceIndex<[T]>
1979 {
1980     #[inline]
1981     fn index_mut(&mut self, index: I) -> &mut I::Output {
1982         index.index_mut(self)
1983     }
1984 }
1985
1986 #[inline(never)]
1987 #[cold]
1988 fn slice_index_len_fail(index: usize, len: usize) -> ! {
1989     panic!("index {} out of range for slice of length {}", index, len);
1990 }
1991
1992 #[inline(never)]
1993 #[cold]
1994 fn slice_index_order_fail(index: usize, end: usize) -> ! {
1995     panic!("slice index starts at {} but ends at {}", index, end);
1996 }
1997
1998 #[inline(never)]
1999 #[cold]
2000 fn slice_index_overflow_fail() -> ! {
2001     panic!("attempted to index slice up to maximum usize");
2002 }
2003
2004 mod private_slice_index {
2005     use super::ops;
2006     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2007     pub trait Sealed {}
2008
2009     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2010     impl Sealed for usize {}
2011     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2012     impl Sealed for ops::Range<usize> {}
2013     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2014     impl Sealed for ops::RangeTo<usize> {}
2015     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2016     impl Sealed for ops::RangeFrom<usize> {}
2017     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2018     impl Sealed for ops::RangeFull {}
2019     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2020     impl Sealed for ops::RangeInclusive<usize> {}
2021     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2022     impl Sealed for ops::RangeToInclusive<usize> {}
2023 }
2024
2025 /// A helper trait used for indexing operations.
2026 #[stable(feature = "slice_get_slice", since = "1.28.0")]
2027 #[rustc_on_unimplemented = "slice indices are of type `usize` or ranges of `usize`"]
2028 pub trait SliceIndex<T: ?Sized>: private_slice_index::Sealed {
2029     /// The output type returned by methods.
2030     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2031     type Output: ?Sized;
2032
2033     /// Returns a shared reference to the output at this location, if in
2034     /// bounds.
2035     #[unstable(feature = "slice_index_methods", issue = "0")]
2036     fn get(self, slice: &T) -> Option<&Self::Output>;
2037
2038     /// Returns a mutable reference to the output at this location, if in
2039     /// bounds.
2040     #[unstable(feature = "slice_index_methods", issue = "0")]
2041     fn get_mut(self, slice: &mut T) -> Option<&mut Self::Output>;
2042
2043     /// Returns a shared reference to the output at this location, without
2044     /// performing any bounds checking.
2045     #[unstable(feature = "slice_index_methods", issue = "0")]
2046     unsafe fn get_unchecked(self, slice: &T) -> &Self::Output;
2047
2048     /// Returns a mutable reference to the output at this location, without
2049     /// performing any bounds checking.
2050     #[unstable(feature = "slice_index_methods", issue = "0")]
2051     unsafe fn get_unchecked_mut(self, slice: &mut T) -> &mut Self::Output;
2052
2053     /// Returns a shared reference to the output at this location, panicking
2054     /// if out of bounds.
2055     #[unstable(feature = "slice_index_methods", issue = "0")]
2056     fn index(self, slice: &T) -> &Self::Output;
2057
2058     /// Returns a mutable reference to the output at this location, panicking
2059     /// if out of bounds.
2060     #[unstable(feature = "slice_index_methods", issue = "0")]
2061     fn index_mut(self, slice: &mut T) -> &mut Self::Output;
2062 }
2063
2064 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2065 impl<T> SliceIndex<[T]> for usize {
2066     type Output = T;
2067
2068     #[inline]
2069     fn get(self, slice: &[T]) -> Option<&T> {
2070         if self < slice.len() {
2071             unsafe {
2072                 Some(self.get_unchecked(slice))
2073             }
2074         } else {
2075             None
2076         }
2077     }
2078
2079     #[inline]
2080     fn get_mut(self, slice: &mut [T]) -> Option<&mut T> {
2081         if self < slice.len() {
2082             unsafe {
2083                 Some(self.get_unchecked_mut(slice))
2084             }
2085         } else {
2086             None
2087         }
2088     }
2089
2090     #[inline]
2091     unsafe fn get_unchecked(self, slice: &[T]) -> &T {
2092         &*slice.as_ptr().add(self)
2093     }
2094
2095     #[inline]
2096     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut T {
2097         &mut *slice.as_mut_ptr().add(self)
2098     }
2099
2100     #[inline]
2101     fn index(self, slice: &[T]) -> &T {
2102         // NB: use intrinsic indexing
2103         &(*slice)[self]
2104     }
2105
2106     #[inline]
2107     fn index_mut(self, slice: &mut [T]) -> &mut T {
2108         // NB: use intrinsic indexing
2109         &mut (*slice)[self]
2110     }
2111 }
2112
2113 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2114 impl<T> SliceIndex<[T]> for  ops::Range<usize> {
2115     type Output = [T];
2116
2117     #[inline]
2118     fn get(self, slice: &[T]) -> Option<&[T]> {
2119         if self.start > self.end || self.end > slice.len() {
2120             None
2121         } else {
2122             unsafe {
2123                 Some(self.get_unchecked(slice))
2124             }
2125         }
2126     }
2127
2128     #[inline]
2129     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2130         if self.start > self.end || self.end > slice.len() {
2131             None
2132         } else {
2133             unsafe {
2134                 Some(self.get_unchecked_mut(slice))
2135             }
2136         }
2137     }
2138
2139     #[inline]
2140     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2141         from_raw_parts(slice.as_ptr().add(self.start), self.end - self.start)
2142     }
2143
2144     #[inline]
2145     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2146         from_raw_parts_mut(slice.as_mut_ptr().add(self.start), self.end - self.start)
2147     }
2148
2149     #[inline]
2150     fn index(self, slice: &[T]) -> &[T] {
2151         if self.start > self.end {
2152             slice_index_order_fail(self.start, self.end);
2153         } else if self.end > slice.len() {
2154             slice_index_len_fail(self.end, slice.len());
2155         }
2156         unsafe {
2157             self.get_unchecked(slice)
2158         }
2159     }
2160
2161     #[inline]
2162     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2163         if self.start > self.end {
2164             slice_index_order_fail(self.start, self.end);
2165         } else if self.end > slice.len() {
2166             slice_index_len_fail(self.end, slice.len());
2167         }
2168         unsafe {
2169             self.get_unchecked_mut(slice)
2170         }
2171     }
2172 }
2173
2174 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2175 impl<T> SliceIndex<[T]> for ops::RangeTo<usize> {
2176     type Output = [T];
2177
2178     #[inline]
2179     fn get(self, slice: &[T]) -> Option<&[T]> {
2180         (0..self.end).get(slice)
2181     }
2182
2183     #[inline]
2184     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2185         (0..self.end).get_mut(slice)
2186     }
2187
2188     #[inline]
2189     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2190         (0..self.end).get_unchecked(slice)
2191     }
2192
2193     #[inline]
2194     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2195         (0..self.end).get_unchecked_mut(slice)
2196     }
2197
2198     #[inline]
2199     fn index(self, slice: &[T]) -> &[T] {
2200         (0..self.end).index(slice)
2201     }
2202
2203     #[inline]
2204     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2205         (0..self.end).index_mut(slice)
2206     }
2207 }
2208
2209 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2210 impl<T> SliceIndex<[T]> for ops::RangeFrom<usize> {
2211     type Output = [T];
2212
2213     #[inline]
2214     fn get(self, slice: &[T]) -> Option<&[T]> {
2215         (self.start..slice.len()).get(slice)
2216     }
2217
2218     #[inline]
2219     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2220         (self.start..slice.len()).get_mut(slice)
2221     }
2222
2223     #[inline]
2224     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2225         (self.start..slice.len()).get_unchecked(slice)
2226     }
2227
2228     #[inline]
2229     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2230         (self.start..slice.len()).get_unchecked_mut(slice)
2231     }
2232
2233     #[inline]
2234     fn index(self, slice: &[T]) -> &[T] {
2235         (self.start..slice.len()).index(slice)
2236     }
2237
2238     #[inline]
2239     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2240         (self.start..slice.len()).index_mut(slice)
2241     }
2242 }
2243
2244 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2245 impl<T> SliceIndex<[T]> for ops::RangeFull {
2246     type Output = [T];
2247
2248     #[inline]
2249     fn get(self, slice: &[T]) -> Option<&[T]> {
2250         Some(slice)
2251     }
2252
2253     #[inline]
2254     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2255         Some(slice)
2256     }
2257
2258     #[inline]
2259     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2260         slice
2261     }
2262
2263     #[inline]
2264     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2265         slice
2266     }
2267
2268     #[inline]
2269     fn index(self, slice: &[T]) -> &[T] {
2270         slice
2271     }
2272
2273     #[inline]
2274     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2275         slice
2276     }
2277 }
2278
2279
2280 #[stable(feature = "inclusive_range", since = "1.26.0")]
2281 impl<T> SliceIndex<[T]> for ops::RangeInclusive<usize> {
2282     type Output = [T];
2283
2284     #[inline]
2285     fn get(self, slice: &[T]) -> Option<&[T]> {
2286         if *self.end() == usize::max_value() { None }
2287         else { (*self.start()..self.end() + 1).get(slice) }
2288     }
2289
2290     #[inline]
2291     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2292         if *self.end() == usize::max_value() { None }
2293         else { (*self.start()..self.end() + 1).get_mut(slice) }
2294     }
2295
2296     #[inline]
2297     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2298         (*self.start()..self.end() + 1).get_unchecked(slice)
2299     }
2300
2301     #[inline]
2302     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2303         (*self.start()..self.end() + 1).get_unchecked_mut(slice)
2304     }
2305
2306     #[inline]
2307     fn index(self, slice: &[T]) -> &[T] {
2308         if *self.end() == usize::max_value() { slice_index_overflow_fail(); }
2309         (*self.start()..self.end() + 1).index(slice)
2310     }
2311
2312     #[inline]
2313     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2314         if *self.end() == usize::max_value() { slice_index_overflow_fail(); }
2315         (*self.start()..self.end() + 1).index_mut(slice)
2316     }
2317 }
2318
2319 #[stable(feature = "inclusive_range", since = "1.26.0")]
2320 impl<T> SliceIndex<[T]> for ops::RangeToInclusive<usize> {
2321     type Output = [T];
2322
2323     #[inline]
2324     fn get(self, slice: &[T]) -> Option<&[T]> {
2325         (0..=self.end).get(slice)
2326     }
2327
2328     #[inline]
2329     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2330         (0..=self.end).get_mut(slice)
2331     }
2332
2333     #[inline]
2334     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2335         (0..=self.end).get_unchecked(slice)
2336     }
2337
2338     #[inline]
2339     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2340         (0..=self.end).get_unchecked_mut(slice)
2341     }
2342
2343     #[inline]
2344     fn index(self, slice: &[T]) -> &[T] {
2345         (0..=self.end).index(slice)
2346     }
2347
2348     #[inline]
2349     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2350         (0..=self.end).index_mut(slice)
2351     }
2352 }
2353
2354 ////////////////////////////////////////////////////////////////////////////////
2355 // Common traits
2356 ////////////////////////////////////////////////////////////////////////////////
2357
2358 #[stable(feature = "rust1", since = "1.0.0")]
2359 impl<'a, T> Default for &'a [T] {
2360     /// Creates an empty slice.
2361     fn default() -> &'a [T] { &[] }
2362 }
2363
2364 #[stable(feature = "mut_slice_default", since = "1.5.0")]
2365 impl<'a, T> Default for &'a mut [T] {
2366     /// Creates a mutable empty slice.
2367     fn default() -> &'a mut [T] { &mut [] }
2368 }
2369
2370 //
2371 // Iterators
2372 //
2373
2374 #[stable(feature = "rust1", since = "1.0.0")]
2375 impl<'a, T> IntoIterator for &'a [T] {
2376     type Item = &'a T;
2377     type IntoIter = Iter<'a, T>;
2378
2379     fn into_iter(self) -> Iter<'a, T> {
2380         self.iter()
2381     }
2382 }
2383
2384 #[stable(feature = "rust1", since = "1.0.0")]
2385 impl<'a, T> IntoIterator for &'a mut [T] {
2386     type Item = &'a mut T;
2387     type IntoIter = IterMut<'a, T>;
2388
2389     fn into_iter(self) -> IterMut<'a, T> {
2390         self.iter_mut()
2391     }
2392 }
2393
2394 // Macro helper functions
2395 #[inline(always)]
2396 fn size_from_ptr<T>(_: *const T) -> usize {
2397     mem::size_of::<T>()
2398 }
2399
2400 // Inlining is_empty and len makes a huge performance difference
2401 macro_rules! is_empty {
2402     // The way we encode the length of a ZST iterator, this works both for ZST
2403     // and non-ZST.
2404     ($self: ident) => {$self.ptr == $self.end}
2405 }
2406 // To get rid of some bounds checks (see `position`), we compute the length in a somewhat
2407 // unexpected way. (Tested by `codegen/slice-position-bounds-check`.)
2408 macro_rules! len {
2409     ($self: ident) => {{
2410         let start = $self.ptr;
2411         let diff = ($self.end as usize).wrapping_sub(start as usize);
2412         let size = size_from_ptr(start);
2413         if size == 0 {
2414             diff
2415         } else {
2416             // Using division instead of `offset_from` helps LLVM remove bounds checks
2417             diff / size
2418         }
2419     }}
2420 }
2421
2422 // The shared definition of the `Iter` and `IterMut` iterators
2423 macro_rules! iterator {
2424     (struct $name:ident -> $ptr:ty, $elem:ty, $raw_mut:tt, $( $mut_:tt )*) => {
2425         impl<'a, T> $name<'a, T> {
2426             // Helper function for creating a slice from the iterator.
2427             #[inline(always)]
2428             fn make_slice(&self) -> &'a [T] {
2429                 unsafe { from_raw_parts(self.ptr, len!(self)) }
2430             }
2431
2432             // Helper function for moving the start of the iterator forwards by `offset` elements,
2433             // returning the old start.
2434             // Unsafe because the offset must be in-bounds or one-past-the-end.
2435             #[inline(always)]
2436             unsafe fn post_inc_start(&mut self, offset: isize) -> * $raw_mut T {
2437                 if mem::size_of::<T>() == 0 {
2438                     // This is *reducing* the length.  `ptr` never changes with ZST.
2439                     self.end = (self.end as * $raw_mut u8).wrapping_offset(-offset) as * $raw_mut T;
2440                     self.ptr
2441                 } else {
2442                     let old = self.ptr;
2443                     self.ptr = self.ptr.offset(offset);
2444                     old
2445                 }
2446             }
2447
2448             // Helper function for moving the end of the iterator backwards by `offset` elements,
2449             // returning the new end.
2450             // Unsafe because the offset must be in-bounds or one-past-the-end.
2451             #[inline(always)]
2452             unsafe fn pre_dec_end(&mut self, offset: isize) -> * $raw_mut T {
2453                 if mem::size_of::<T>() == 0 {
2454                     self.end = (self.end as * $raw_mut u8).wrapping_offset(-offset) as * $raw_mut T;
2455                     self.ptr
2456                 } else {
2457                     self.end = self.end.offset(-offset);
2458                     self.end
2459                 }
2460             }
2461         }
2462
2463         #[stable(feature = "rust1", since = "1.0.0")]
2464         impl<'a, T> ExactSizeIterator for $name<'a, T> {
2465             #[inline(always)]
2466             fn len(&self) -> usize {
2467                 len!(self)
2468             }
2469
2470             #[inline(always)]
2471             fn is_empty(&self) -> bool {
2472                 is_empty!(self)
2473             }
2474         }
2475
2476         #[stable(feature = "rust1", since = "1.0.0")]
2477         impl<'a, T> Iterator for $name<'a, T> {
2478             type Item = $elem;
2479
2480             #[inline]
2481             fn next(&mut self) -> Option<$elem> {
2482                 // could be implemented with slices, but this avoids bounds checks
2483                 unsafe {
2484                     assume(!self.ptr.is_null());
2485                     if mem::size_of::<T>() != 0 {
2486                         assume(!self.end.is_null());
2487                     }
2488                     if is_empty!(self) {
2489                         None
2490                     } else {
2491                         Some(& $( $mut_ )* *self.post_inc_start(1))
2492                     }
2493                 }
2494             }
2495
2496             #[inline]
2497             fn size_hint(&self) -> (usize, Option<usize>) {
2498                 let exact = len!(self);
2499                 (exact, Some(exact))
2500             }
2501
2502             #[inline]
2503             fn count(self) -> usize {
2504                 len!(self)
2505             }
2506
2507             #[inline]
2508             fn nth(&mut self, n: usize) -> Option<$elem> {
2509                 if n >= len!(self) {
2510                     // This iterator is now empty.
2511                     if mem::size_of::<T>() == 0 {
2512                         // We have to do it this way as `ptr` may never be 0, but `end`
2513                         // could be (due to wrapping).
2514                         self.end = self.ptr;
2515                     } else {
2516                         self.ptr = self.end;
2517                     }
2518                     return None;
2519                 }
2520                 // We are in bounds. `offset` does the right thing even for ZSTs.
2521                 unsafe {
2522                     let elem = Some(& $( $mut_ )* *self.ptr.add(n));
2523                     self.post_inc_start((n as isize).wrapping_add(1));
2524                     elem
2525                 }
2526             }
2527
2528             #[inline]
2529             fn last(mut self) -> Option<$elem> {
2530                 self.next_back()
2531             }
2532
2533             #[inline]
2534             fn try_fold<B, F, R>(&mut self, init: B, mut f: F) -> R where
2535                 Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Ok=B>
2536             {
2537                 // manual unrolling is needed when there are conditional exits from the loop
2538                 let mut accum = init;
2539                 unsafe {
2540                     while len!(self) >= 4 {
2541                         accum = f(accum, & $( $mut_ )* *self.post_inc_start(1))?;
2542                         accum = f(accum, & $( $mut_ )* *self.post_inc_start(1))?;
2543                         accum = f(accum, & $( $mut_ )* *self.post_inc_start(1))?;
2544                         accum = f(accum, & $( $mut_ )* *self.post_inc_start(1))?;
2545                     }
2546                     while !is_empty!(self) {
2547                         accum = f(accum, & $( $mut_ )* *self.post_inc_start(1))?;
2548                     }
2549                 }
2550                 Try::from_ok(accum)
2551             }
2552
2553             #[inline]
2554             fn fold<Acc, Fold>(mut self, init: Acc, mut f: Fold) -> Acc
2555                 where Fold: FnMut(Acc, Self::Item) -> Acc,
2556             {
2557                 // Let LLVM unroll this, rather than using the default
2558                 // impl that would force the manual unrolling above
2559                 let mut accum = init;
2560                 while let Some(x) = self.next() {
2561                     accum = f(accum, x);
2562                 }
2563                 accum
2564             }
2565
2566             #[inline]
2567             #[rustc_inherit_overflow_checks]
2568             fn position<P>(&mut self, mut predicate: P) -> Option<usize> where
2569                 Self: Sized,
2570                 P: FnMut(Self::Item) -> bool,
2571             {
2572                 // The addition might panic on overflow.
2573                 let n = len!(self);
2574                 self.try_fold(0, move |i, x| {
2575                     if predicate(x) { Err(i) }
2576                     else { Ok(i + 1) }
2577                 }).err()
2578                     .map(|i| {
2579                         unsafe { assume(i < n) };
2580                         i
2581                     })
2582             }
2583
2584             #[inline]
2585             fn rposition<P>(&mut self, mut predicate: P) -> Option<usize> where
2586                 P: FnMut(Self::Item) -> bool,
2587                 Self: Sized + ExactSizeIterator + DoubleEndedIterator
2588             {
2589                 // No need for an overflow check here, because `ExactSizeIterator`
2590                 let n = len!(self);
2591                 self.try_rfold(n, move |i, x| {
2592                     let i = i - 1;
2593                     if predicate(x) { Err(i) }
2594                     else { Ok(i) }
2595                 }).err()
2596                     .map(|i| {
2597                         unsafe { assume(i < n) };
2598                         i
2599                     })
2600             }
2601         }
2602
2603         #[stable(feature = "rust1", since = "1.0.0")]
2604         impl<'a, T> DoubleEndedIterator for $name<'a, T> {
2605             #[inline]
2606             fn next_back(&mut self) -> Option<$elem> {
2607                 // could be implemented with slices, but this avoids bounds checks
2608                 unsafe {
2609                     assume(!self.ptr.is_null());
2610                     if mem::size_of::<T>() != 0 {
2611                         assume(!self.end.is_null());
2612                     }
2613                     if is_empty!(self) {
2614                         None
2615                     } else {
2616                         Some(& $( $mut_ )* *self.pre_dec_end(1))
2617                     }
2618                 }
2619             }
2620
2621             #[inline]
2622             fn try_rfold<B, F, R>(&mut self, init: B, mut f: F) -> R where
2623                 Self: Sized, F: FnMut(B, Self::Item) -> R, R: Try<Ok=B>
2624             {
2625                 // manual unrolling is needed when there are conditional exits from the loop
2626                 let mut accum = init;
2627                 unsafe {
2628                     while len!(self) >= 4 {
2629                         accum = f(accum, & $( $mut_ )* *self.pre_dec_end(1))?;
2630                         accum = f(accum, & $( $mut_ )* *self.pre_dec_end(1))?;
2631                         accum = f(accum, & $( $mut_ )* *self.pre_dec_end(1))?;
2632                         accum = f(accum, & $( $mut_ )* *self.pre_dec_end(1))?;
2633                     }
2634                     // inlining is_empty everywhere makes a huge performance difference
2635                     while !is_empty!(self) {
2636                         accum = f(accum, & $( $mut_ )* *self.pre_dec_end(1))?;
2637                     }
2638                 }
2639                 Try::from_ok(accum)
2640             }
2641
2642             #[inline]
2643             fn rfold<Acc, Fold>(mut self, init: Acc, mut f: Fold) -> Acc
2644                 where Fold: FnMut(Acc, Self::Item) -> Acc,
2645             {
2646                 // Let LLVM unroll this, rather than using the default
2647                 // impl that would force the manual unrolling above
2648                 let mut accum = init;
2649                 while let Some(x) = self.next_back() {
2650                     accum = f(accum, x);
2651                 }
2652                 accum
2653             }
2654         }
2655
2656         #[stable(feature = "fused", since = "1.26.0")]
2657         impl<'a, T> FusedIterator for $name<'a, T> {}
2658
2659         #[unstable(feature = "trusted_len", issue = "37572")]
2660         unsafe impl<'a, T> TrustedLen for $name<'a, T> {}
2661     }
2662 }
2663
2664 /// Immutable slice iterator
2665 ///
2666 /// This struct is created by the [`iter`] method on [slices].
2667 ///
2668 /// # Examples
2669 ///
2670 /// Basic usage:
2671 ///
2672 /// ```
2673 /// // First, we declare a type which has `iter` method to get the `Iter` struct (&[usize here]):
2674 /// let slice = &[1, 2, 3];
2675 ///
2676 /// // Then, we iterate over it:
2677 /// for element in slice.iter() {
2678 ///     println!("{}", element);
2679 /// }
2680 /// ```
2681 ///
2682 /// [`iter`]: ../../std/primitive.slice.html#method.iter
2683 /// [slices]: ../../std/primitive.slice.html
2684 #[stable(feature = "rust1", since = "1.0.0")]
2685 pub struct Iter<'a, T: 'a> {
2686     ptr: *const T,
2687     end: *const T, // If T is a ZST, this is actually ptr+len.  This encoding is picked so that
2688                    // ptr == end is a quick test for the Iterator being empty, that works
2689                    // for both ZST and non-ZST.
2690     _marker: marker::PhantomData<&'a T>,
2691 }
2692
2693 #[stable(feature = "core_impl_debug", since = "1.9.0")]
2694 impl<'a, T: 'a + fmt::Debug> fmt::Debug for Iter<'a, T> {
2695     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2696         f.debug_tuple("Iter")
2697             .field(&self.as_slice())
2698             .finish()
2699     }
2700 }
2701
2702 #[stable(feature = "rust1", since = "1.0.0")]
2703 unsafe impl<'a, T: Sync> Sync for Iter<'a, T> {}
2704 #[stable(feature = "rust1", since = "1.0.0")]
2705 unsafe impl<'a, T: Sync> Send for Iter<'a, T> {}
2706
2707 impl<'a, T> Iter<'a, T> {
2708     /// View the underlying data as a subslice of the original data.
2709     ///
2710     /// This has the same lifetime as the original slice, and so the
2711     /// iterator can continue to be used while this exists.
2712     ///
2713     /// # Examples
2714     ///
2715     /// Basic usage:
2716     ///
2717     /// ```
2718     /// // First, we declare a type which has the `iter` method to get the `Iter`
2719     /// // struct (&[usize here]):
2720     /// let slice = &[1, 2, 3];
2721     ///
2722     /// // Then, we get the iterator:
2723     /// let mut iter = slice.iter();
2724     /// // So if we print what `as_slice` method returns here, we have "[1, 2, 3]":
2725     /// println!("{:?}", iter.as_slice());
2726     ///
2727     /// // Next, we move to the second element of the slice:
2728     /// iter.next();
2729     /// // Now `as_slice` returns "[2, 3]":
2730     /// println!("{:?}", iter.as_slice());
2731     /// ```
2732     #[stable(feature = "iter_to_slice", since = "1.4.0")]
2733     pub fn as_slice(&self) -> &'a [T] {
2734         self.make_slice()
2735     }
2736 }
2737
2738 iterator!{struct Iter -> *const T, &'a T, const, /* no mut */}
2739
2740 #[stable(feature = "rust1", since = "1.0.0")]
2741 impl<'a, T> Clone for Iter<'a, T> {
2742     fn clone(&self) -> Iter<'a, T> { Iter { ptr: self.ptr, end: self.end, _marker: self._marker } }
2743 }
2744
2745 #[stable(feature = "slice_iter_as_ref", since = "1.13.0")]
2746 impl<'a, T> AsRef<[T]> for Iter<'a, T> {
2747     fn as_ref(&self) -> &[T] {
2748         self.as_slice()
2749     }
2750 }
2751
2752 /// Mutable slice iterator.
2753 ///
2754 /// This struct is created by the [`iter_mut`] method on [slices].
2755 ///
2756 /// # Examples
2757 ///
2758 /// Basic usage:
2759 ///
2760 /// ```
2761 /// // First, we declare a type which has `iter_mut` method to get the `IterMut`
2762 /// // struct (&[usize here]):
2763 /// let mut slice = &mut [1, 2, 3];
2764 ///
2765 /// // Then, we iterate over it and increment each element value:
2766 /// for element in slice.iter_mut() {
2767 ///     *element += 1;
2768 /// }
2769 ///
2770 /// // We now have "[2, 3, 4]":
2771 /// println!("{:?}", slice);
2772 /// ```
2773 ///
2774 /// [`iter_mut`]: ../../std/primitive.slice.html#method.iter_mut
2775 /// [slices]: ../../std/primitive.slice.html
2776 #[stable(feature = "rust1", since = "1.0.0")]
2777 pub struct IterMut<'a, T: 'a> {
2778     ptr: *mut T,
2779     end: *mut T, // If T is a ZST, this is actually ptr+len.  This encoding is picked so that
2780                  // ptr == end is a quick test for the Iterator being empty, that works
2781                  // for both ZST and non-ZST.
2782     _marker: marker::PhantomData<&'a mut T>,
2783 }
2784
2785 #[stable(feature = "core_impl_debug", since = "1.9.0")]
2786 impl<'a, T: 'a + fmt::Debug> fmt::Debug for IterMut<'a, T> {
2787     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2788         f.debug_tuple("IterMut")
2789             .field(&self.make_slice())
2790             .finish()
2791     }
2792 }
2793
2794 #[stable(feature = "rust1", since = "1.0.0")]
2795 unsafe impl<'a, T: Sync> Sync for IterMut<'a, T> {}
2796 #[stable(feature = "rust1", since = "1.0.0")]
2797 unsafe impl<'a, T: Send> Send for IterMut<'a, T> {}
2798
2799 impl<'a, T> IterMut<'a, T> {
2800     /// View the underlying data as a subslice of the original data.
2801     ///
2802     /// To avoid creating `&mut` references that alias, this is forced
2803     /// to consume the iterator.
2804     ///
2805     /// # Examples
2806     ///
2807     /// Basic usage:
2808     ///
2809     /// ```
2810     /// // First, we declare a type which has `iter_mut` method to get the `IterMut`
2811     /// // struct (&[usize here]):
2812     /// let mut slice = &mut [1, 2, 3];
2813     ///
2814     /// {
2815     ///     // Then, we get the iterator:
2816     ///     let mut iter = slice.iter_mut();
2817     ///     // We move to next element:
2818     ///     iter.next();
2819     ///     // So if we print what `into_slice` method returns here, we have "[2, 3]":
2820     ///     println!("{:?}", iter.into_slice());
2821     /// }
2822     ///
2823     /// // Now let's modify a value of the slice:
2824     /// {
2825     ///     // First we get back the iterator:
2826     ///     let mut iter = slice.iter_mut();
2827     ///     // We change the value of the first element of the slice returned by the `next` method:
2828     ///     *iter.next().unwrap() += 1;
2829     /// }
2830     /// // Now slice is "[2, 2, 3]":
2831     /// println!("{:?}", slice);
2832     /// ```
2833     #[stable(feature = "iter_to_slice", since = "1.4.0")]
2834     pub fn into_slice(self) -> &'a mut [T] {
2835         unsafe { from_raw_parts_mut(self.ptr, len!(self)) }
2836     }
2837 }
2838
2839 iterator!{struct IterMut -> *mut T, &'a mut T, mut, mut}
2840
2841 /// An internal abstraction over the splitting iterators, so that
2842 /// splitn, splitn_mut etc can be implemented once.
2843 #[doc(hidden)]
2844 trait SplitIter: DoubleEndedIterator {
2845     /// Marks the underlying iterator as complete, extracting the remaining
2846     /// portion of the slice.
2847     fn finish(&mut self) -> Option<Self::Item>;
2848 }
2849
2850 /// An iterator over subslices separated by elements that match a predicate
2851 /// function.
2852 ///
2853 /// This struct is created by the [`split`] method on [slices].
2854 ///
2855 /// [`split`]: ../../std/primitive.slice.html#method.split
2856 /// [slices]: ../../std/primitive.slice.html
2857 #[stable(feature = "rust1", since = "1.0.0")]
2858 pub struct Split<'a, T:'a, P> where P: FnMut(&T) -> bool {
2859     v: &'a [T],
2860     pred: P,
2861     finished: bool
2862 }
2863
2864 #[stable(feature = "core_impl_debug", since = "1.9.0")]
2865 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for Split<'a, T, P> where P: FnMut(&T) -> bool {
2866     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2867         f.debug_struct("Split")
2868             .field("v", &self.v)
2869             .field("finished", &self.finished)
2870             .finish()
2871     }
2872 }
2873
2874 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
2875 #[stable(feature = "rust1", since = "1.0.0")]
2876 impl<'a, T, P> Clone for Split<'a, T, P> where P: Clone + FnMut(&T) -> bool {
2877     fn clone(&self) -> Split<'a, T, P> {
2878         Split {
2879             v: self.v,
2880             pred: self.pred.clone(),
2881             finished: self.finished,
2882         }
2883     }
2884 }
2885
2886 #[stable(feature = "rust1", since = "1.0.0")]
2887 impl<'a, T, P> Iterator for Split<'a, T, P> where P: FnMut(&T) -> bool {
2888     type Item = &'a [T];
2889
2890     #[inline]
2891     fn next(&mut self) -> Option<&'a [T]> {
2892         if self.finished { return None; }
2893
2894         match self.v.iter().position(|x| (self.pred)(x)) {
2895             None => self.finish(),
2896             Some(idx) => {
2897                 let ret = Some(&self.v[..idx]);
2898                 self.v = &self.v[idx + 1..];
2899                 ret
2900             }
2901         }
2902     }
2903
2904     #[inline]
2905     fn size_hint(&self) -> (usize, Option<usize>) {
2906         if self.finished {
2907             (0, Some(0))
2908         } else {
2909             (1, Some(self.v.len() + 1))
2910         }
2911     }
2912 }
2913
2914 #[stable(feature = "rust1", since = "1.0.0")]
2915 impl<'a, T, P> DoubleEndedIterator for Split<'a, T, P> where P: FnMut(&T) -> bool {
2916     #[inline]
2917     fn next_back(&mut self) -> Option<&'a [T]> {
2918         if self.finished { return None; }
2919
2920         match self.v.iter().rposition(|x| (self.pred)(x)) {
2921             None => self.finish(),
2922             Some(idx) => {
2923                 let ret = Some(&self.v[idx + 1..]);
2924                 self.v = &self.v[..idx];
2925                 ret
2926             }
2927         }
2928     }
2929 }
2930
2931 impl<'a, T, P> SplitIter for Split<'a, T, P> where P: FnMut(&T) -> bool {
2932     #[inline]
2933     fn finish(&mut self) -> Option<&'a [T]> {
2934         if self.finished { None } else { self.finished = true; Some(self.v) }
2935     }
2936 }
2937
2938 #[stable(feature = "fused", since = "1.26.0")]
2939 impl<'a, T, P> FusedIterator for Split<'a, T, P> where P: FnMut(&T) -> bool {}
2940
2941 /// An iterator over the subslices of the vector which are separated
2942 /// by elements that match `pred`.
2943 ///
2944 /// This struct is created by the [`split_mut`] method on [slices].
2945 ///
2946 /// [`split_mut`]: ../../std/primitive.slice.html#method.split_mut
2947 /// [slices]: ../../std/primitive.slice.html
2948 #[stable(feature = "rust1", since = "1.0.0")]
2949 pub struct SplitMut<'a, T:'a, P> where P: FnMut(&T) -> bool {
2950     v: &'a mut [T],
2951     pred: P,
2952     finished: bool
2953 }
2954
2955 #[stable(feature = "core_impl_debug", since = "1.9.0")]
2956 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for SplitMut<'a, T, P> where P: FnMut(&T) -> bool {
2957     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
2958         f.debug_struct("SplitMut")
2959             .field("v", &self.v)
2960             .field("finished", &self.finished)
2961             .finish()
2962     }
2963 }
2964
2965 impl<'a, T, P> SplitIter for SplitMut<'a, T, P> where P: FnMut(&T) -> bool {
2966     #[inline]
2967     fn finish(&mut self) -> Option<&'a mut [T]> {
2968         if self.finished {
2969             None
2970         } else {
2971             self.finished = true;
2972             Some(mem::replace(&mut self.v, &mut []))
2973         }
2974     }
2975 }
2976
2977 #[stable(feature = "rust1", since = "1.0.0")]
2978 impl<'a, T, P> Iterator for SplitMut<'a, T, P> where P: FnMut(&T) -> bool {
2979     type Item = &'a mut [T];
2980
2981     #[inline]
2982     fn next(&mut self) -> Option<&'a mut [T]> {
2983         if self.finished { return None; }
2984
2985         let idx_opt = { // work around borrowck limitations
2986             let pred = &mut self.pred;
2987             self.v.iter().position(|x| (*pred)(x))
2988         };
2989         match idx_opt {
2990             None => self.finish(),
2991             Some(idx) => {
2992                 let tmp = mem::replace(&mut self.v, &mut []);
2993                 let (head, tail) = tmp.split_at_mut(idx);
2994                 self.v = &mut tail[1..];
2995                 Some(head)
2996             }
2997         }
2998     }
2999
3000     #[inline]
3001     fn size_hint(&self) -> (usize, Option<usize>) {
3002         if self.finished {
3003             (0, Some(0))
3004         } else {
3005             // if the predicate doesn't match anything, we yield one slice
3006             // if it matches every element, we yield len+1 empty slices.
3007             (1, Some(self.v.len() + 1))
3008         }
3009     }
3010 }
3011
3012 #[stable(feature = "rust1", since = "1.0.0")]
3013 impl<'a, T, P> DoubleEndedIterator for SplitMut<'a, T, P> where
3014     P: FnMut(&T) -> bool,
3015 {
3016     #[inline]
3017     fn next_back(&mut self) -> Option<&'a mut [T]> {
3018         if self.finished { return None; }
3019
3020         let idx_opt = { // work around borrowck limitations
3021             let pred = &mut self.pred;
3022             self.v.iter().rposition(|x| (*pred)(x))
3023         };
3024         match idx_opt {
3025             None => self.finish(),
3026             Some(idx) => {
3027                 let tmp = mem::replace(&mut self.v, &mut []);
3028                 let (head, tail) = tmp.split_at_mut(idx);
3029                 self.v = head;
3030                 Some(&mut tail[1..])
3031             }
3032         }
3033     }
3034 }
3035
3036 #[stable(feature = "fused", since = "1.26.0")]
3037 impl<'a, T, P> FusedIterator for SplitMut<'a, T, P> where P: FnMut(&T) -> bool {}
3038
3039 /// An iterator over subslices separated by elements that match a predicate
3040 /// function, starting from the end of the slice.
3041 ///
3042 /// This struct is created by the [`rsplit`] method on [slices].
3043 ///
3044 /// [`rsplit`]: ../../std/primitive.slice.html#method.rsplit
3045 /// [slices]: ../../std/primitive.slice.html
3046 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3047 #[derive(Clone)] // Is this correct, or does it incorrectly require `T: Clone`?
3048 pub struct RSplit<'a, T:'a, P> where P: FnMut(&T) -> bool {
3049     inner: Split<'a, T, P>
3050 }
3051
3052 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3053 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for RSplit<'a, T, P> where P: FnMut(&T) -> bool {
3054     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3055         f.debug_struct("RSplit")
3056             .field("v", &self.inner.v)
3057             .field("finished", &self.inner.finished)
3058             .finish()
3059     }
3060 }
3061
3062 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3063 impl<'a, T, P> Iterator for RSplit<'a, T, P> where P: FnMut(&T) -> bool {
3064     type Item = &'a [T];
3065
3066     #[inline]
3067     fn next(&mut self) -> Option<&'a [T]> {
3068         self.inner.next_back()
3069     }
3070
3071     #[inline]
3072     fn size_hint(&self) -> (usize, Option<usize>) {
3073         self.inner.size_hint()
3074     }
3075 }
3076
3077 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3078 impl<'a, T, P> DoubleEndedIterator for RSplit<'a, T, P> where P: FnMut(&T) -> bool {
3079     #[inline]
3080     fn next_back(&mut self) -> Option<&'a [T]> {
3081         self.inner.next()
3082     }
3083 }
3084
3085 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3086 impl<'a, T, P> SplitIter for RSplit<'a, T, P> where P: FnMut(&T) -> bool {
3087     #[inline]
3088     fn finish(&mut self) -> Option<&'a [T]> {
3089         self.inner.finish()
3090     }
3091 }
3092
3093 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3094 impl<'a, T, P> FusedIterator for RSplit<'a, T, P> where P: FnMut(&T) -> bool {}
3095
3096 /// An iterator over the subslices of the vector which are separated
3097 /// by elements that match `pred`, starting from the end of the slice.
3098 ///
3099 /// This struct is created by the [`rsplit_mut`] method on [slices].
3100 ///
3101 /// [`rsplit_mut`]: ../../std/primitive.slice.html#method.rsplit_mut
3102 /// [slices]: ../../std/primitive.slice.html
3103 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3104 pub struct RSplitMut<'a, T:'a, P> where P: FnMut(&T) -> bool {
3105     inner: SplitMut<'a, T, P>
3106 }
3107
3108 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3109 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for RSplitMut<'a, T, P> where P: FnMut(&T) -> bool {
3110     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3111         f.debug_struct("RSplitMut")
3112             .field("v", &self.inner.v)
3113             .field("finished", &self.inner.finished)
3114             .finish()
3115     }
3116 }
3117
3118 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3119 impl<'a, T, P> SplitIter for RSplitMut<'a, T, P> where P: FnMut(&T) -> bool {
3120     #[inline]
3121     fn finish(&mut self) -> Option<&'a mut [T]> {
3122         self.inner.finish()
3123     }
3124 }
3125
3126 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3127 impl<'a, T, P> Iterator for RSplitMut<'a, T, P> where P: FnMut(&T) -> bool {
3128     type Item = &'a mut [T];
3129
3130     #[inline]
3131     fn next(&mut self) -> Option<&'a mut [T]> {
3132         self.inner.next_back()
3133     }
3134
3135     #[inline]
3136     fn size_hint(&self) -> (usize, Option<usize>) {
3137         self.inner.size_hint()
3138     }
3139 }
3140
3141 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3142 impl<'a, T, P> DoubleEndedIterator for RSplitMut<'a, T, P> where
3143     P: FnMut(&T) -> bool,
3144 {
3145     #[inline]
3146     fn next_back(&mut self) -> Option<&'a mut [T]> {
3147         self.inner.next()
3148     }
3149 }
3150
3151 #[stable(feature = "slice_rsplit", since = "1.27.0")]
3152 impl<'a, T, P> FusedIterator for RSplitMut<'a, T, P> where P: FnMut(&T) -> bool {}
3153
3154 /// An private iterator over subslices separated by elements that
3155 /// match a predicate function, splitting at most a fixed number of
3156 /// times.
3157 #[derive(Debug)]
3158 struct GenericSplitN<I> {
3159     iter: I,
3160     count: usize,
3161 }
3162
3163 impl<T, I: SplitIter<Item=T>> Iterator for GenericSplitN<I> {
3164     type Item = T;
3165
3166     #[inline]
3167     fn next(&mut self) -> Option<T> {
3168         match self.count {
3169             0 => None,
3170             1 => { self.count -= 1; self.iter.finish() }
3171             _ => { self.count -= 1; self.iter.next() }
3172         }
3173     }
3174
3175     #[inline]
3176     fn size_hint(&self) -> (usize, Option<usize>) {
3177         let (lower, upper_opt) = self.iter.size_hint();
3178         (lower, upper_opt.map(|upper| cmp::min(self.count, upper)))
3179     }
3180 }
3181
3182 /// An iterator over subslices separated by elements that match a predicate
3183 /// function, limited to a given number of splits.
3184 ///
3185 /// This struct is created by the [`splitn`] method on [slices].
3186 ///
3187 /// [`splitn`]: ../../std/primitive.slice.html#method.splitn
3188 /// [slices]: ../../std/primitive.slice.html
3189 #[stable(feature = "rust1", since = "1.0.0")]
3190 pub struct SplitN<'a, T: 'a, P> where P: FnMut(&T) -> bool {
3191     inner: GenericSplitN<Split<'a, T, P>>
3192 }
3193
3194 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3195 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for SplitN<'a, T, P> where P: FnMut(&T) -> bool {
3196     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3197         f.debug_struct("SplitN")
3198             .field("inner", &self.inner)
3199             .finish()
3200     }
3201 }
3202
3203 /// An iterator over subslices separated by elements that match a
3204 /// predicate function, limited to a given number of splits, starting
3205 /// from the end of the slice.
3206 ///
3207 /// This struct is created by the [`rsplitn`] method on [slices].
3208 ///
3209 /// [`rsplitn`]: ../../std/primitive.slice.html#method.rsplitn
3210 /// [slices]: ../../std/primitive.slice.html
3211 #[stable(feature = "rust1", since = "1.0.0")]
3212 pub struct RSplitN<'a, T: 'a, P> where P: FnMut(&T) -> bool {
3213     inner: GenericSplitN<RSplit<'a, T, P>>
3214 }
3215
3216 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3217 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for RSplitN<'a, T, P> where P: FnMut(&T) -> bool {
3218     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3219         f.debug_struct("RSplitN")
3220             .field("inner", &self.inner)
3221             .finish()
3222     }
3223 }
3224
3225 /// An iterator over subslices separated by elements that match a predicate
3226 /// function, limited to a given number of splits.
3227 ///
3228 /// This struct is created by the [`splitn_mut`] method on [slices].
3229 ///
3230 /// [`splitn_mut`]: ../../std/primitive.slice.html#method.splitn_mut
3231 /// [slices]: ../../std/primitive.slice.html
3232 #[stable(feature = "rust1", since = "1.0.0")]
3233 pub struct SplitNMut<'a, T: 'a, P> where P: FnMut(&T) -> bool {
3234     inner: GenericSplitN<SplitMut<'a, T, P>>
3235 }
3236
3237 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3238 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for SplitNMut<'a, T, P> where P: FnMut(&T) -> bool {
3239     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3240         f.debug_struct("SplitNMut")
3241             .field("inner", &self.inner)
3242             .finish()
3243     }
3244 }
3245
3246 /// An iterator over subslices separated by elements that match a
3247 /// predicate function, limited to a given number of splits, starting
3248 /// from the end of the slice.
3249 ///
3250 /// This struct is created by the [`rsplitn_mut`] method on [slices].
3251 ///
3252 /// [`rsplitn_mut`]: ../../std/primitive.slice.html#method.rsplitn_mut
3253 /// [slices]: ../../std/primitive.slice.html
3254 #[stable(feature = "rust1", since = "1.0.0")]
3255 pub struct RSplitNMut<'a, T: 'a, P> where P: FnMut(&T) -> bool {
3256     inner: GenericSplitN<RSplitMut<'a, T, P>>
3257 }
3258
3259 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3260 impl<'a, T: 'a + fmt::Debug, P> fmt::Debug for RSplitNMut<'a, T, P> where P: FnMut(&T) -> bool {
3261     fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
3262         f.debug_struct("RSplitNMut")
3263             .field("inner", &self.inner)
3264             .finish()
3265     }
3266 }
3267
3268 macro_rules! forward_iterator {
3269     ($name:ident: $elem:ident, $iter_of:ty) => {
3270         #[stable(feature = "rust1", since = "1.0.0")]
3271         impl<'a, $elem, P> Iterator for $name<'a, $elem, P> where
3272             P: FnMut(&T) -> bool
3273         {
3274             type Item = $iter_of;
3275
3276             #[inline]
3277             fn next(&mut self) -> Option<$iter_of> {
3278                 self.inner.next()
3279             }
3280
3281             #[inline]
3282             fn size_hint(&self) -> (usize, Option<usize>) {
3283                 self.inner.size_hint()
3284             }
3285         }
3286
3287         #[stable(feature = "fused", since = "1.26.0")]
3288         impl<'a, $elem, P> FusedIterator for $name<'a, $elem, P>
3289             where P: FnMut(&T) -> bool {}
3290     }
3291 }
3292
3293 forward_iterator! { SplitN: T, &'a [T] }
3294 forward_iterator! { RSplitN: T, &'a [T] }
3295 forward_iterator! { SplitNMut: T, &'a mut [T] }
3296 forward_iterator! { RSplitNMut: T, &'a mut [T] }
3297
3298 /// An iterator over overlapping subslices of length `size`.
3299 ///
3300 /// This struct is created by the [`windows`] method on [slices].
3301 ///
3302 /// [`windows`]: ../../std/primitive.slice.html#method.windows
3303 /// [slices]: ../../std/primitive.slice.html
3304 #[derive(Debug)]
3305 #[stable(feature = "rust1", since = "1.0.0")]
3306 pub struct Windows<'a, T:'a> {
3307     v: &'a [T],
3308     size: usize
3309 }
3310
3311 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
3312 #[stable(feature = "rust1", since = "1.0.0")]
3313 impl<'a, T> Clone for Windows<'a, T> {
3314     fn clone(&self) -> Windows<'a, T> {
3315         Windows {
3316             v: self.v,
3317             size: self.size,
3318         }
3319     }
3320 }
3321
3322 #[stable(feature = "rust1", since = "1.0.0")]
3323 impl<'a, T> Iterator for Windows<'a, T> {
3324     type Item = &'a [T];
3325
3326     #[inline]
3327     fn next(&mut self) -> Option<&'a [T]> {
3328         if self.size > self.v.len() {
3329             None
3330         } else {
3331             let ret = Some(&self.v[..self.size]);
3332             self.v = &self.v[1..];
3333             ret
3334         }
3335     }
3336
3337     #[inline]
3338     fn size_hint(&self) -> (usize, Option<usize>) {
3339         if self.size > self.v.len() {
3340             (0, Some(0))
3341         } else {
3342             let size = self.v.len() - self.size + 1;
3343             (size, Some(size))
3344         }
3345     }
3346
3347     #[inline]
3348     fn count(self) -> usize {
3349         self.len()
3350     }
3351
3352     #[inline]
3353     fn nth(&mut self, n: usize) -> Option<Self::Item> {
3354         let (end, overflow) = self.size.overflowing_add(n);
3355         if end > self.v.len() || overflow {
3356             self.v = &[];
3357             None
3358         } else {
3359             let nth = &self.v[n..end];
3360             self.v = &self.v[n+1..];
3361             Some(nth)
3362         }
3363     }
3364
3365     #[inline]
3366     fn last(self) -> Option<Self::Item> {
3367         if self.size > self.v.len() {
3368             None
3369         } else {
3370             let start = self.v.len() - self.size;
3371             Some(&self.v[start..])
3372         }
3373     }
3374 }
3375
3376 #[stable(feature = "rust1", since = "1.0.0")]
3377 impl<'a, T> DoubleEndedIterator for Windows<'a, T> {
3378     #[inline]
3379     fn next_back(&mut self) -> Option<&'a [T]> {
3380         if self.size > self.v.len() {
3381             None
3382         } else {
3383             let ret = Some(&self.v[self.v.len()-self.size..]);
3384             self.v = &self.v[..self.v.len()-1];
3385             ret
3386         }
3387     }
3388 }
3389
3390 #[stable(feature = "rust1", since = "1.0.0")]
3391 impl<'a, T> ExactSizeIterator for Windows<'a, T> {}
3392
3393 #[unstable(feature = "trusted_len", issue = "37572")]
3394 unsafe impl<'a, T> TrustedLen for Windows<'a, T> {}
3395
3396 #[stable(feature = "fused", since = "1.26.0")]
3397 impl<'a, T> FusedIterator for Windows<'a, T> {}
3398
3399 #[doc(hidden)]
3400 unsafe impl<'a, T> TrustedRandomAccess for Windows<'a, T> {
3401     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
3402         from_raw_parts(self.v.as_ptr().add(i), self.size)
3403     }
3404     fn may_have_side_effect() -> bool { false }
3405 }
3406
3407 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
3408 /// time).
3409 ///
3410 /// When the slice len is not evenly divided by the chunk size, the last slice
3411 /// of the iteration will be the remainder.
3412 ///
3413 /// This struct is created by the [`chunks`] method on [slices].
3414 ///
3415 /// [`chunks`]: ../../std/primitive.slice.html#method.chunks
3416 /// [slices]: ../../std/primitive.slice.html
3417 #[derive(Debug)]
3418 #[stable(feature = "rust1", since = "1.0.0")]
3419 pub struct Chunks<'a, T:'a> {
3420     v: &'a [T],
3421     chunk_size: usize
3422 }
3423
3424 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
3425 #[stable(feature = "rust1", since = "1.0.0")]
3426 impl<'a, T> Clone for Chunks<'a, T> {
3427     fn clone(&self) -> Chunks<'a, T> {
3428         Chunks {
3429             v: self.v,
3430             chunk_size: self.chunk_size,
3431         }
3432     }
3433 }
3434
3435 #[stable(feature = "rust1", since = "1.0.0")]
3436 impl<'a, T> Iterator for Chunks<'a, T> {
3437     type Item = &'a [T];
3438
3439     #[inline]
3440     fn next(&mut self) -> Option<&'a [T]> {
3441         if self.v.is_empty() {
3442             None
3443         } else {
3444             let chunksz = cmp::min(self.v.len(), self.chunk_size);
3445             let (fst, snd) = self.v.split_at(chunksz);
3446             self.v = snd;
3447             Some(fst)
3448         }
3449     }
3450
3451     #[inline]
3452     fn size_hint(&self) -> (usize, Option<usize>) {
3453         if self.v.is_empty() {
3454             (0, Some(0))
3455         } else {
3456             let n = self.v.len() / self.chunk_size;
3457             let rem = self.v.len() % self.chunk_size;
3458             let n = if rem > 0 { n+1 } else { n };
3459             (n, Some(n))
3460         }
3461     }
3462
3463     #[inline]
3464     fn count(self) -> usize {
3465         self.len()
3466     }
3467
3468     #[inline]
3469     fn nth(&mut self, n: usize) -> Option<Self::Item> {
3470         let (start, overflow) = n.overflowing_mul(self.chunk_size);
3471         if start >= self.v.len() || overflow {
3472             self.v = &[];
3473             None
3474         } else {
3475             let end = match start.checked_add(self.chunk_size) {
3476                 Some(sum) => cmp::min(self.v.len(), sum),
3477                 None => self.v.len(),
3478             };
3479             let nth = &self.v[start..end];
3480             self.v = &self.v[end..];
3481             Some(nth)
3482         }
3483     }
3484
3485     #[inline]
3486     fn last(self) -> Option<Self::Item> {
3487         if self.v.is_empty() {
3488             None
3489         } else {
3490             let start = (self.v.len() - 1) / self.chunk_size * self.chunk_size;
3491             Some(&self.v[start..])
3492         }
3493     }
3494 }
3495
3496 #[stable(feature = "rust1", since = "1.0.0")]
3497 impl<'a, T> DoubleEndedIterator for Chunks<'a, T> {
3498     #[inline]
3499     fn next_back(&mut self) -> Option<&'a [T]> {
3500         if self.v.is_empty() {
3501             None
3502         } else {
3503             let remainder = self.v.len() % self.chunk_size;
3504             let chunksz = if remainder != 0 { remainder } else { self.chunk_size };
3505             let (fst, snd) = self.v.split_at(self.v.len() - chunksz);
3506             self.v = fst;
3507             Some(snd)
3508         }
3509     }
3510 }
3511
3512 #[stable(feature = "rust1", since = "1.0.0")]
3513 impl<'a, T> ExactSizeIterator for Chunks<'a, T> {}
3514
3515 #[unstable(feature = "trusted_len", issue = "37572")]
3516 unsafe impl<'a, T> TrustedLen for Chunks<'a, T> {}
3517
3518 #[stable(feature = "fused", since = "1.26.0")]
3519 impl<'a, T> FusedIterator for Chunks<'a, T> {}
3520
3521 #[doc(hidden)]
3522 unsafe impl<'a, T> TrustedRandomAccess for Chunks<'a, T> {
3523     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
3524         let start = i * self.chunk_size;
3525         let end = match start.checked_add(self.chunk_size) {
3526             None => self.v.len(),
3527             Some(end) => cmp::min(end, self.v.len()),
3528         };
3529         from_raw_parts(self.v.as_ptr().add(start), end - start)
3530     }
3531     fn may_have_side_effect() -> bool { false }
3532 }
3533
3534 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
3535 /// elements at a time). When the slice len is not evenly divided by the chunk
3536 /// size, the last slice of the iteration will be the remainder.
3537 ///
3538 /// This struct is created by the [`chunks_mut`] method on [slices].
3539 ///
3540 /// [`chunks_mut`]: ../../std/primitive.slice.html#method.chunks_mut
3541 /// [slices]: ../../std/primitive.slice.html
3542 #[derive(Debug)]
3543 #[stable(feature = "rust1", since = "1.0.0")]
3544 pub struct ChunksMut<'a, T:'a> {
3545     v: &'a mut [T],
3546     chunk_size: usize
3547 }
3548
3549 #[stable(feature = "rust1", since = "1.0.0")]
3550 impl<'a, T> Iterator for ChunksMut<'a, T> {
3551     type Item = &'a mut [T];
3552
3553     #[inline]
3554     fn next(&mut self) -> Option<&'a mut [T]> {
3555         if self.v.is_empty() {
3556             None
3557         } else {
3558             let sz = cmp::min(self.v.len(), self.chunk_size);
3559             let tmp = mem::replace(&mut self.v, &mut []);
3560             let (head, tail) = tmp.split_at_mut(sz);
3561             self.v = tail;
3562             Some(head)
3563         }
3564     }
3565
3566     #[inline]
3567     fn size_hint(&self) -> (usize, Option<usize>) {
3568         if self.v.is_empty() {
3569             (0, Some(0))
3570         } else {
3571             let n = self.v.len() / self.chunk_size;
3572             let rem = self.v.len() % self.chunk_size;
3573             let n = if rem > 0 { n + 1 } else { n };
3574             (n, Some(n))
3575         }
3576     }
3577
3578     #[inline]
3579     fn count(self) -> usize {
3580         self.len()
3581     }
3582
3583     #[inline]
3584     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
3585         let (start, overflow) = n.overflowing_mul(self.chunk_size);
3586         if start >= self.v.len() || overflow {
3587             self.v = &mut [];
3588             None
3589         } else {
3590             let end = match start.checked_add(self.chunk_size) {
3591                 Some(sum) => cmp::min(self.v.len(), sum),
3592                 None => self.v.len(),
3593             };
3594             let tmp = mem::replace(&mut self.v, &mut []);
3595             let (head, tail) = tmp.split_at_mut(end);
3596             let (_, nth) =  head.split_at_mut(start);
3597             self.v = tail;
3598             Some(nth)
3599         }
3600     }
3601
3602     #[inline]
3603     fn last(self) -> Option<Self::Item> {
3604         if self.v.is_empty() {
3605             None
3606         } else {
3607             let start = (self.v.len() - 1) / self.chunk_size * self.chunk_size;
3608             Some(&mut self.v[start..])
3609         }
3610     }
3611 }
3612
3613 #[stable(feature = "rust1", since = "1.0.0")]
3614 impl<'a, T> DoubleEndedIterator for ChunksMut<'a, T> {
3615     #[inline]
3616     fn next_back(&mut self) -> Option<&'a mut [T]> {
3617         if self.v.is_empty() {
3618             None
3619         } else {
3620             let remainder = self.v.len() % self.chunk_size;
3621             let sz = if remainder != 0 { remainder } else { self.chunk_size };
3622             let tmp = mem::replace(&mut self.v, &mut []);
3623             let tmp_len = tmp.len();
3624             let (head, tail) = tmp.split_at_mut(tmp_len - sz);
3625             self.v = head;
3626             Some(tail)
3627         }
3628     }
3629 }
3630
3631 #[stable(feature = "rust1", since = "1.0.0")]
3632 impl<'a, T> ExactSizeIterator for ChunksMut<'a, T> {}
3633
3634 #[unstable(feature = "trusted_len", issue = "37572")]
3635 unsafe impl<'a, T> TrustedLen for ChunksMut<'a, T> {}
3636
3637 #[stable(feature = "fused", since = "1.26.0")]
3638 impl<'a, T> FusedIterator for ChunksMut<'a, T> {}
3639
3640 #[doc(hidden)]
3641 unsafe impl<'a, T> TrustedRandomAccess for ChunksMut<'a, T> {
3642     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
3643         let start = i * self.chunk_size;
3644         let end = match start.checked_add(self.chunk_size) {
3645             None => self.v.len(),
3646             Some(end) => cmp::min(end, self.v.len()),
3647         };
3648         from_raw_parts_mut(self.v.as_mut_ptr().add(start), end - start)
3649     }
3650     fn may_have_side_effect() -> bool { false }
3651 }
3652
3653 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
3654 /// time).
3655 ///
3656 /// When the slice len is not evenly divided by the chunk size, the last
3657 /// up to `chunk_size-1` elements will be omitted but can be retrieved from
3658 /// the [`remainder`] function from the iterator.
3659 ///
3660 /// This struct is created by the [`exact_chunks`] method on [slices].
3661 ///
3662 /// [`exact_chunks`]: ../../std/primitive.slice.html#method.exact_chunks
3663 /// [`remainder`]: ../../std/slice/struct.ExactChunks.html#method.remainder
3664 /// [slices]: ../../std/primitive.slice.html
3665 #[derive(Debug)]
3666 #[unstable(feature = "exact_chunks", issue = "47115")]
3667 pub struct ExactChunks<'a, T:'a> {
3668     v: &'a [T],
3669     rem: &'a [T],
3670     chunk_size: usize
3671 }
3672
3673 #[unstable(feature = "exact_chunks", issue = "47115")]
3674 impl<'a, T> ExactChunks<'a, T> {
3675     /// Return the remainder of the original slice that is not going to be
3676     /// returned by the iterator. The returned slice has at most `chunk_size-1`
3677     /// elements.
3678     pub fn remainder(&self) -> &'a [T] {
3679         self.rem
3680     }
3681 }
3682
3683 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
3684 #[unstable(feature = "exact_chunks", issue = "47115")]
3685 impl<'a, T> Clone for ExactChunks<'a, T> {
3686     fn clone(&self) -> ExactChunks<'a, T> {
3687         ExactChunks {
3688             v: self.v,
3689             rem: self.rem,
3690             chunk_size: self.chunk_size,
3691         }
3692     }
3693 }
3694
3695 #[unstable(feature = "exact_chunks", issue = "47115")]
3696 impl<'a, T> Iterator for ExactChunks<'a, T> {
3697     type Item = &'a [T];
3698
3699     #[inline]
3700     fn next(&mut self) -> Option<&'a [T]> {
3701         if self.v.len() < self.chunk_size {
3702             None
3703         } else {
3704             let (fst, snd) = self.v.split_at(self.chunk_size);
3705             self.v = snd;
3706             Some(fst)
3707         }
3708     }
3709
3710     #[inline]
3711     fn size_hint(&self) -> (usize, Option<usize>) {
3712         let n = self.v.len() / self.chunk_size;
3713         (n, Some(n))
3714     }
3715
3716     #[inline]
3717     fn count(self) -> usize {
3718         self.len()
3719     }
3720
3721     #[inline]
3722     fn nth(&mut self, n: usize) -> Option<Self::Item> {
3723         let (start, overflow) = n.overflowing_mul(self.chunk_size);
3724         if start >= self.v.len() || overflow {
3725             self.v = &[];
3726             None
3727         } else {
3728             let (_, snd) = self.v.split_at(start);
3729             self.v = snd;
3730             self.next()
3731         }
3732     }
3733
3734     #[inline]
3735     fn last(mut self) -> Option<Self::Item> {
3736         self.next_back()
3737     }
3738 }
3739
3740 #[unstable(feature = "exact_chunks", issue = "47115")]
3741 impl<'a, T> DoubleEndedIterator for ExactChunks<'a, T> {
3742     #[inline]
3743     fn next_back(&mut self) -> Option<&'a [T]> {
3744         if self.v.len() < self.chunk_size {
3745             None
3746         } else {
3747             let (fst, snd) = self.v.split_at(self.v.len() - self.chunk_size);
3748             self.v = fst;
3749             Some(snd)
3750         }
3751     }
3752 }
3753
3754 #[unstable(feature = "exact_chunks", issue = "47115")]
3755 impl<'a, T> ExactSizeIterator for ExactChunks<'a, T> {
3756     fn is_empty(&self) -> bool {
3757         self.v.is_empty()
3758     }
3759 }
3760
3761 #[unstable(feature = "trusted_len", issue = "37572")]
3762 unsafe impl<'a, T> TrustedLen for ExactChunks<'a, T> {}
3763
3764 #[unstable(feature = "exact_chunks", issue = "47115")]
3765 impl<'a, T> FusedIterator for ExactChunks<'a, T> {}
3766
3767 #[doc(hidden)]
3768 unsafe impl<'a, T> TrustedRandomAccess for ExactChunks<'a, T> {
3769     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
3770         let start = i * self.chunk_size;
3771         from_raw_parts(self.v.as_ptr().add(start), self.chunk_size)
3772     }
3773     fn may_have_side_effect() -> bool { false }
3774 }
3775
3776 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
3777 /// elements at a time).
3778 ///
3779 /// When the slice len is not evenly divided by the chunk size, the last up to
3780 /// `chunk_size-1` elements will be omitted but can be retrieved from the
3781 /// [`into_remainder`] function from the iterator.
3782 ///
3783 /// This struct is created by the [`exact_chunks_mut`] method on [slices].
3784 ///
3785 /// [`exact_chunks_mut`]: ../../std/primitive.slice.html#method.exact_chunks_mut
3786 /// [`into_remainder`]: ../../std/slice/struct.ExactChunksMut.html#method.into_remainder
3787 /// [slices]: ../../std/primitive.slice.html
3788 #[derive(Debug)]
3789 #[unstable(feature = "exact_chunks", issue = "47115")]
3790 pub struct ExactChunksMut<'a, T:'a> {
3791     v: &'a mut [T],
3792     rem: &'a mut [T],
3793     chunk_size: usize
3794 }
3795
3796 #[unstable(feature = "exact_chunks", issue = "47115")]
3797 impl<'a, T> ExactChunksMut<'a, T> {
3798     /// Return the remainder of the original slice that is not going to be
3799     /// returned by the iterator. The returned slice has at most `chunk_size-1`
3800     /// elements.
3801     pub fn into_remainder(self) -> &'a mut [T] {
3802         self.rem
3803     }
3804 }
3805
3806 #[unstable(feature = "exact_chunks", issue = "47115")]
3807 impl<'a, T> Iterator for ExactChunksMut<'a, T> {
3808     type Item = &'a mut [T];
3809
3810     #[inline]
3811     fn next(&mut self) -> Option<&'a mut [T]> {
3812         if self.v.len() < self.chunk_size {
3813             None
3814         } else {
3815             let tmp = mem::replace(&mut self.v, &mut []);
3816             let (head, tail) = tmp.split_at_mut(self.chunk_size);
3817             self.v = tail;
3818             Some(head)
3819         }
3820     }
3821
3822     #[inline]
3823     fn size_hint(&self) -> (usize, Option<usize>) {
3824         let n = self.v.len() / self.chunk_size;
3825         (n, Some(n))
3826     }
3827
3828     #[inline]
3829     fn count(self) -> usize {
3830         self.len()
3831     }
3832
3833     #[inline]
3834     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
3835         let (start, overflow) = n.overflowing_mul(self.chunk_size);
3836         if start >= self.v.len() || overflow {
3837             self.v = &mut [];
3838             None
3839         } else {
3840             let tmp = mem::replace(&mut self.v, &mut []);
3841             let (_, snd) = tmp.split_at_mut(start);
3842             self.v = snd;
3843             self.next()
3844         }
3845     }
3846
3847     #[inline]
3848     fn last(mut self) -> Option<Self::Item> {
3849         self.next_back()
3850     }
3851 }
3852
3853 #[unstable(feature = "exact_chunks", issue = "47115")]
3854 impl<'a, T> DoubleEndedIterator for ExactChunksMut<'a, T> {
3855     #[inline]
3856     fn next_back(&mut self) -> Option<&'a mut [T]> {
3857         if self.v.len() < self.chunk_size {
3858             None
3859         } else {
3860             let tmp = mem::replace(&mut self.v, &mut []);
3861             let tmp_len = tmp.len();
3862             let (head, tail) = tmp.split_at_mut(tmp_len - self.chunk_size);
3863             self.v = head;
3864             Some(tail)
3865         }
3866     }
3867 }
3868
3869 #[unstable(feature = "exact_chunks", issue = "47115")]
3870 impl<'a, T> ExactSizeIterator for ExactChunksMut<'a, T> {
3871     fn is_empty(&self) -> bool {
3872         self.v.is_empty()
3873     }
3874 }
3875
3876 #[unstable(feature = "trusted_len", issue = "37572")]
3877 unsafe impl<'a, T> TrustedLen for ExactChunksMut<'a, T> {}
3878
3879 #[unstable(feature = "exact_chunks", issue = "47115")]
3880 impl<'a, T> FusedIterator for ExactChunksMut<'a, T> {}
3881
3882 #[doc(hidden)]
3883 unsafe impl<'a, T> TrustedRandomAccess for ExactChunksMut<'a, T> {
3884     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
3885         let start = i * self.chunk_size;
3886         from_raw_parts_mut(self.v.as_mut_ptr().add(start), self.chunk_size)
3887     }
3888     fn may_have_side_effect() -> bool { false }
3889 }
3890
3891 //
3892 // Free functions
3893 //
3894
3895 /// Forms a slice from a pointer and a length.
3896 ///
3897 /// The `len` argument is the number of **elements**, not the number of bytes.
3898 ///
3899 /// # Safety
3900 ///
3901 /// This function is unsafe as there is no guarantee that the given pointer is
3902 /// valid for `len` elements, nor whether the lifetime inferred is a suitable
3903 /// lifetime for the returned slice.
3904 ///
3905 /// `data` must be non-null and aligned, even for zero-length slices. One
3906 /// reason for this is that enum layout optimizations may rely on references
3907 /// (including slices of any length) being aligned and non-null to distinguish
3908 /// them from other data. You can obtain a pointer that is usable as `data`
3909 /// for zero-length slices using [`NonNull::dangling()`].
3910 ///
3911 /// # Caveat
3912 ///
3913 /// The lifetime for the returned slice is inferred from its usage. To
3914 /// prevent accidental misuse, it's suggested to tie the lifetime to whichever
3915 /// source lifetime is safe in the context, such as by providing a helper
3916 /// function taking the lifetime of a host value for the slice, or by explicit
3917 /// annotation.
3918 ///
3919 /// # Examples
3920 ///
3921 /// ```
3922 /// use std::slice;
3923 ///
3924 /// // manifest a slice for a single element
3925 /// let x = 42;
3926 /// let ptr = &x as *const _;
3927 /// let slice = unsafe { slice::from_raw_parts(ptr, 1) };
3928 /// assert_eq!(slice[0], 42);
3929 /// ```
3930 ///
3931 /// [`NonNull::dangling()`]: ../../std/ptr/struct.NonNull.html#method.dangling
3932 #[inline]
3933 #[stable(feature = "rust1", since = "1.0.0")]
3934 pub unsafe fn from_raw_parts<'a, T>(data: *const T, len: usize) -> &'a [T] {
3935     debug_assert!(data as usize % mem::align_of::<T>() == 0, "attempt to create unaligned slice");
3936     Repr { raw: FatPtr { data, len } }.rust
3937 }
3938
3939 /// Performs the same functionality as [`from_raw_parts`], except that a
3940 /// mutable slice is returned.
3941 ///
3942 /// This function is unsafe for the same reasons as [`from_raw_parts`], as well
3943 /// as not being able to provide a non-aliasing guarantee of the returned
3944 /// mutable slice. `data` must be non-null and aligned even for zero-length
3945 /// slices as with [`from_raw_parts`]. See the documentation of
3946 /// [`from_raw_parts`] for more details.
3947 ///
3948 /// [`from_raw_parts`]: ../../std/slice/fn.from_raw_parts.html
3949 #[inline]
3950 #[stable(feature = "rust1", since = "1.0.0")]
3951 pub unsafe fn from_raw_parts_mut<'a, T>(data: *mut T, len: usize) -> &'a mut [T] {
3952     debug_assert!(data as usize % mem::align_of::<T>() == 0, "attempt to create unaligned slice");
3953     Repr { raw: FatPtr { data, len} }.rust_mut
3954 }
3955
3956 /// Converts a reference to T into a slice of length 1 (without copying).
3957 #[stable(feature = "from_ref", since = "1.28.0")]
3958 pub fn from_ref<T>(s: &T) -> &[T] {
3959     unsafe {
3960         from_raw_parts(s, 1)
3961     }
3962 }
3963
3964 /// Converts a reference to T into a slice of length 1 (without copying).
3965 #[stable(feature = "from_ref", since = "1.28.0")]
3966 pub fn from_mut<T>(s: &mut T) -> &mut [T] {
3967     unsafe {
3968         from_raw_parts_mut(s, 1)
3969     }
3970 }
3971
3972 // This function is public only because there is no other way to unit test heapsort.
3973 #[unstable(feature = "sort_internals", reason = "internal to sort module", issue = "0")]
3974 #[doc(hidden)]
3975 pub fn heapsort<T, F>(v: &mut [T], mut is_less: F)
3976     where F: FnMut(&T, &T) -> bool
3977 {
3978     sort::heapsort(v, &mut is_less);
3979 }
3980
3981 //
3982 // Comparison traits
3983 //
3984
3985 extern {
3986     /// Calls implementation provided memcmp.
3987     ///
3988     /// Interprets the data as u8.
3989     ///
3990     /// Returns 0 for equal, < 0 for less than and > 0 for greater
3991     /// than.
3992     // FIXME(#32610): Return type should be c_int
3993     fn memcmp(s1: *const u8, s2: *const u8, n: usize) -> i32;
3994 }
3995
3996 #[stable(feature = "rust1", since = "1.0.0")]
3997 impl<A, B> PartialEq<[B]> for [A] where A: PartialEq<B> {
3998     fn eq(&self, other: &[B]) -> bool {
3999         SlicePartialEq::equal(self, other)
4000     }
4001
4002     fn ne(&self, other: &[B]) -> bool {
4003         SlicePartialEq::not_equal(self, other)
4004     }
4005 }
4006
4007 #[stable(feature = "rust1", since = "1.0.0")]
4008 impl<T: Eq> Eq for [T] {}
4009
4010 /// Implements comparison of vectors lexicographically.
4011 #[stable(feature = "rust1", since = "1.0.0")]
4012 impl<T: Ord> Ord for [T] {
4013     fn cmp(&self, other: &[T]) -> Ordering {
4014         SliceOrd::compare(self, other)
4015     }
4016 }
4017
4018 /// Implements comparison of vectors lexicographically.
4019 #[stable(feature = "rust1", since = "1.0.0")]
4020 impl<T: PartialOrd> PartialOrd for [T] {
4021     fn partial_cmp(&self, other: &[T]) -> Option<Ordering> {
4022         SlicePartialOrd::partial_compare(self, other)
4023     }
4024 }
4025
4026 #[doc(hidden)]
4027 // intermediate trait for specialization of slice's PartialEq
4028 trait SlicePartialEq<B> {
4029     fn equal(&self, other: &[B]) -> bool;
4030
4031     fn not_equal(&self, other: &[B]) -> bool { !self.equal(other) }
4032 }
4033
4034 // Generic slice equality
4035 impl<A, B> SlicePartialEq<B> for [A]
4036     where A: PartialEq<B>
4037 {
4038     default fn equal(&self, other: &[B]) -> bool {
4039         if self.len() != other.len() {
4040             return false;
4041         }
4042
4043         for i in 0..self.len() {
4044             if !self[i].eq(&other[i]) {
4045                 return false;
4046             }
4047         }
4048
4049         true
4050     }
4051 }
4052
4053 // Use memcmp for bytewise equality when the types allow
4054 impl<A> SlicePartialEq<A> for [A]
4055     where A: PartialEq<A> + BytewiseEquality
4056 {
4057     fn equal(&self, other: &[A]) -> bool {
4058         if self.len() != other.len() {
4059             return false;
4060         }
4061         if self.as_ptr() == other.as_ptr() {
4062             return true;
4063         }
4064         unsafe {
4065             let size = mem::size_of_val(self);
4066             memcmp(self.as_ptr() as *const u8,
4067                    other.as_ptr() as *const u8, size) == 0
4068         }
4069     }
4070 }
4071
4072 #[doc(hidden)]
4073 // intermediate trait for specialization of slice's PartialOrd
4074 trait SlicePartialOrd<B> {
4075     fn partial_compare(&self, other: &[B]) -> Option<Ordering>;
4076 }
4077
4078 impl<A> SlicePartialOrd<A> for [A]
4079     where A: PartialOrd
4080 {
4081     default fn partial_compare(&self, other: &[A]) -> Option<Ordering> {
4082         let l = cmp::min(self.len(), other.len());
4083
4084         // Slice to the loop iteration range to enable bound check
4085         // elimination in the compiler
4086         let lhs = &self[..l];
4087         let rhs = &other[..l];
4088
4089         for i in 0..l {
4090             match lhs[i].partial_cmp(&rhs[i]) {
4091                 Some(Ordering::Equal) => (),
4092                 non_eq => return non_eq,
4093             }
4094         }
4095
4096         self.len().partial_cmp(&other.len())
4097     }
4098 }
4099
4100 impl<A> SlicePartialOrd<A> for [A]
4101     where A: Ord
4102 {
4103     default fn partial_compare(&self, other: &[A]) -> Option<Ordering> {
4104         Some(SliceOrd::compare(self, other))
4105     }
4106 }
4107
4108 #[doc(hidden)]
4109 // intermediate trait for specialization of slice's Ord
4110 trait SliceOrd<B> {
4111     fn compare(&self, other: &[B]) -> Ordering;
4112 }
4113
4114 impl<A> SliceOrd<A> for [A]
4115     where A: Ord
4116 {
4117     default fn compare(&self, other: &[A]) -> Ordering {
4118         let l = cmp::min(self.len(), other.len());
4119
4120         // Slice to the loop iteration range to enable bound check
4121         // elimination in the compiler
4122         let lhs = &self[..l];
4123         let rhs = &other[..l];
4124
4125         for i in 0..l {
4126             match lhs[i].cmp(&rhs[i]) {
4127                 Ordering::Equal => (),
4128                 non_eq => return non_eq,
4129             }
4130         }
4131
4132         self.len().cmp(&other.len())
4133     }
4134 }
4135
4136 // memcmp compares a sequence of unsigned bytes lexicographically.
4137 // this matches the order we want for [u8], but no others (not even [i8]).
4138 impl SliceOrd<u8> for [u8] {
4139     #[inline]
4140     fn compare(&self, other: &[u8]) -> Ordering {
4141         let order = unsafe {
4142             memcmp(self.as_ptr(), other.as_ptr(),
4143                    cmp::min(self.len(), other.len()))
4144         };
4145         if order == 0 {
4146             self.len().cmp(&other.len())
4147         } else if order < 0 {
4148             Less
4149         } else {
4150             Greater
4151         }
4152     }
4153 }
4154
4155 #[doc(hidden)]
4156 /// Trait implemented for types that can be compared for equality using
4157 /// their bytewise representation
4158 trait BytewiseEquality { }
4159
4160 macro_rules! impl_marker_for {
4161     ($traitname:ident, $($ty:ty)*) => {
4162         $(
4163             impl $traitname for $ty { }
4164         )*
4165     }
4166 }
4167
4168 impl_marker_for!(BytewiseEquality,
4169                  u8 i8 u16 i16 u32 i32 u64 i64 usize isize char bool);
4170
4171 #[doc(hidden)]
4172 unsafe impl<'a, T> TrustedRandomAccess for Iter<'a, T> {
4173     unsafe fn get_unchecked(&mut self, i: usize) -> &'a T {
4174         &*self.ptr.add(i)
4175     }
4176     fn may_have_side_effect() -> bool { false }
4177 }
4178
4179 #[doc(hidden)]
4180 unsafe impl<'a, T> TrustedRandomAccess for IterMut<'a, T> {
4181     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut T {
4182         &mut *self.ptr.add(i)
4183     }
4184     fn may_have_side_effect() -> bool { false }
4185 }
4186
4187 trait SliceContains: Sized {
4188     fn slice_contains(&self, x: &[Self]) -> bool;
4189 }
4190
4191 impl<T> SliceContains for T where T: PartialEq {
4192     default fn slice_contains(&self, x: &[Self]) -> bool {
4193         x.iter().any(|y| *y == *self)
4194     }
4195 }
4196
4197 impl SliceContains for u8 {
4198     fn slice_contains(&self, x: &[Self]) -> bool {
4199         memchr::memchr(*self, x).is_some()
4200     }
4201 }
4202
4203 impl SliceContains for i8 {
4204     fn slice_contains(&self, x: &[Self]) -> bool {
4205         let byte = *self as u8;
4206         let bytes: &[u8] = unsafe { from_raw_parts(x.as_ptr() as *const u8, x.len()) };
4207         memchr::memchr(byte, bytes).is_some()
4208     }
4209 }