src/libcore/slice.rs

   1 // Copyright 2012-2014 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 `std::slice`.
  14
  15 #![stable(feature = "rust1", since = "1.0.0")]
  16
  17 // How this module is organized.
  18 //
  19 // The library infrastructure for slices is fairly messy. There's
  20 // a lot of stuff defined here. Let's keep it clean.
  21 //
  22 // Since slices don't support inherent methods; all operations
  23 // on them are defined on traits, which are then reexported from
  24 // the prelude for convenience. So there are a lot of traits here.
  25 //
  26 // The layout of this file is thus:
  27 //
  28 // * Slice-specific 'extension' traits and their implementations. This
  29 //   is where most of the slice API resides.
  30 // * Implementations of a few common traits with important slice ops.
  31 // * Definitions of a bunch of iterators.
  32 // * Free functions.
  33 // * The `raw` and `bytes` submodules.
  34 // * Boilerplate trait implementations.
  35
  36 use clone::Clone;
  37 use cmp::{Ordering, PartialEq, PartialOrd, Eq, Ord};
  38 use cmp::Ordering::{Less, Equal, Greater};
  39 use cmp;
  40 use default::Default;
  41 use intrinsics::assume;
  42 use iter::*;
  43 use ops::{FnMut, self, Index};
  44 use ops::RangeFull;
  45 use option::Option;
  46 use option::Option::{None, Some};
  47 use result::Result;
  48 use result::Result::{Ok, Err};
  49 use ptr;
  50 use mem;
  51 use marker::{Send, Sync, self};
  52 use raw::Repr;
  53 // Avoid conflicts with *both* the Slice trait (buggy) and the `slice::raw` module.
  54 use raw::Slice as RawSlice;
  55
  56
  57 //
  58 // Extension traits
  59 //
  60
  61 /// Extension methods for slices.
  62 #[unstable(feature = "core_slice_ext",
  63            reason = "stable interface provided by `impl [T]` in later crates",
  64            issue = "27701")]
  65 #[allow(missing_docs)] // documented elsewhere
  66 pub trait SliceExt {
  67     type Item;
  68
  69     #[stable(feature = "core", since = "1.6.0")]
  70     fn split_at(&self, mid: usize) -> (&[Self::Item], &[Self::Item]);
  71     #[stable(feature = "core", since = "1.6.0")]
  72     fn iter(&self) -> Iter<Self::Item>;
  73     #[stable(feature = "core", since = "1.6.0")]
  74     fn split<P>(&self, pred: P) -> Split<Self::Item, P>
  75                     where P: FnMut(&Self::Item) -> bool;
  76     #[stable(feature = "core", since = "1.6.0")]
  77     fn splitn<P>(&self, n: usize, pred: P) -> SplitN<Self::Item, P>
  78                      where P: FnMut(&Self::Item) -> bool;
  79     #[stable(feature = "core", since = "1.6.0")]
  80     fn rsplitn<P>(&self,  n: usize, pred: P) -> RSplitN<Self::Item, P>
  81                       where P: FnMut(&Self::Item) -> bool;
  82     #[stable(feature = "core", since = "1.6.0")]
  83     fn windows(&self, size: usize) -> Windows<Self::Item>;
  84     #[stable(feature = "core", since = "1.6.0")]
  85     fn chunks(&self, size: usize) -> Chunks<Self::Item>;
  86     #[stable(feature = "core", since = "1.6.0")]
  87     fn get(&self, index: usize) -> Option<&Self::Item>;
  88     #[stable(feature = "core", since = "1.6.0")]
  89     fn first(&self) -> Option<&Self::Item>;
  90     #[stable(feature = "core", since = "1.6.0")]
  91     fn split_first(&self) -> Option<(&Self::Item, &[Self::Item])>;
  92     #[stable(feature = "core", since = "1.6.0")]
  93     fn split_last(&self) -> Option<(&Self::Item, &[Self::Item])>;
  94     #[stable(feature = "core", since = "1.6.0")]
  95     fn last(&self) -> Option<&Self::Item>;
  96     #[stable(feature = "core", since = "1.6.0")]
  97     unsafe fn get_unchecked(&self, index: usize) -> &Self::Item;
  98     #[stable(feature = "core", since = "1.6.0")]
  99     fn as_ptr(&self) -> *const Self::Item;
 100     #[stable(feature = "core", since = "1.6.0")]
 101     fn binary_search(&self, x: &Self::Item) -> Result<usize, usize>
 102         where Self::Item: Ord;
 103     #[stable(feature = "core", since = "1.6.0")]
 104     fn binary_search_by<F>(&self, f: F) -> Result<usize, usize>
 105         where F: FnMut(&Self::Item) -> Ordering;
 106     #[stable(feature = "core", since = "1.6.0")]
 107     fn len(&self) -> usize;
 108     #[stable(feature = "core", since = "1.6.0")]
 109     fn is_empty(&self) -> bool { self.len() == 0 }
 110     #[stable(feature = "core", since = "1.6.0")]
 111     fn get_mut(&mut self, index: usize) -> Option<&mut Self::Item>;
 112     #[stable(feature = "core", since = "1.6.0")]
 113     fn iter_mut(&mut self) -> IterMut<Self::Item>;
 114     #[stable(feature = "core", since = "1.6.0")]
 115     fn first_mut(&mut self) -> Option<&mut Self::Item>;
 116     #[stable(feature = "core", since = "1.6.0")]
 117     fn split_first_mut(&mut self) -> Option<(&mut Self::Item, &mut [Self::Item])>;
 118     #[stable(feature = "core", since = "1.6.0")]
 119     fn split_last_mut(&mut self) -> Option<(&mut Self::Item, &mut [Self::Item])>;
 120     #[stable(feature = "core", since = "1.6.0")]
 121     fn last_mut(&mut self) -> Option<&mut Self::Item>;
 122     #[stable(feature = "core", since = "1.6.0")]
 123     fn split_mut<P>(&mut self, pred: P) -> SplitMut<Self::Item, P>
 124                         where P: FnMut(&Self::Item) -> bool;
 125     #[stable(feature = "core", since = "1.6.0")]
 126     fn splitn_mut<P>(&mut self, n: usize, pred: P) -> SplitNMut<Self::Item, P>
 127                      where P: FnMut(&Self::Item) -> bool;
 128     #[stable(feature = "core", since = "1.6.0")]
 129     fn rsplitn_mut<P>(&mut self,  n: usize, pred: P) -> RSplitNMut<Self::Item, P>
 130                       where P: FnMut(&Self::Item) -> bool;
 131     #[stable(feature = "core", since = "1.6.0")]
 132     fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<Self::Item>;
 133     #[stable(feature = "core", since = "1.6.0")]
 134     fn swap(&mut self, a: usize, b: usize);
 135     #[stable(feature = "core", since = "1.6.0")]
 136     fn split_at_mut(&mut self, mid: usize) -> (&mut [Self::Item], &mut [Self::Item]);
 137     #[stable(feature = "core", since = "1.6.0")]
 138     fn reverse(&mut self);
 139     #[stable(feature = "core", since = "1.6.0")]
 140     unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut Self::Item;
 141     #[stable(feature = "core", since = "1.6.0")]
 142     fn as_mut_ptr(&mut self) -> *mut Self::Item;
 143
 144     #[stable(feature = "core", since = "1.6.0")]
 145     fn contains(&self, x: &Self::Item) -> bool where Self::Item: PartialEq;
 146
 147     #[stable(feature = "core", since = "1.6.0")]
 148     fn starts_with(&self, needle: &[Self::Item]) -> bool where Self::Item: PartialEq;
 149
 150     #[stable(feature = "core", since = "1.6.0")]
 151     fn ends_with(&self, needle: &[Self::Item]) -> bool where Self::Item: PartialEq;
 152
 153     #[stable(feature = "clone_from_slice", since = "1.7.0")]
 154     fn clone_from_slice(&mut self, &[Self::Item]) where Self::Item: Clone;
 155 }
 156
 157 // Use macros to be generic over const/mut
 158 macro_rules! slice_offset {
 159     ($ptr:expr, $by:expr) => {{
 160         let ptr = $ptr;
 161         if size_from_ptr(ptr) == 0 {
 162             ::intrinsics::arith_offset(ptr as *mut i8, $by) as *mut _
 163         } else {
 164             ptr.offset($by)
 165         }
 166     }};
 167 }
 168
 169 macro_rules! slice_ref {
 170     ($ptr:expr) => {{
 171         let ptr = $ptr;
 172         if size_from_ptr(ptr) == 0 {
 173             // Use a non-null pointer value
 174             &mut *(1 as *mut _)
 175         } else {
 176             mem::transmute(ptr)
 177         }
 178     }};
 179 }
 180
 181 #[unstable(feature = "core_slice_ext",
 182            reason = "stable interface provided by `impl [T]` in later crates",
 183            issue = "27701")]
 184 impl<T> SliceExt for [T] {
 185     type Item = T;
 186
 187     #[inline]
 188     fn split_at(&self, mid: usize) -> (&[T], &[T]) {
 189         (&self[..mid], &self[mid..])
 190     }
 191
 192     #[inline]
 193     fn iter(&self) -> Iter<T> {
 194         unsafe {
 195             let p = if mem::size_of::<T>() == 0 {
 196                 1 as *const _
 197             } else {
 198                 let p = self.as_ptr();
 199                 assume(!p.is_null());
 200                 p
 201             };
 202
 203             Iter {
 204                 ptr: p,
 205                 end: slice_offset!(p, self.len() as isize),
 206                 _marker: marker::PhantomData
 207             }
 208         }
 209     }
 210
 211     #[inline]
 212     fn split<P>(&self, pred: P) -> Split<T, P> where P: FnMut(&T) -> bool {
 213         Split {
 214             v: self,
 215             pred: pred,
 216             finished: false
 217         }
 218     }
 219
 220     #[inline]
 221     fn splitn<P>(&self, n: usize, pred: P) -> SplitN<T, P> where
 222         P: FnMut(&T) -> bool,
 223     {
 224         SplitN {
 225             inner: GenericSplitN {
 226                 iter: self.split(pred),
 227                 count: n,
 228                 invert: false
 229             }
 230         }
 231     }
 232
 233     #[inline]
 234     fn rsplitn<P>(&self, n: usize, pred: P) -> RSplitN<T, P> where
 235         P: FnMut(&T) -> bool,
 236     {
 237         RSplitN {
 238             inner: GenericSplitN {
 239                 iter: self.split(pred),
 240                 count: n,
 241                 invert: true
 242             }
 243         }
 244     }
 245
 246     #[inline]
 247     fn windows(&self, size: usize) -> Windows<T> {
 248         assert!(size != 0);
 249         Windows { v: self, size: size }
 250     }
 251
 252     #[inline]
 253     fn chunks(&self, size: usize) -> Chunks<T> {
 254         assert!(size != 0);
 255         Chunks { v: self, size: size }
 256     }
 257
 258     #[inline]
 259     fn get(&self, index: usize) -> Option<&T> {
 260         if index < self.len() { Some(&self[index]) } else { None }
 261     }
 262
 263     #[inline]
 264     fn first(&self) -> Option<&T> {
 265         if self.is_empty() { None } else { Some(&self[0]) }
 266     }
 267
 268     #[inline]
 269     fn split_first(&self) -> Option<(&T, &[T])> {
 270         if self.is_empty() { None } else { Some((&self[0], &self[1..])) }
 271     }
 272
 273     #[inline]
 274     fn split_last(&self) -> Option<(&T, &[T])> {
 275         let len = self.len();
 276         if len == 0 { None } else { Some((&self[len - 1], &self[..(len - 1)])) }
 277     }
 278
 279     #[inline]
 280     fn last(&self) -> Option<&T> {
 281         if self.is_empty() { None } else { Some(&self[self.len() - 1]) }
 282     }
 283
 284     #[inline]
 285     unsafe fn get_unchecked(&self, index: usize) -> &T {
 286         &*(self.repr().data.offset(index as isize))
 287     }
 288
 289     #[inline]
 290     fn as_ptr(&self) -> *const T {
 291         self.repr().data
 292     }
 293
 294     fn binary_search_by<F>(&self, mut f: F) -> Result<usize, usize> where
 295         F: FnMut(&T) -> Ordering
 296     {
 297         let mut base : usize = 0;
 298         let mut lim : usize = self.len();
 299
 300         while lim != 0 {
 301             let ix = base + (lim >> 1);
 302             match f(&self[ix]) {
 303                 Equal => return Ok(ix),
 304                 Less => {
 305                     base = ix + 1;
 306                     lim -= 1;
 307                 }
 308                 Greater => ()
 309             }
 310             lim >>= 1;
 311         }
 312         Err(base)
 313     }
 314
 315     #[inline]
 316     fn len(&self) -> usize { self.repr().len }
 317
 318     #[inline]
 319     fn get_mut(&mut self, index: usize) -> Option<&mut T> {
 320         if index < self.len() { Some(&mut self[index]) } else { None }
 321     }
 322
 323     #[inline]
 324     fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T]) {
 325         let len = self.len();
 326         let ptr = self.as_mut_ptr();
 327
 328         unsafe {
 329             assert!(mid <= len);
 330
 331             (from_raw_parts_mut(ptr, mid),
 332              from_raw_parts_mut(ptr.offset(mid as isize), len - mid))
 333         }
 334     }
 335
 336     #[inline]
 337     fn iter_mut(&mut self) -> IterMut<T> {
 338         unsafe {
 339             let p = if mem::size_of::<T>() == 0 {
 340                 1 as *mut _
 341             } else {
 342                 let p = self.as_mut_ptr();
 343                 assume(!p.is_null());
 344                 p
 345             };
 346
 347             IterMut {
 348                 ptr: p,
 349                 end: slice_offset!(p, self.len() as isize),
 350                 _marker: marker::PhantomData
 351             }
 352         }
 353     }
 354
 355     #[inline]
 356     fn last_mut(&mut self) -> Option<&mut T> {
 357         let len = self.len();
 358         if len == 0 { return None; }
 359         Some(&mut self[len - 1])
 360     }
 361
 362     #[inline]
 363     fn first_mut(&mut self) -> Option<&mut T> {
 364         if self.is_empty() { None } else { Some(&mut self[0]) }
 365     }
 366
 367     #[inline]
 368     fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])> {
 369         if self.is_empty() { None } else {
 370             let split = self.split_at_mut(1);
 371             Some((&mut split.0[0], split.1))
 372         }
 373     }
 374
 375     #[inline]
 376     fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])> {
 377         let len = self.len();
 378         if len == 0 { None } else {
 379             let split = self.split_at_mut(len - 1);
 380             Some((&mut split.1[0], split.0))
 381         }
 382     }
 383
 384     #[inline]
 385     fn split_mut<P>(&mut self, pred: P) -> SplitMut<T, P> where P: FnMut(&T) -> bool {
 386         SplitMut { v: self, pred: pred, finished: false }
 387     }
 388
 389     #[inline]
 390     fn splitn_mut<P>(&mut self, n: usize, pred: P) -> SplitNMut<T, P> where
 391         P: FnMut(&T) -> bool
 392     {
 393         SplitNMut {
 394             inner: GenericSplitN {
 395                 iter: self.split_mut(pred),
 396                 count: n,
 397                 invert: false
 398             }
 399         }
 400     }
 401
 402     #[inline]
 403     fn rsplitn_mut<P>(&mut self, n: usize, pred: P) -> RSplitNMut<T, P> where
 404         P: FnMut(&T) -> bool,
 405     {
 406         RSplitNMut {
 407             inner: GenericSplitN {
 408                 iter: self.split_mut(pred),
 409                 count: n,
 410                 invert: true
 411             }
 412         }
 413    }
 414
 415     #[inline]
 416     fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<T> {
 417         assert!(chunk_size > 0);
 418         ChunksMut { v: self, chunk_size: chunk_size }
 419     }
 420
 421     #[inline]
 422     fn swap(&mut self, a: usize, b: usize) {
 423         unsafe {
 424             // Can't take two mutable loans from one vector, so instead just cast
 425             // them to their raw pointers to do the swap
 426             let pa: *mut T = &mut self[a];
 427             let pb: *mut T = &mut self[b];
 428             ptr::swap(pa, pb);
 429         }
 430     }
 431
 432     fn reverse(&mut self) {
 433         let mut i: usize = 0;
 434         let ln = self.len();
 435         while i < ln / 2 {
 436             // Unsafe swap to avoid the bounds check in safe swap.
 437             unsafe {
 438                 let pa: *mut T = self.get_unchecked_mut(i);
 439                 let pb: *mut T = self.get_unchecked_mut(ln - i - 1);
 440                 ptr::swap(pa, pb);
 441             }
 442             i += 1;
 443         }
 444     }
 445
 446     #[inline]
 447     unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
 448         &mut *(self.repr().data as *mut T).offset(index as isize)
 449     }
 450
 451     #[inline]
 452     fn as_mut_ptr(&mut self) -> *mut T {
 453         self.repr().data as *mut T
 454     }
 455
 456     #[inline]
 457     fn contains(&self, x: &T) -> bool where T: PartialEq {
 458         self.iter().any(|elt| *x == *elt)
 459     }
 460
 461     #[inline]
 462     fn starts_with(&self, needle: &[T]) -> bool where T: PartialEq {
 463         let n = needle.len();
 464         self.len() >= n && needle == &self[..n]
 465     }
 466
 467     #[inline]
 468     fn ends_with(&self, needle: &[T]) -> bool where T: PartialEq {
 469         let (m, n) = (self.len(), needle.len());
 470         m >= n && needle == &self[m-n..]
 471     }
 472
 473     fn binary_search(&self, x: &T) -> Result<usize, usize> where T: Ord {
 474         self.binary_search_by(|p| p.cmp(x))
 475     }
 476
 477     #[inline]
 478     fn clone_from_slice(&mut self, src: &[T]) where T: Clone {
 479         assert!(self.len() == src.len(),
 480                 "destination and source slices have different lengths");
 481         // NOTE: We need to explicitly slice them to the same length
 482         // for bounds checking to be elided, and the optimizer will
 483         // generate memcpy for simple cases (for example T = u8).
 484         let len = self.len();
 485         let src = &src[..len];
 486         for i in 0..len {
 487             self[i].clone_from(&src[i]);
 488         }
 489     }
 490 }
 491
 492 #[stable(feature = "rust1", since = "1.0.0")]
 493 impl<T> ops::Index<usize> for [T] {
 494     type Output = T;
 495
 496     fn index(&self, index: usize) -> &T {
 497         assert!(index < self.len());
 498         unsafe { self.get_unchecked(index) }
 499     }
 500 }
 501
 502 #[stable(feature = "rust1", since = "1.0.0")]
 503 impl<T> ops::IndexMut<usize> for [T] {
 504     #[inline]
 505     fn index_mut(&mut self, index: usize) -> &mut T {
 506         assert!(index < self.len());
 507         unsafe { self.get_unchecked_mut(index) }
 508     }
 509 }
 510
 511 #[inline(never)]
 512 #[cold]
 513 fn slice_index_len_fail(index: usize, len: usize) -> ! {
 514     panic!("index {} out of range for slice of length {}", index, len);
 515 }
 516
 517 #[inline(never)]
 518 #[cold]
 519 fn slice_index_order_fail(index: usize, end: usize) -> ! {
 520     panic!("slice index starts at {} but ends at {}", index, end);
 521 }
 522
 523 #[stable(feature = "rust1", since = "1.0.0")]
 524 impl<T> ops::Index<ops::Range<usize>> for [T] {
 525     type Output = [T];
 526
 527     #[inline]
 528     fn index(&self, index: ops::Range<usize>) -> &[T] {
 529         if index.start > index.end {
 530             slice_index_order_fail(index.start, index.end);
 531         } else if index.end > self.len() {
 532             slice_index_len_fail(index.end, self.len());
 533         }
 534         unsafe {
 535             from_raw_parts (
 536                 self.as_ptr().offset(index.start as isize),
 537                 index.end - index.start
 538             )
 539         }
 540     }
 541 }
 542 #[stable(feature = "rust1", since = "1.0.0")]
 543 impl<T> ops::Index<ops::RangeTo<usize>> for [T] {
 544     type Output = [T];
 545
 546     #[inline]
 547     fn index(&self, index: ops::RangeTo<usize>) -> &[T] {
 548         self.index(ops::Range{ start: 0, end: index.end })
 549     }
 550 }
 551 #[stable(feature = "rust1", since = "1.0.0")]
 552 impl<T> ops::Index<ops::RangeFrom<usize>> for [T] {
 553     type Output = [T];
 554
 555     #[inline]
 556     fn index(&self, index: ops::RangeFrom<usize>) -> &[T] {
 557         self.index(ops::Range{ start: index.start, end: self.len() })
 558     }
 559 }
 560 #[stable(feature = "rust1", since = "1.0.0")]
 561 impl<T> ops::Index<RangeFull> for [T] {
 562     type Output = [T];
 563
 564     #[inline]
 565     fn index(&self, _index: RangeFull) -> &[T] {
 566         self
 567     }
 568 }
 569
 570 #[stable(feature = "rust1", since = "1.0.0")]
 571 impl<T> ops::IndexMut<ops::Range<usize>> for [T] {
 572     #[inline]
 573     fn index_mut(&mut self, index: ops::Range<usize>) -> &mut [T] {
 574         if index.start > index.end {
 575             slice_index_order_fail(index.start, index.end);
 576         } else if index.end > self.len() {
 577             slice_index_len_fail(index.end, self.len());
 578         }
 579         unsafe {
 580             from_raw_parts_mut(
 581                 self.as_mut_ptr().offset(index.start as isize),
 582                 index.end - index.start
 583             )
 584         }
 585     }
 586 }
 587 #[stable(feature = "rust1", since = "1.0.0")]
 588 impl<T> ops::IndexMut<ops::RangeTo<usize>> for [T] {
 589     #[inline]
 590     fn index_mut(&mut self, index: ops::RangeTo<usize>) -> &mut [T] {
 591         self.index_mut(ops::Range{ start: 0, end: index.end })
 592     }
 593 }
 594 #[stable(feature = "rust1", since = "1.0.0")]
 595 impl<T> ops::IndexMut<ops::RangeFrom<usize>> for [T] {
 596     #[inline]
 597     fn index_mut(&mut self, index: ops::RangeFrom<usize>) -> &mut [T] {
 598         let len = self.len();
 599         self.index_mut(ops::Range{ start: index.start, end: len })
 600     }
 601 }
 602 #[stable(feature = "rust1", since = "1.0.0")]
 603 impl<T> ops::IndexMut<RangeFull> for [T] {
 604     #[inline]
 605     fn index_mut(&mut self, _index: RangeFull) -> &mut [T] {
 606         self
 607     }
 608 }
 609
 610
 611 ////////////////////////////////////////////////////////////////////////////////
 612 // Common traits
 613 ////////////////////////////////////////////////////////////////////////////////
 614
 615 #[stable(feature = "rust1", since = "1.0.0")]
 616 impl<'a, T> Default for &'a [T] {
 617     fn default() -> &'a [T] { &[] }
 618 }
 619
 620 #[stable(feature = "mut_slice_default", since = "1.5.0")]
 621 impl<'a, T> Default for &'a mut [T] {
 622     fn default() -> &'a mut [T] { &mut [] }
 623 }
 624
 625 //
 626 // Iterators
 627 //
 628
 629 #[stable(feature = "rust1", since = "1.0.0")]
 630 impl<'a, T> IntoIterator for &'a [T] {
 631     type Item = &'a T;
 632     type IntoIter = Iter<'a, T>;
 633
 634     fn into_iter(self) -> Iter<'a, T> {
 635         self.iter()
 636     }
 637 }
 638
 639 #[stable(feature = "rust1", since = "1.0.0")]
 640 impl<'a, T> IntoIterator for &'a mut [T] {
 641     type Item = &'a mut T;
 642     type IntoIter = IterMut<'a, T>;
 643
 644     fn into_iter(self) -> IterMut<'a, T> {
 645         self.iter_mut()
 646     }
 647 }
 648
 649 #[inline(always)]
 650 fn size_from_ptr<T>(_: *const T) -> usize {
 651     mem::size_of::<T>()
 652 }
 653
 654 // The shared definition of the `Iter` and `IterMut` iterators
 655 macro_rules! iterator {
 656     (struct $name:ident -> $ptr:ty, $elem:ty) => {
 657         #[stable(feature = "rust1", since = "1.0.0")]
 658         impl<'a, T> Iterator for $name<'a, T> {
 659             type Item = $elem;
 660
 661             #[inline]
 662             fn next(&mut self) -> Option<$elem> {
 663                 // could be implemented with slices, but this avoids bounds checks
 664                 unsafe {
 665                     if mem::size_of::<T>() != 0 {
 666                         assume(!self.ptr.is_null());
 667                         assume(!self.end.is_null());
 668                     }
 669                     if self.ptr == self.end {
 670                         None
 671                     } else {
 672                         let old = self.ptr;
 673                         self.ptr = slice_offset!(self.ptr, 1);
 674                         Some(slice_ref!(old))
 675                     }
 676                 }
 677             }
 678
 679             #[inline]
 680             fn size_hint(&self) -> (usize, Option<usize>) {
 681                 let diff = (self.end as usize).wrapping_sub(self.ptr as usize);
 682                 let size = mem::size_of::<T>();
 683                 let exact = diff / (if size == 0 {1} else {size});
 684                 (exact, Some(exact))
 685             }
 686
 687             #[inline]
 688             fn count(self) -> usize {
 689                 self.size_hint().0
 690             }
 691
 692             #[inline]
 693             fn nth(&mut self, n: usize) -> Option<$elem> {
 694                 // Call helper method. Can't put the definition here because mut versus const.
 695                 self.iter_nth(n)
 696             }
 697
 698             #[inline]
 699             fn last(mut self) -> Option<$elem> {
 700                 self.next_back()
 701             }
 702         }
 703
 704         #[stable(feature = "rust1", since = "1.0.0")]
 705         impl<'a, T> DoubleEndedIterator for $name<'a, T> {
 706             #[inline]
 707             fn next_back(&mut self) -> Option<$elem> {
 708                 // could be implemented with slices, but this avoids bounds checks
 709                 unsafe {
 710                     if mem::size_of::<T>() != 0 {
 711                         assume(!self.ptr.is_null());
 712                         assume(!self.end.is_null());
 713                     }
 714                     if self.end == self.ptr {
 715                         None
 716                     } else {
 717                         self.end = slice_offset!(self.end, -1);
 718                         Some(slice_ref!(self.end))
 719                     }
 720                 }
 721             }
 722         }
 723     }
 724 }
 725
 726 macro_rules! make_slice {
 727     ($start: expr, $end: expr) => {{
 728         let start = $start;
 729         let diff = ($end as usize).wrapping_sub(start as usize);
 730         if size_from_ptr(start) == 0 {
 731             // use a non-null pointer value
 732             unsafe { from_raw_parts(1 as *const _, diff) }
 733         } else {
 734             let len = diff / size_from_ptr(start);
 735             unsafe { from_raw_parts(start, len) }
 736         }
 737     }}
 738 }
 739
 740 macro_rules! make_mut_slice {
 741     ($start: expr, $end: expr) => {{
 742         let start = $start;
 743         let diff = ($end as usize).wrapping_sub(start as usize);
 744         if size_from_ptr(start) == 0 {
 745             // use a non-null pointer value
 746             unsafe { from_raw_parts_mut(1 as *mut _, diff) }
 747         } else {
 748             let len = diff / size_from_ptr(start);
 749             unsafe { from_raw_parts_mut(start, len) }
 750         }
 751     }}
 752 }
 753
 754 /// Immutable slice iterator
 755 #[stable(feature = "rust1", since = "1.0.0")]
 756 pub struct Iter<'a, T: 'a> {
 757     ptr: *const T,
 758     end: *const T,
 759     _marker: marker::PhantomData<&'a T>,
 760 }
 761
 762 #[stable(feature = "rust1", since = "1.0.0")]
 763 unsafe impl<'a, T: Sync> Sync for Iter<'a, T> {}
 764 #[stable(feature = "rust1", since = "1.0.0")]
 765 unsafe impl<'a, T: Sync> Send for Iter<'a, T> {}
 766
 767 impl<'a, T> Iter<'a, T> {
 768     /// View the underlying data as a subslice of the original data.
 769     ///
 770     /// This has the same lifetime as the original slice, and so the
 771     /// iterator can continue to be used while this exists.
 772     #[stable(feature = "iter_to_slice", since = "1.4.0")]
 773     pub fn as_slice(&self) -> &'a [T] {
 774         make_slice!(self.ptr, self.end)
 775     }
 776
 777     // Helper function for Iter::nth
 778     fn iter_nth(&mut self, n: usize) -> Option<&'a T> {
 779         match self.as_slice().get(n) {
 780             Some(elem_ref) => unsafe {
 781                 self.ptr = slice_offset!(self.ptr, (n as isize).wrapping_add(1));
 782                 Some(elem_ref)
 783             },
 784             None => {
 785                 self.ptr = self.end;
 786                 None
 787             }
 788         }
 789     }
 790 }
 791
 792 iterator!{struct Iter -> *const T, &'a T}
 793
 794 #[stable(feature = "rust1", since = "1.0.0")]
 795 impl<'a, T> ExactSizeIterator for Iter<'a, T> {}
 796
 797 #[stable(feature = "rust1", since = "1.0.0")]
 798 impl<'a, T> Clone for Iter<'a, T> {
 799     fn clone(&self) -> Iter<'a, T> { Iter { ptr: self.ptr, end: self.end, _marker: self._marker } }
 800 }
 801
 802 /// Mutable slice iterator.
 803 #[stable(feature = "rust1", since = "1.0.0")]
 804 pub struct IterMut<'a, T: 'a> {
 805     ptr: *mut T,
 806     end: *mut T,
 807     _marker: marker::PhantomData<&'a mut T>,
 808 }
 809
 810 #[stable(feature = "rust1", since = "1.0.0")]
 811 unsafe impl<'a, T: Sync> Sync for IterMut<'a, T> {}
 812 #[stable(feature = "rust1", since = "1.0.0")]
 813 unsafe impl<'a, T: Send> Send for IterMut<'a, T> {}
 814
 815 impl<'a, T> IterMut<'a, T> {
 816     /// View the underlying data as a subslice of the original data.
 817     ///
 818     /// To avoid creating `&mut` references that alias, this is forced
 819     /// to consume the iterator. Consider using the `Slice` and
 820     /// `SliceMut` implementations for obtaining slices with more
 821     /// restricted lifetimes that do not consume the iterator.
 822     #[stable(feature = "iter_to_slice", since = "1.4.0")]
 823     pub fn into_slice(self) -> &'a mut [T] {
 824         make_mut_slice!(self.ptr, self.end)
 825     }
 826
 827     // Helper function for IterMut::nth
 828     fn iter_nth(&mut self, n: usize) -> Option<&'a mut T> {
 829         match make_mut_slice!(self.ptr, self.end).get_mut(n) {
 830             Some(elem_ref) => unsafe {
 831                 self.ptr = slice_offset!(self.ptr, (n as isize).wrapping_add(1));
 832                 Some(elem_ref)
 833             },
 834             None => {
 835                 self.ptr = self.end;
 836                 None
 837             }
 838         }
 839     }
 840 }
 841
 842 iterator!{struct IterMut -> *mut T, &'a mut T}
 843
 844 #[stable(feature = "rust1", since = "1.0.0")]
 845 impl<'a, T> ExactSizeIterator for IterMut<'a, T> {}
 846
 847 /// An internal abstraction over the splitting iterators, so that
 848 /// splitn, splitn_mut etc can be implemented once.
 849 trait SplitIter: DoubleEndedIterator {
 850     /// Mark the underlying iterator as complete, extracting the remaining
 851     /// portion of the slice.
 852     fn finish(&mut self) -> Option<Self::Item>;
 853 }
 854
 855 /// An iterator over subslices separated by elements that match a predicate
 856 /// function.
 857 #[stable(feature = "rust1", since = "1.0.0")]
 858 pub struct Split<'a, T:'a, P> where P: FnMut(&T) -> bool {
 859     v: &'a [T],
 860     pred: P,
 861     finished: bool
 862 }
 863
 864 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
 865 #[stable(feature = "rust1", since = "1.0.0")]
 866 impl<'a, T, P> Clone for Split<'a, T, P> where P: Clone + FnMut(&T) -> bool {
 867     fn clone(&self) -> Split<'a, T, P> {
 868         Split {
 869             v: self.v,
 870             pred: self.pred.clone(),
 871             finished: self.finished,
 872         }
 873     }
 874 }
 875
 876 #[stable(feature = "rust1", since = "1.0.0")]
 877 impl<'a, T, P> Iterator for Split<'a, T, P> where P: FnMut(&T) -> bool {
 878     type Item = &'a [T];
 879
 880     #[inline]
 881     fn next(&mut self) -> Option<&'a [T]> {
 882         if self.finished { return None; }
 883
 884         match self.v.iter().position(|x| (self.pred)(x)) {
 885             None => self.finish(),
 886             Some(idx) => {
 887                 let ret = Some(&self.v[..idx]);
 888                 self.v = &self.v[idx + 1..];
 889                 ret
 890             }
 891         }
 892     }
 893
 894     #[inline]
 895     fn size_hint(&self) -> (usize, Option<usize>) {
 896         if self.finished {
 897             (0, Some(0))
 898         } else {
 899             (1, Some(self.v.len() + 1))
 900         }
 901     }
 902 }
 903
 904 #[stable(feature = "rust1", since = "1.0.0")]
 905 impl<'a, T, P> DoubleEndedIterator for Split<'a, T, P> where P: FnMut(&T) -> bool {
 906     #[inline]
 907     fn next_back(&mut self) -> Option<&'a [T]> {
 908         if self.finished { return None; }
 909
 910         match self.v.iter().rposition(|x| (self.pred)(x)) {
 911             None => self.finish(),
 912             Some(idx) => {
 913                 let ret = Some(&self.v[idx + 1..]);
 914                 self.v = &self.v[..idx];
 915                 ret
 916             }
 917         }
 918     }
 919 }
 920
 921 impl<'a, T, P> SplitIter for Split<'a, T, P> where P: FnMut(&T) -> bool {
 922     #[inline]
 923     fn finish(&mut self) -> Option<&'a [T]> {
 924         if self.finished { None } else { self.finished = true; Some(self.v) }
 925     }
 926 }
 927
 928 /// An iterator over the subslices of the vector which are separated
 929 /// by elements that match `pred`.
 930 #[stable(feature = "rust1", since = "1.0.0")]
 931 pub struct SplitMut<'a, T:'a, P> where P: FnMut(&T) -> bool {
 932     v: &'a mut [T],
 933     pred: P,
 934     finished: bool
 935 }
 936
 937 impl<'a, T, P> SplitIter for SplitMut<'a, T, P> where P: FnMut(&T) -> bool {
 938     #[inline]
 939     fn finish(&mut self) -> Option<&'a mut [T]> {
 940         if self.finished {
 941             None
 942         } else {
 943             self.finished = true;
 944             Some(mem::replace(&mut self.v, &mut []))
 945         }
 946     }
 947 }
 948
 949 #[stable(feature = "rust1", since = "1.0.0")]
 950 impl<'a, T, P> Iterator for SplitMut<'a, T, P> where P: FnMut(&T) -> bool {
 951     type Item = &'a mut [T];
 952
 953     #[inline]
 954     fn next(&mut self) -> Option<&'a mut [T]> {
 955         if self.finished { return None; }
 956
 957         let idx_opt = { // work around borrowck limitations
 958             let pred = &mut self.pred;
 959             self.v.iter().position(|x| (*pred)(x))
 960         };
 961         match idx_opt {
 962             None => self.finish(),
 963             Some(idx) => {
 964                 let tmp = mem::replace(&mut self.v, &mut []);
 965                 let (head, tail) = tmp.split_at_mut(idx);
 966                 self.v = &mut tail[1..];
 967                 Some(head)
 968             }
 969         }
 970     }
 971
 972     #[inline]
 973     fn size_hint(&self) -> (usize, Option<usize>) {
 974         if self.finished {
 975             (0, Some(0))
 976         } else {
 977             // if the predicate doesn't match anything, we yield one slice
 978             // if it matches every element, we yield len+1 empty slices.
 979             (1, Some(self.v.len() + 1))
 980         }
 981     }
 982 }
 983
 984 #[stable(feature = "rust1", since = "1.0.0")]
 985 impl<'a, T, P> DoubleEndedIterator for SplitMut<'a, T, P> where
 986     P: FnMut(&T) -> bool,
 987 {
 988     #[inline]
 989     fn next_back(&mut self) -> Option<&'a mut [T]> {
 990         if self.finished { return None; }
 991
 992         let idx_opt = { // work around borrowck limitations
 993             let pred = &mut self.pred;
 994             self.v.iter().rposition(|x| (*pred)(x))
 995         };
 996         match idx_opt {
 997             None => self.finish(),
 998             Some(idx) => {
 999                 let tmp = mem::replace(&mut self.v, &mut []);
1000                 let (head, tail) = tmp.split_at_mut(idx);
1001                 self.v = head;
1002                 Some(&mut tail[1..])
1003             }
1004         }
1005     }
1006 }
1007
1008 /// An private iterator over subslices separated by elements that
1009 /// match a predicate function, splitting at most a fixed number of
1010 /// times.
1011 struct GenericSplitN<I> {
1012     iter: I,
1013     count: usize,
1014     invert: bool
1015 }
1016
1017 impl<T, I: SplitIter<Item=T>> Iterator for GenericSplitN<I> {
1018     type Item = T;
1019
1020     #[inline]
1021     fn next(&mut self) -> Option<T> {
1022         match self.count {
1023             0 => None,
1024             1 => { self.count -= 1; self.iter.finish() }
1025             _ => {
1026                 self.count -= 1;
1027                 if self.invert {self.iter.next_back()} else {self.iter.next()}
1028             }
1029         }
1030     }
1031
1032     #[inline]
1033     fn size_hint(&self) -> (usize, Option<usize>) {
1034         let (lower, upper_opt) = self.iter.size_hint();
1035         (lower, upper_opt.map(|upper| cmp::min(self.count, upper)))
1036     }
1037 }
1038
1039 /// An iterator over subslices separated by elements that match a predicate
1040 /// function, limited to a given number of splits.
1041 #[stable(feature = "rust1", since = "1.0.0")]
1042 pub struct SplitN<'a, T: 'a, P> where P: FnMut(&T) -> bool {
1043     inner: GenericSplitN<Split<'a, T, P>>
1044 }
1045
1046 /// An iterator over subslices separated by elements that match a
1047 /// predicate function, limited to a given number of splits, starting
1048 /// from the end of the slice.
1049 #[stable(feature = "rust1", since = "1.0.0")]
1050 pub struct RSplitN<'a, T: 'a, P> where P: FnMut(&T) -> bool {
1051     inner: GenericSplitN<Split<'a, T, P>>
1052 }
1053
1054 /// An iterator over subslices separated by elements that match a predicate
1055 /// function, limited to a given number of splits.
1056 #[stable(feature = "rust1", since = "1.0.0")]
1057 pub struct SplitNMut<'a, T: 'a, P> where P: FnMut(&T) -> bool {
1058     inner: GenericSplitN<SplitMut<'a, T, P>>
1059 }
1060
1061 /// An iterator over subslices separated by elements that match a
1062 /// predicate function, limited to a given number of splits, starting
1063 /// from the end of the slice.
1064 #[stable(feature = "rust1", since = "1.0.0")]
1065 pub struct RSplitNMut<'a, T: 'a, P> where P: FnMut(&T) -> bool {
1066     inner: GenericSplitN<SplitMut<'a, T, P>>
1067 }
1068
1069 macro_rules! forward_iterator {
1070     ($name:ident: $elem:ident, $iter_of:ty) => {
1071         #[stable(feature = "rust1", since = "1.0.0")]
1072         impl<'a, $elem, P> Iterator for $name<'a, $elem, P> where
1073             P: FnMut(&T) -> bool
1074         {
1075             type Item = $iter_of;
1076
1077             #[inline]
1078             fn next(&mut self) -> Option<$iter_of> {
1079                 self.inner.next()
1080             }
1081
1082             #[inline]
1083             fn size_hint(&self) -> (usize, Option<usize>) {
1084                 self.inner.size_hint()
1085             }
1086         }
1087     }
1088 }
1089
1090 forward_iterator! { SplitN: T, &'a [T] }
1091 forward_iterator! { RSplitN: T, &'a [T] }
1092 forward_iterator! { SplitNMut: T, &'a mut [T] }
1093 forward_iterator! { RSplitNMut: T, &'a mut [T] }
1094
1095 /// An iterator over overlapping subslices of length `size`.
1096 #[stable(feature = "rust1", since = "1.0.0")]
1097 pub struct Windows<'a, T:'a> {
1098     v: &'a [T],
1099     size: usize
1100 }
1101
1102 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
1103 #[stable(feature = "rust1", since = "1.0.0")]
1104 impl<'a, T> Clone for Windows<'a, T> {
1105     fn clone(&self) -> Windows<'a, T> {
1106         Windows {
1107             v: self.v,
1108             size: self.size,
1109         }
1110     }
1111 }
1112
1113 #[stable(feature = "rust1", since = "1.0.0")]
1114 impl<'a, T> Iterator for Windows<'a, T> {
1115     type Item = &'a [T];
1116
1117     #[inline]
1118     fn next(&mut self) -> Option<&'a [T]> {
1119         if self.size > self.v.len() {
1120             None
1121         } else {
1122             let ret = Some(&self.v[..self.size]);
1123             self.v = &self.v[1..];
1124             ret
1125         }
1126     }
1127
1128     #[inline]
1129     fn size_hint(&self) -> (usize, Option<usize>) {
1130         if self.size > self.v.len() {
1131             (0, Some(0))
1132         } else {
1133             let size = self.v.len() - self.size + 1;
1134             (size, Some(size))
1135         }
1136     }
1137
1138     #[inline]
1139     fn count(self) -> usize {
1140         self.size_hint().0
1141     }
1142
1143     #[inline]
1144     fn nth(&mut self, n: usize) -> Option<Self::Item> {
1145         let (end, overflow) = self.size.overflowing_add(n);
1146         if end > self.v.len() || overflow {
1147             self.v = &[];
1148             None
1149         } else {
1150             let nth = &self.v[n..end];
1151             self.v = &self.v[n+1..];
1152             Some(nth)
1153         }
1154     }
1155
1156     #[inline]
1157     fn last(self) -> Option<Self::Item> {
1158         if self.size > self.v.len() {
1159             None
1160         } else {
1161             let start = self.v.len() - self.size;
1162             Some(&self.v[start..])
1163         }
1164     }
1165 }
1166
1167 #[stable(feature = "rust1", since = "1.0.0")]
1168 impl<'a, T> DoubleEndedIterator for Windows<'a, T> {
1169     #[inline]
1170     fn next_back(&mut self) -> Option<&'a [T]> {
1171         if self.size > self.v.len() {
1172             None
1173         } else {
1174             let ret = Some(&self.v[self.v.len()-self.size..]);
1175             self.v = &self.v[..self.v.len()-1];
1176             ret
1177         }
1178     }
1179 }
1180
1181 #[stable(feature = "rust1", since = "1.0.0")]
1182 impl<'a, T> ExactSizeIterator for Windows<'a, T> {}
1183
1184 /// An iterator over a slice in (non-overlapping) chunks (`size` elements at a
1185 /// time).
1186 ///
1187 /// When the slice len is not evenly divided by the chunk size, the last slice
1188 /// of the iteration will be the remainder.
1189 #[stable(feature = "rust1", since = "1.0.0")]
1190 pub struct Chunks<'a, T:'a> {
1191     v: &'a [T],
1192     size: usize
1193 }
1194
1195 // FIXME(#19839) Remove in favor of `#[derive(Clone)]`
1196 #[stable(feature = "rust1", since = "1.0.0")]
1197 impl<'a, T> Clone for Chunks<'a, T> {
1198     fn clone(&self) -> Chunks<'a, T> {
1199         Chunks {
1200             v: self.v,
1201             size: self.size,
1202         }
1203     }
1204 }
1205
1206 #[stable(feature = "rust1", since = "1.0.0")]
1207 impl<'a, T> Iterator for Chunks<'a, T> {
1208     type Item = &'a [T];
1209
1210     #[inline]
1211     fn next(&mut self) -> Option<&'a [T]> {
1212         if self.v.is_empty() {
1213             None
1214         } else {
1215             let chunksz = cmp::min(self.v.len(), self.size);
1216             let (fst, snd) = self.v.split_at(chunksz);
1217             self.v = snd;
1218             Some(fst)
1219         }
1220     }
1221
1222     #[inline]
1223     fn size_hint(&self) -> (usize, Option<usize>) {
1224         if self.v.is_empty() {
1225             (0, Some(0))
1226         } else {
1227             let n = self.v.len() / self.size;
1228             let rem = self.v.len() % self.size;
1229             let n = if rem > 0 { n+1 } else { n };
1230             (n, Some(n))
1231         }
1232     }
1233
1234     #[inline]
1235     fn count(self) -> usize {
1236         self.size_hint().0
1237     }
1238
1239     #[inline]
1240     fn nth(&mut self, n: usize) -> Option<Self::Item> {
1241         let (start, overflow) = n.overflowing_mul(self.size);
1242         if start >= self.v.len() || overflow {
1243             self.v = &[];
1244             None
1245         } else {
1246             let end = match start.checked_add(self.size) {
1247                 Some(sum) => cmp::min(self.v.len(), sum),
1248                 None => self.v.len(),
1249             };
1250             let nth = &self.v[start..end];
1251             self.v = &self.v[end..];
1252             Some(nth)
1253         }
1254     }
1255
1256     #[inline]
1257     fn last(self) -> Option<Self::Item> {
1258         if self.v.is_empty() {
1259             None
1260         } else {
1261             let start = (self.v.len() - 1) / self.size * self.size;
1262             Some(&self.v[start..])
1263         }
1264     }
1265 }
1266
1267 #[stable(feature = "rust1", since = "1.0.0")]
1268 impl<'a, T> DoubleEndedIterator for Chunks<'a, T> {
1269     #[inline]
1270     fn next_back(&mut self) -> Option<&'a [T]> {
1271         if self.v.is_empty() {
1272             None
1273         } else {
1274             let remainder = self.v.len() % self.size;
1275             let chunksz = if remainder != 0 { remainder } else { self.size };
1276             let (fst, snd) = self.v.split_at(self.v.len() - chunksz);
1277             self.v = fst;
1278             Some(snd)
1279         }
1280     }
1281 }
1282
1283 #[stable(feature = "rust1", since = "1.0.0")]
1284 impl<'a, T> ExactSizeIterator for Chunks<'a, T> {}
1285
1286 /// An iterator over a slice in (non-overlapping) mutable chunks (`size`
1287 /// elements at a time). When the slice len is not evenly divided by the chunk
1288 /// size, the last slice of the iteration will be the remainder.
1289 #[stable(feature = "rust1", since = "1.0.0")]
1290 pub struct ChunksMut<'a, T:'a> {
1291     v: &'a mut [T],
1292     chunk_size: usize
1293 }
1294
1295 #[stable(feature = "rust1", since = "1.0.0")]
1296 impl<'a, T> Iterator for ChunksMut<'a, T> {
1297     type Item = &'a mut [T];
1298
1299     #[inline]
1300     fn next(&mut self) -> Option<&'a mut [T]> {
1301         if self.v.is_empty() {
1302             None
1303         } else {
1304             let sz = cmp::min(self.v.len(), self.chunk_size);
1305             let tmp = mem::replace(&mut self.v, &mut []);
1306             let (head, tail) = tmp.split_at_mut(sz);
1307             self.v = tail;
1308             Some(head)
1309         }
1310     }
1311
1312     #[inline]
1313     fn size_hint(&self) -> (usize, Option<usize>) {
1314         if self.v.is_empty() {
1315             (0, Some(0))
1316         } else {
1317             let n = self.v.len() / self.chunk_size;
1318             let rem = self.v.len() % self.chunk_size;
1319             let n = if rem > 0 { n + 1 } else { n };
1320             (n, Some(n))
1321         }
1322     }
1323
1324     #[inline]
1325     fn count(self) -> usize {
1326         self.size_hint().0
1327     }
1328
1329     #[inline]
1330     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
1331         let (start, overflow) = n.overflowing_mul(self.chunk_size);
1332         if start >= self.v.len() || overflow {
1333             self.v = &mut [];
1334             None
1335         } else {
1336             let end = match start.checked_add(self.chunk_size) {
1337                 Some(sum) => cmp::min(self.v.len(), sum),
1338                 None => self.v.len(),
1339             };
1340             let tmp = mem::replace(&mut self.v, &mut []);
1341             let (head, tail) = tmp.split_at_mut(end);
1342             let (_, nth) =  head.split_at_mut(start);
1343             self.v = tail;
1344             Some(nth)
1345         }
1346     }
1347
1348     #[inline]
1349     fn last(self) -> Option<Self::Item> {
1350         if self.v.is_empty() {
1351             None
1352         } else {
1353             let start = (self.v.len() - 1) / self.chunk_size * self.chunk_size;
1354             Some(&mut self.v[start..])
1355         }
1356     }
1357 }
1358
1359 #[stable(feature = "rust1", since = "1.0.0")]
1360 impl<'a, T> DoubleEndedIterator for ChunksMut<'a, T> {
1361     #[inline]
1362     fn next_back(&mut self) -> Option<&'a mut [T]> {
1363         if self.v.is_empty() {
1364             None
1365         } else {
1366             let remainder = self.v.len() % self.chunk_size;
1367             let sz = if remainder != 0 { remainder } else { self.chunk_size };
1368             let tmp = mem::replace(&mut self.v, &mut []);
1369             let tmp_len = tmp.len();
1370             let (head, tail) = tmp.split_at_mut(tmp_len - sz);
1371             self.v = head;
1372             Some(tail)
1373         }
1374     }
1375 }
1376
1377 #[stable(feature = "rust1", since = "1.0.0")]
1378 impl<'a, T> ExactSizeIterator for ChunksMut<'a, T> {}
1379
1380 //
1381 // Free functions
1382 //
1383
1384 /// Forms a slice from a pointer and a length.
1385 ///
1386 /// The `len` argument is the number of **elements**, not the number of bytes.
1387 ///
1388 /// # Safety
1389 ///
1390 /// This function is unsafe as there is no guarantee that the given pointer is
1391 /// valid for `len` elements, nor whether the lifetime inferred is a suitable
1392 /// lifetime for the returned slice.
1393 ///
1394 /// `p` must be non-null, even for zero-length slices.
1395 ///
1396 /// # Caveat
1397 ///
1398 /// The lifetime for the returned slice is inferred from its usage. To
1399 /// prevent accidental misuse, it's suggested to tie the lifetime to whichever
1400 /// source lifetime is safe in the context, such as by providing a helper
1401 /// function taking the lifetime of a host value for the slice, or by explicit
1402 /// annotation.
1403 ///
1404 /// # Examples
1405 ///
1406 /// ```
1407 /// use std::slice;
1408 ///
1409 /// // manifest a slice out of thin air!
1410 /// let ptr = 0x1234 as *const usize;
1411 /// let amt = 10;
1412 /// unsafe {
1413 ///     let slice = slice::from_raw_parts(ptr, amt);
1414 /// }
1415 /// ```
1416 #[inline]
1417 #[stable(feature = "rust1", since = "1.0.0")]
1418 pub unsafe fn from_raw_parts<'a, T>(p: *const T, len: usize) -> &'a [T] {
1419     mem::transmute(RawSlice { data: p, len: len })
1420 }
1421
1422 /// Performs the same functionality as `from_raw_parts`, except that a mutable
1423 /// slice is returned.
1424 ///
1425 /// This function is unsafe for the same reasons as `from_raw_parts`, as well
1426 /// as not being able to provide a non-aliasing guarantee of the returned
1427 /// mutable slice.
1428 #[inline]
1429 #[stable(feature = "rust1", since = "1.0.0")]
1430 pub unsafe fn from_raw_parts_mut<'a, T>(p: *mut T, len: usize) -> &'a mut [T] {
1431     mem::transmute(RawSlice { data: p, len: len })
1432 }
1433
1434 //
1435 // Submodules
1436 //
1437
1438 /// Operations on `[u8]`.
1439 #[unstable(feature = "slice_bytes", reason = "needs review",
1440            issue = "27740")]
1441 #[rustc_deprecated(reason = "unidiomatic functions not pulling their weight",
1442                    since = "1.6.0")]
1443 #[allow(deprecated)]
1444 pub mod bytes {
1445     use ptr;
1446     use slice::SliceExt;
1447
1448     /// A trait for operations on mutable `[u8]`s.
1449     pub trait MutableByteVector {
1450         /// Sets all bytes of the receiver to the given value.
1451         fn set_memory(&mut self, value: u8);
1452     }
1453
1454     impl MutableByteVector for [u8] {
1455         #[inline]
1456         fn set_memory(&mut self, value: u8) {
1457             unsafe { ptr::write_bytes(self.as_mut_ptr(), value, self.len()) };
1458         }
1459     }
1460
1461     /// Copies data from `src` to `dst`
1462     ///
1463     /// Panics if the length of `dst` is less than the length of `src`.
1464     #[inline]
1465     pub fn copy_memory(src: &[u8], dst: &mut [u8]) {
1466         let len_src = src.len();
1467         assert!(dst.len() >= len_src);
1468         // `dst` is unaliasable, so we know statically it doesn't overlap
1469         // with `src`.
1470         unsafe {
1471             ptr::copy_nonoverlapping(src.as_ptr(),
1472                                      dst.as_mut_ptr(),
1473                                      len_src);
1474         }
1475     }
1476 }
1477
1478
1479
1480 //
1481 // Boilerplate traits
1482 //
1483
1484 #[stable(feature = "rust1", since = "1.0.0")]
1485 impl<A, B> PartialEq<[B]> for [A] where A: PartialEq<B> {
1486     fn eq(&self, other: &[B]) -> bool {
1487         if self.len() != other.len() {
1488             return false;
1489         }
1490
1491         for i in 0..self.len() {
1492             if !self[i].eq(&other[i]) {
1493                 return false;
1494             }
1495         }
1496
1497         true
1498     }
1499     fn ne(&self, other: &[B]) -> bool {
1500         if self.len() != other.len() {
1501             return true;
1502         }
1503
1504         for i in 0..self.len() {
1505             if self[i].ne(&other[i]) {
1506                 return true;
1507             }
1508         }
1509
1510         false
1511     }
1512 }
1513
1514 #[stable(feature = "rust1", since = "1.0.0")]
1515 impl<T: Eq> Eq for [T] {}
1516
1517 #[stable(feature = "rust1", since = "1.0.0")]
1518 impl<T: Ord> Ord for [T] {
1519     fn cmp(&self, other: &[T]) -> Ordering {
1520         let l = cmp::min(self.len(), other.len());
1521
1522         // Slice to the loop iteration range to enable bound check
1523         // elimination in the compiler
1524         let lhs = &self[..l];
1525         let rhs = &other[..l];
1526
1527         for i in 0..l {
1528             match lhs[i].cmp(&rhs[i]) {
1529                 Ordering::Equal => (),
1530                 non_eq => return non_eq,
1531             }
1532         }
1533
1534         self.len().cmp(&other.len())
1535     }
1536 }
1537
1538 #[stable(feature = "rust1", since = "1.0.0")]
1539 impl<T: PartialOrd> PartialOrd for [T] {
1540     fn partial_cmp(&self, other: &[T]) -> Option<Ordering> {
1541         let l = cmp::min(self.len(), other.len());
1542
1543         // Slice to the loop iteration range to enable bound check
1544         // elimination in the compiler
1545         let lhs = &self[..l];
1546         let rhs = &other[..l];
1547
1548         for i in 0..l {
1549             match lhs[i].partial_cmp(&rhs[i]) {
1550                 Some(Ordering::Equal) => (),
1551                 non_eq => return non_eq,
1552             }
1553         }
1554
1555         self.len().partial_cmp(&other.len())
1556     }
1557 }