]> git.lizzy.rs Git - rust.git/blob - src/libcore/slice/mod.rs
Merge branch 'master' of https://github.com/VillSnow/rust
[rust.git] / src / libcore / slice / mod.rs
1 // ignore-tidy-filelength
2 // ignore-tidy-undocumented-unsafe
3
4 //! Slice management and manipulation.
5 //!
6 //! For more details see [`std::slice`].
7 //!
8 //! [`std::slice`]: ../../std/slice/index.html
9
10 #![stable(feature = "rust1", since = "1.0.0")]
11
12 // How this module is organized.
13 //
14 // The library infrastructure for slices is fairly messy. There's
15 // a lot of stuff defined here. Let's keep it clean.
16 //
17 // The layout of this file is thus:
18 //
19 // * Inherent methods. This is where most of the slice API resides.
20 // * Implementations of a few common traits with important slice ops.
21 // * Definitions of a bunch of iterators.
22 // * Free functions.
23 // * The `raw` and `bytes` submodules.
24 // * Boilerplate trait implementations.
25
26 use crate::cmp;
27 use crate::cmp::Ordering::{self, Equal, Greater, Less};
28 use crate::fmt;
29 use crate::intrinsics::{assume, exact_div, is_aligned_and_not_null, unchecked_sub};
30 use crate::iter::*;
31 use crate::marker::{self, Copy, Send, Sized, Sync};
32 use crate::mem;
33 use crate::ops::{self, FnMut, Range};
34 use crate::option::Option;
35 use crate::option::Option::{None, Some};
36 use crate::ptr::{self, NonNull};
37 use crate::result::Result;
38 use crate::result::Result::{Err, Ok};
39
40 #[unstable(
41     feature = "slice_internals",
42     issue = "none",
43     reason = "exposed from core to be reused in std; use the memchr crate"
44 )]
45 /// Pure rust memchr implementation, taken from rust-memchr
46 pub mod memchr;
47
48 mod rotate;
49 mod sort;
50
51 //
52 // Extension traits
53 //
54
55 #[lang = "slice"]
56 #[cfg(not(test))]
57 impl<T> [T] {
58     /// Returns the number of elements in the slice.
59     ///
60     /// # Examples
61     ///
62     /// ```
63     /// let a = [1, 2, 3];
64     /// assert_eq!(a.len(), 3);
65     /// ```
66     #[stable(feature = "rust1", since = "1.0.0")]
67     #[rustc_const_stable(feature = "const_slice_len", since = "1.32.0")]
68     #[inline]
69     // SAFETY: const sound because we transmute out the length field as a usize (which it must be)
70     #[allow(unused_attributes)]
71     #[allow_internal_unstable(const_fn_union)]
72     pub const fn len(&self) -> usize {
73         unsafe { crate::ptr::Repr { rust: self }.raw.len }
74     }
75
76     /// Returns `true` if the slice has a length of 0.
77     ///
78     /// # Examples
79     ///
80     /// ```
81     /// let a = [1, 2, 3];
82     /// assert!(!a.is_empty());
83     /// ```
84     #[stable(feature = "rust1", since = "1.0.0")]
85     #[rustc_const_stable(feature = "const_slice_is_empty", since = "1.32.0")]
86     #[inline]
87     pub const fn is_empty(&self) -> bool {
88         self.len() == 0
89     }
90
91     /// Returns the first element of the slice, or `None` if it is empty.
92     ///
93     /// # Examples
94     ///
95     /// ```
96     /// let v = [10, 40, 30];
97     /// assert_eq!(Some(&10), v.first());
98     ///
99     /// let w: &[i32] = &[];
100     /// assert_eq!(None, w.first());
101     /// ```
102     #[stable(feature = "rust1", since = "1.0.0")]
103     #[inline]
104     pub fn first(&self) -> Option<&T> {
105         if let [first, ..] = self { Some(first) } else { None }
106     }
107
108     /// Returns a mutable pointer to the first element of the slice, or `None` if it is empty.
109     ///
110     /// # Examples
111     ///
112     /// ```
113     /// let x = &mut [0, 1, 2];
114     ///
115     /// if let Some(first) = x.first_mut() {
116     ///     *first = 5;
117     /// }
118     /// assert_eq!(x, &[5, 1, 2]);
119     /// ```
120     #[stable(feature = "rust1", since = "1.0.0")]
121     #[inline]
122     pub fn first_mut(&mut self) -> Option<&mut T> {
123         if let [first, ..] = self { Some(first) } else { None }
124     }
125
126     /// Returns the first and all the rest of the elements of the slice, or `None` if it is empty.
127     ///
128     /// # Examples
129     ///
130     /// ```
131     /// let x = &[0, 1, 2];
132     ///
133     /// if let Some((first, elements)) = x.split_first() {
134     ///     assert_eq!(first, &0);
135     ///     assert_eq!(elements, &[1, 2]);
136     /// }
137     /// ```
138     #[stable(feature = "slice_splits", since = "1.5.0")]
139     #[inline]
140     pub fn split_first(&self) -> Option<(&T, &[T])> {
141         if let [first, tail @ ..] = self { Some((first, tail)) } else { None }
142     }
143
144     /// Returns the first and all the rest of the elements of the slice, or `None` if it is empty.
145     ///
146     /// # Examples
147     ///
148     /// ```
149     /// let x = &mut [0, 1, 2];
150     ///
151     /// if let Some((first, elements)) = x.split_first_mut() {
152     ///     *first = 3;
153     ///     elements[0] = 4;
154     ///     elements[1] = 5;
155     /// }
156     /// assert_eq!(x, &[3, 4, 5]);
157     /// ```
158     #[stable(feature = "slice_splits", since = "1.5.0")]
159     #[inline]
160     pub fn split_first_mut(&mut self) -> Option<(&mut T, &mut [T])> {
161         if let [first, tail @ ..] = self { Some((first, tail)) } else { None }
162     }
163
164     /// Returns the last and all the rest of the elements of the slice, or `None` if it is empty.
165     ///
166     /// # Examples
167     ///
168     /// ```
169     /// let x = &[0, 1, 2];
170     ///
171     /// if let Some((last, elements)) = x.split_last() {
172     ///     assert_eq!(last, &2);
173     ///     assert_eq!(elements, &[0, 1]);
174     /// }
175     /// ```
176     #[stable(feature = "slice_splits", since = "1.5.0")]
177     #[inline]
178     pub fn split_last(&self) -> Option<(&T, &[T])> {
179         if let [init @ .., last] = self { Some((last, init)) } else { None }
180     }
181
182     /// Returns the last and all the rest of the elements of the slice, or `None` if it is empty.
183     ///
184     /// # Examples
185     ///
186     /// ```
187     /// let x = &mut [0, 1, 2];
188     ///
189     /// if let Some((last, elements)) = x.split_last_mut() {
190     ///     *last = 3;
191     ///     elements[0] = 4;
192     ///     elements[1] = 5;
193     /// }
194     /// assert_eq!(x, &[4, 5, 3]);
195     /// ```
196     #[stable(feature = "slice_splits", since = "1.5.0")]
197     #[inline]
198     pub fn split_last_mut(&mut self) -> Option<(&mut T, &mut [T])> {
199         if let [init @ .., last] = self { Some((last, init)) } else { None }
200     }
201
202     /// Returns the last element of the slice, or `None` if it is empty.
203     ///
204     /// # Examples
205     ///
206     /// ```
207     /// let v = [10, 40, 30];
208     /// assert_eq!(Some(&30), v.last());
209     ///
210     /// let w: &[i32] = &[];
211     /// assert_eq!(None, w.last());
212     /// ```
213     #[stable(feature = "rust1", since = "1.0.0")]
214     #[inline]
215     pub fn last(&self) -> Option<&T> {
216         if let [.., last] = self { Some(last) } else { None }
217     }
218
219     /// Returns a mutable pointer to the last item in the slice.
220     ///
221     /// # Examples
222     ///
223     /// ```
224     /// let x = &mut [0, 1, 2];
225     ///
226     /// if let Some(last) = x.last_mut() {
227     ///     *last = 10;
228     /// }
229     /// assert_eq!(x, &[0, 1, 10]);
230     /// ```
231     #[stable(feature = "rust1", since = "1.0.0")]
232     #[inline]
233     pub fn last_mut(&mut self) -> Option<&mut T> {
234         if let [.., last] = self { Some(last) } else { None }
235     }
236
237     /// Returns a reference to an element or subslice depending on the type of
238     /// index.
239     ///
240     /// - If given a position, returns a reference to the element at that
241     ///   position or `None` if out of bounds.
242     /// - If given a range, returns the subslice corresponding to that range,
243     ///   or `None` if out of bounds.
244     ///
245     /// # Examples
246     ///
247     /// ```
248     /// let v = [10, 40, 30];
249     /// assert_eq!(Some(&40), v.get(1));
250     /// assert_eq!(Some(&[10, 40][..]), v.get(0..2));
251     /// assert_eq!(None, v.get(3));
252     /// assert_eq!(None, v.get(0..4));
253     /// ```
254     #[stable(feature = "rust1", since = "1.0.0")]
255     #[inline]
256     pub fn get<I>(&self, index: I) -> Option<&I::Output>
257     where
258         I: SliceIndex<Self>,
259     {
260         index.get(self)
261     }
262
263     /// Returns a mutable reference to an element or subslice depending on the
264     /// type of index (see [`get`]) or `None` if the index is out of bounds.
265     ///
266     /// [`get`]: #method.get
267     ///
268     /// # Examples
269     ///
270     /// ```
271     /// let x = &mut [0, 1, 2];
272     ///
273     /// if let Some(elem) = x.get_mut(1) {
274     ///     *elem = 42;
275     /// }
276     /// assert_eq!(x, &[0, 42, 2]);
277     /// ```
278     #[stable(feature = "rust1", since = "1.0.0")]
279     #[inline]
280     pub fn get_mut<I>(&mut self, index: I) -> Option<&mut I::Output>
281     where
282         I: SliceIndex<Self>,
283     {
284         index.get_mut(self)
285     }
286
287     /// Returns a reference to an element or subslice, without doing bounds
288     /// checking.
289     ///
290     /// This is generally not recommended, use with caution!
291     /// Calling this method with an out-of-bounds index is *[undefined behavior]*
292     /// even if the resulting reference is not used.
293     /// For a safe alternative see [`get`].
294     ///
295     /// [`get`]: #method.get
296     /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
297     ///
298     /// # Examples
299     ///
300     /// ```
301     /// let x = &[1, 2, 4];
302     ///
303     /// unsafe {
304     ///     assert_eq!(x.get_unchecked(1), &2);
305     /// }
306     /// ```
307     #[stable(feature = "rust1", since = "1.0.0")]
308     #[inline]
309     pub unsafe fn get_unchecked<I>(&self, index: I) -> &I::Output
310     where
311         I: SliceIndex<Self>,
312     {
313         index.get_unchecked(self)
314     }
315
316     /// Returns a mutable reference to an element or subslice, without doing
317     /// bounds checking.
318     ///
319     /// This is generally not recommended, use with caution!
320     /// Calling this method with an out-of-bounds index is *[undefined behavior]*
321     /// even if the resulting reference is not used.
322     /// For a safe alternative see [`get_mut`].
323     ///
324     /// [`get_mut`]: #method.get_mut
325     /// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
326     ///
327     /// # Examples
328     ///
329     /// ```
330     /// let x = &mut [1, 2, 4];
331     ///
332     /// unsafe {
333     ///     let elem = x.get_unchecked_mut(1);
334     ///     *elem = 13;
335     /// }
336     /// assert_eq!(x, &[1, 13, 4]);
337     /// ```
338     #[stable(feature = "rust1", since = "1.0.0")]
339     #[inline]
340     pub unsafe fn get_unchecked_mut<I>(&mut self, index: I) -> &mut I::Output
341     where
342         I: SliceIndex<Self>,
343     {
344         index.get_unchecked_mut(self)
345     }
346
347     /// Returns a raw pointer to the slice's buffer.
348     ///
349     /// The caller must ensure that the slice outlives the pointer this
350     /// function returns, or else it will end up pointing to garbage.
351     ///
352     /// The caller must also ensure that the memory the pointer (non-transitively) points to
353     /// is never written to (except inside an `UnsafeCell`) using this pointer or any pointer
354     /// derived from it. If you need to mutate the contents of the slice, use [`as_mut_ptr`].
355     ///
356     /// Modifying the container referenced by this slice may cause its buffer
357     /// to be reallocated, which would also make any pointers to it invalid.
358     ///
359     /// # Examples
360     ///
361     /// ```
362     /// let x = &[1, 2, 4];
363     /// let x_ptr = x.as_ptr();
364     ///
365     /// unsafe {
366     ///     for i in 0..x.len() {
367     ///         assert_eq!(x.get_unchecked(i), &*x_ptr.add(i));
368     ///     }
369     /// }
370     /// ```
371     ///
372     /// [`as_mut_ptr`]: #method.as_mut_ptr
373     #[stable(feature = "rust1", since = "1.0.0")]
374     #[rustc_const_stable(feature = "const_slice_as_ptr", since = "1.32.0")]
375     #[inline]
376     pub const fn as_ptr(&self) -> *const T {
377         self as *const [T] as *const T
378     }
379
380     /// Returns an unsafe mutable pointer to the slice's buffer.
381     ///
382     /// The caller must ensure that the slice outlives the pointer this
383     /// function returns, or else it will end up pointing to garbage.
384     ///
385     /// Modifying the container referenced by this slice may cause its buffer
386     /// to be reallocated, which would also make any pointers to it invalid.
387     ///
388     /// # Examples
389     ///
390     /// ```
391     /// let x = &mut [1, 2, 4];
392     /// let x_ptr = x.as_mut_ptr();
393     ///
394     /// unsafe {
395     ///     for i in 0..x.len() {
396     ///         *x_ptr.add(i) += 2;
397     ///     }
398     /// }
399     /// assert_eq!(x, &[3, 4, 6]);
400     /// ```
401     #[stable(feature = "rust1", since = "1.0.0")]
402     #[inline]
403     pub fn as_mut_ptr(&mut self) -> *mut T {
404         self as *mut [T] as *mut T
405     }
406
407     /// Returns the two raw pointers spanning the slice.
408     ///
409     /// The returned range is half-open, which means that the end pointer
410     /// points *one past* the last element of the slice. This way, an empty
411     /// slice is represented by two equal pointers, and the difference between
412     /// the two pointers represents the size of the slice.
413     ///
414     /// See [`as_ptr`] for warnings on using these pointers. The end pointer
415     /// requires extra caution, as it does not point to a valid element in the
416     /// slice.
417     ///
418     /// This function is useful for interacting with foreign interfaces which
419     /// use two pointers to refer to a range of elements in memory, as is
420     /// common in C++.
421     ///
422     /// It can also be useful to check if a pointer to an element refers to an
423     /// element of this slice:
424     ///
425     /// ```
426     /// #![feature(slice_ptr_range)]
427     ///
428     /// let a = [1, 2, 3];
429     /// let x = &a[1] as *const _;
430     /// let y = &5 as *const _;
431     ///
432     /// assert!(a.as_ptr_range().contains(&x));
433     /// assert!(!a.as_ptr_range().contains(&y));
434     /// ```
435     ///
436     /// [`as_ptr`]: #method.as_ptr
437     #[unstable(feature = "slice_ptr_range", issue = "65807")]
438     #[inline]
439     pub fn as_ptr_range(&self) -> Range<*const T> {
440         // The `add` here is safe, because:
441         //
442         //   - Both pointers are part of the same object, as pointing directly
443         //     past the object also counts.
444         //
445         //   - The size of the slice is never larger than isize::MAX bytes, as
446         //     noted here:
447         //       - https://github.com/rust-lang/unsafe-code-guidelines/issues/102#issuecomment-473340447
448         //       - https://doc.rust-lang.org/reference/behavior-considered-undefined.html
449         //       - https://doc.rust-lang.org/core/slice/fn.from_raw_parts.html#safety
450         //     (This doesn't seem normative yet, but the very same assumption is
451         //     made in many places, including the Index implementation of slices.)
452         //
453         //   - There is no wrapping around involved, as slices do not wrap past
454         //     the end of the address space.
455         //
456         // See the documentation of pointer::add.
457         let start = self.as_ptr();
458         let end = unsafe { start.add(self.len()) };
459         start..end
460     }
461
462     /// Returns the two unsafe mutable pointers spanning the slice.
463     ///
464     /// The returned range is half-open, which means that the end pointer
465     /// points *one past* the last element of the slice. This way, an empty
466     /// slice is represented by two equal pointers, and the difference between
467     /// the two pointers represents the size of the slice.
468     ///
469     /// See [`as_mut_ptr`] for warnings on using these pointers. The end
470     /// pointer requires extra caution, as it does not point to a valid element
471     /// in the slice.
472     ///
473     /// This function is useful for interacting with foreign interfaces which
474     /// use two pointers to refer to a range of elements in memory, as is
475     /// common in C++.
476     ///
477     /// [`as_mut_ptr`]: #method.as_mut_ptr
478     #[unstable(feature = "slice_ptr_range", issue = "65807")]
479     #[inline]
480     pub fn as_mut_ptr_range(&mut self) -> Range<*mut T> {
481         // See as_ptr_range() above for why `add` here is safe.
482         let start = self.as_mut_ptr();
483         let end = unsafe { start.add(self.len()) };
484         start..end
485     }
486
487     /// Swaps two elements in the slice.
488     ///
489     /// # Arguments
490     ///
491     /// * a - The index of the first element
492     /// * b - The index of the second element
493     ///
494     /// # Panics
495     ///
496     /// Panics if `a` or `b` are out of bounds.
497     ///
498     /// # Examples
499     ///
500     /// ```
501     /// let mut v = ["a", "b", "c", "d"];
502     /// v.swap(1, 3);
503     /// assert!(v == ["a", "d", "c", "b"]);
504     /// ```
505     #[stable(feature = "rust1", since = "1.0.0")]
506     #[inline]
507     pub fn swap(&mut self, a: usize, b: usize) {
508         unsafe {
509             // Can't take two mutable loans from one vector, so instead just cast
510             // them to their raw pointers to do the swap
511             let pa: *mut T = &mut self[a];
512             let pb: *mut T = &mut self[b];
513             ptr::swap(pa, pb);
514         }
515     }
516
517     /// Reverses the order of elements in the slice, in place.
518     ///
519     /// # Examples
520     ///
521     /// ```
522     /// let mut v = [1, 2, 3];
523     /// v.reverse();
524     /// assert!(v == [3, 2, 1]);
525     /// ```
526     #[stable(feature = "rust1", since = "1.0.0")]
527     #[inline]
528     pub fn reverse(&mut self) {
529         let mut i: usize = 0;
530         let ln = self.len();
531
532         // For very small types, all the individual reads in the normal
533         // path perform poorly.  We can do better, given efficient unaligned
534         // load/store, by loading a larger chunk and reversing a register.
535
536         // Ideally LLVM would do this for us, as it knows better than we do
537         // whether unaligned reads are efficient (since that changes between
538         // different ARM versions, for example) and what the best chunk size
539         // would be.  Unfortunately, as of LLVM 4.0 (2017-05) it only unrolls
540         // the loop, so we need to do this ourselves.  (Hypothesis: reverse
541         // is troublesome because the sides can be aligned differently --
542         // will be, when the length is odd -- so there's no way of emitting
543         // pre- and postludes to use fully-aligned SIMD in the middle.)
544
545         let fast_unaligned = cfg!(any(target_arch = "x86", target_arch = "x86_64"));
546
547         if fast_unaligned && mem::size_of::<T>() == 1 {
548             // Use the llvm.bswap intrinsic to reverse u8s in a usize
549             let chunk = mem::size_of::<usize>();
550             while i + chunk - 1 < ln / 2 {
551                 unsafe {
552                     let pa: *mut T = self.get_unchecked_mut(i);
553                     let pb: *mut T = self.get_unchecked_mut(ln - i - chunk);
554                     let va = ptr::read_unaligned(pa as *mut usize);
555                     let vb = ptr::read_unaligned(pb as *mut usize);
556                     ptr::write_unaligned(pa as *mut usize, vb.swap_bytes());
557                     ptr::write_unaligned(pb as *mut usize, va.swap_bytes());
558                 }
559                 i += chunk;
560             }
561         }
562
563         if fast_unaligned && mem::size_of::<T>() == 2 {
564             // Use rotate-by-16 to reverse u16s in a u32
565             let chunk = mem::size_of::<u32>() / 2;
566             while i + chunk - 1 < ln / 2 {
567                 unsafe {
568                     let pa: *mut T = self.get_unchecked_mut(i);
569                     let pb: *mut T = self.get_unchecked_mut(ln - i - chunk);
570                     let va = ptr::read_unaligned(pa as *mut u32);
571                     let vb = ptr::read_unaligned(pb as *mut u32);
572                     ptr::write_unaligned(pa as *mut u32, vb.rotate_left(16));
573                     ptr::write_unaligned(pb as *mut u32, va.rotate_left(16));
574                 }
575                 i += chunk;
576             }
577         }
578
579         while i < ln / 2 {
580             // Unsafe swap to avoid the bounds check in safe swap.
581             unsafe {
582                 let pa: *mut T = self.get_unchecked_mut(i);
583                 let pb: *mut T = self.get_unchecked_mut(ln - i - 1);
584                 ptr::swap(pa, pb);
585             }
586             i += 1;
587         }
588     }
589
590     /// Returns an iterator over the slice.
591     ///
592     /// # Examples
593     ///
594     /// ```
595     /// let x = &[1, 2, 4];
596     /// let mut iterator = x.iter();
597     ///
598     /// assert_eq!(iterator.next(), Some(&1));
599     /// assert_eq!(iterator.next(), Some(&2));
600     /// assert_eq!(iterator.next(), Some(&4));
601     /// assert_eq!(iterator.next(), None);
602     /// ```
603     #[stable(feature = "rust1", since = "1.0.0")]
604     #[inline]
605     pub fn iter(&self) -> Iter<'_, T> {
606         unsafe {
607             let ptr = self.as_ptr();
608             assume(!ptr.is_null());
609
610             let end = if mem::size_of::<T>() == 0 {
611                 (ptr as *const u8).wrapping_add(self.len()) as *const T
612             } else {
613                 ptr.add(self.len())
614             };
615
616             Iter { ptr: NonNull::new_unchecked(ptr as *mut T), end, _marker: marker::PhantomData }
617         }
618     }
619
620     /// Returns an iterator that allows modifying each value.
621     ///
622     /// # Examples
623     ///
624     /// ```
625     /// let x = &mut [1, 2, 4];
626     /// for elem in x.iter_mut() {
627     ///     *elem += 2;
628     /// }
629     /// assert_eq!(x, &[3, 4, 6]);
630     /// ```
631     #[stable(feature = "rust1", since = "1.0.0")]
632     #[inline]
633     pub fn iter_mut(&mut self) -> IterMut<'_, T> {
634         unsafe {
635             let ptr = self.as_mut_ptr();
636             assume(!ptr.is_null());
637
638             let end = if mem::size_of::<T>() == 0 {
639                 (ptr as *mut u8).wrapping_add(self.len()) as *mut T
640             } else {
641                 ptr.add(self.len())
642             };
643
644             IterMut { ptr: NonNull::new_unchecked(ptr), end, _marker: marker::PhantomData }
645         }
646     }
647
648     /// Returns an iterator over all contiguous windows of length
649     /// `size`. The windows overlap. If the slice is shorter than
650     /// `size`, the iterator returns no values.
651     ///
652     /// # Panics
653     ///
654     /// Panics if `size` is 0.
655     ///
656     /// # Examples
657     ///
658     /// ```
659     /// let slice = ['r', 'u', 's', 't'];
660     /// let mut iter = slice.windows(2);
661     /// assert_eq!(iter.next().unwrap(), &['r', 'u']);
662     /// assert_eq!(iter.next().unwrap(), &['u', 's']);
663     /// assert_eq!(iter.next().unwrap(), &['s', 't']);
664     /// assert!(iter.next().is_none());
665     /// ```
666     ///
667     /// If the slice is shorter than `size`:
668     ///
669     /// ```
670     /// let slice = ['f', 'o', 'o'];
671     /// let mut iter = slice.windows(4);
672     /// assert!(iter.next().is_none());
673     /// ```
674     #[stable(feature = "rust1", since = "1.0.0")]
675     #[inline]
676     pub fn windows(&self, size: usize) -> Windows<'_, T> {
677         assert!(size != 0);
678         Windows { v: self, size }
679     }
680
681     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the
682     /// beginning of the slice.
683     ///
684     /// The chunks are slices and do not overlap. If `chunk_size` does not divide the length of the
685     /// slice, then the last chunk will not have length `chunk_size`.
686     ///
687     /// See [`chunks_exact`] for a variant of this iterator that returns chunks of always exactly
688     /// `chunk_size` elements, and [`rchunks`] for the same iterator but starting at the end of the
689     /// slice.
690     ///
691     /// # Panics
692     ///
693     /// Panics if `chunk_size` is 0.
694     ///
695     /// # Examples
696     ///
697     /// ```
698     /// let slice = ['l', 'o', 'r', 'e', 'm'];
699     /// let mut iter = slice.chunks(2);
700     /// assert_eq!(iter.next().unwrap(), &['l', 'o']);
701     /// assert_eq!(iter.next().unwrap(), &['r', 'e']);
702     /// assert_eq!(iter.next().unwrap(), &['m']);
703     /// assert!(iter.next().is_none());
704     /// ```
705     ///
706     /// [`chunks_exact`]: #method.chunks_exact
707     /// [`rchunks`]: #method.rchunks
708     #[stable(feature = "rust1", since = "1.0.0")]
709     #[inline]
710     pub fn chunks(&self, chunk_size: usize) -> Chunks<'_, T> {
711         assert!(chunk_size != 0);
712         Chunks { v: self, chunk_size }
713     }
714
715     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the
716     /// beginning of the slice.
717     ///
718     /// The chunks are mutable slices, and do not overlap. If `chunk_size` does not divide the
719     /// length of the slice, then the last chunk will not have length `chunk_size`.
720     ///
721     /// See [`chunks_exact_mut`] for a variant of this iterator that returns chunks of always
722     /// exactly `chunk_size` elements, and [`rchunks_mut`] for the same iterator but starting at
723     /// the end of the slice.
724     ///
725     /// # Panics
726     ///
727     /// Panics if `chunk_size` is 0.
728     ///
729     /// # Examples
730     ///
731     /// ```
732     /// let v = &mut [0, 0, 0, 0, 0];
733     /// let mut count = 1;
734     ///
735     /// for chunk in v.chunks_mut(2) {
736     ///     for elem in chunk.iter_mut() {
737     ///         *elem += count;
738     ///     }
739     ///     count += 1;
740     /// }
741     /// assert_eq!(v, &[1, 1, 2, 2, 3]);
742     /// ```
743     ///
744     /// [`chunks_exact_mut`]: #method.chunks_exact_mut
745     /// [`rchunks_mut`]: #method.rchunks_mut
746     #[stable(feature = "rust1", since = "1.0.0")]
747     #[inline]
748     pub fn chunks_mut(&mut self, chunk_size: usize) -> ChunksMut<'_, T> {
749         assert!(chunk_size != 0);
750         ChunksMut { v: self, chunk_size }
751     }
752
753     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the
754     /// beginning of the slice.
755     ///
756     /// The chunks are slices and do not overlap. If `chunk_size` does not divide the length of the
757     /// slice, then the last up to `chunk_size-1` elements will be omitted and can be retrieved
758     /// from the `remainder` function of the iterator.
759     ///
760     /// Due to each chunk having exactly `chunk_size` elements, the compiler can often optimize the
761     /// resulting code better than in the case of [`chunks`].
762     ///
763     /// See [`chunks`] for a variant of this iterator that also returns the remainder as a smaller
764     /// chunk, and [`rchunks_exact`] for the same iterator but starting at the end of the slice.
765     ///
766     /// # Panics
767     ///
768     /// Panics if `chunk_size` is 0.
769     ///
770     /// # Examples
771     ///
772     /// ```
773     /// let slice = ['l', 'o', 'r', 'e', 'm'];
774     /// let mut iter = slice.chunks_exact(2);
775     /// assert_eq!(iter.next().unwrap(), &['l', 'o']);
776     /// assert_eq!(iter.next().unwrap(), &['r', 'e']);
777     /// assert!(iter.next().is_none());
778     /// assert_eq!(iter.remainder(), &['m']);
779     /// ```
780     ///
781     /// [`chunks`]: #method.chunks
782     /// [`rchunks_exact`]: #method.rchunks_exact
783     #[stable(feature = "chunks_exact", since = "1.31.0")]
784     #[inline]
785     pub fn chunks_exact(&self, chunk_size: usize) -> ChunksExact<'_, T> {
786         assert!(chunk_size != 0);
787         let rem = self.len() % chunk_size;
788         let len = self.len() - rem;
789         let (fst, snd) = self.split_at(len);
790         ChunksExact { v: fst, rem: snd, chunk_size }
791     }
792
793     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the
794     /// beginning of the slice.
795     ///
796     /// The chunks are mutable slices, and do not overlap. If `chunk_size` does not divide the
797     /// length of the slice, then the last up to `chunk_size-1` elements will be omitted and can be
798     /// retrieved from the `into_remainder` function of the iterator.
799     ///
800     /// Due to each chunk having exactly `chunk_size` elements, the compiler can often optimize the
801     /// resulting code better than in the case of [`chunks_mut`].
802     ///
803     /// See [`chunks_mut`] for a variant of this iterator that also returns the remainder as a
804     /// smaller chunk, and [`rchunks_exact_mut`] for the same iterator but starting at the end of
805     /// the slice.
806     ///
807     /// # Panics
808     ///
809     /// Panics if `chunk_size` is 0.
810     ///
811     /// # Examples
812     ///
813     /// ```
814     /// let v = &mut [0, 0, 0, 0, 0];
815     /// let mut count = 1;
816     ///
817     /// for chunk in v.chunks_exact_mut(2) {
818     ///     for elem in chunk.iter_mut() {
819     ///         *elem += count;
820     ///     }
821     ///     count += 1;
822     /// }
823     /// assert_eq!(v, &[1, 1, 2, 2, 0]);
824     /// ```
825     ///
826     /// [`chunks_mut`]: #method.chunks_mut
827     /// [`rchunks_exact_mut`]: #method.rchunks_exact_mut
828     #[stable(feature = "chunks_exact", since = "1.31.0")]
829     #[inline]
830     pub fn chunks_exact_mut(&mut self, chunk_size: usize) -> ChunksExactMut<'_, T> {
831         assert!(chunk_size != 0);
832         let rem = self.len() % chunk_size;
833         let len = self.len() - rem;
834         let (fst, snd) = self.split_at_mut(len);
835         ChunksExactMut { v: fst, rem: snd, chunk_size }
836     }
837
838     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the end
839     /// of the slice.
840     ///
841     /// The chunks are slices and do not overlap. If `chunk_size` does not divide the length of the
842     /// slice, then the last chunk will not have length `chunk_size`.
843     ///
844     /// See [`rchunks_exact`] for a variant of this iterator that returns chunks of always exactly
845     /// `chunk_size` elements, and [`chunks`] for the same iterator but starting at the beginning
846     /// of the slice.
847     ///
848     /// # Panics
849     ///
850     /// Panics if `chunk_size` is 0.
851     ///
852     /// # Examples
853     ///
854     /// ```
855     /// let slice = ['l', 'o', 'r', 'e', 'm'];
856     /// let mut iter = slice.rchunks(2);
857     /// assert_eq!(iter.next().unwrap(), &['e', 'm']);
858     /// assert_eq!(iter.next().unwrap(), &['o', 'r']);
859     /// assert_eq!(iter.next().unwrap(), &['l']);
860     /// assert!(iter.next().is_none());
861     /// ```
862     ///
863     /// [`rchunks_exact`]: #method.rchunks_exact
864     /// [`chunks`]: #method.chunks
865     #[stable(feature = "rchunks", since = "1.31.0")]
866     #[inline]
867     pub fn rchunks(&self, chunk_size: usize) -> RChunks<'_, T> {
868         assert!(chunk_size != 0);
869         RChunks { v: self, chunk_size }
870     }
871
872     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the end
873     /// of the slice.
874     ///
875     /// The chunks are mutable slices, and do not overlap. If `chunk_size` does not divide the
876     /// length of the slice, then the last chunk will not have length `chunk_size`.
877     ///
878     /// See [`rchunks_exact_mut`] for a variant of this iterator that returns chunks of always
879     /// exactly `chunk_size` elements, and [`chunks_mut`] for the same iterator but starting at the
880     /// beginning of the slice.
881     ///
882     /// # Panics
883     ///
884     /// Panics if `chunk_size` is 0.
885     ///
886     /// # Examples
887     ///
888     /// ```
889     /// let v = &mut [0, 0, 0, 0, 0];
890     /// let mut count = 1;
891     ///
892     /// for chunk in v.rchunks_mut(2) {
893     ///     for elem in chunk.iter_mut() {
894     ///         *elem += count;
895     ///     }
896     ///     count += 1;
897     /// }
898     /// assert_eq!(v, &[3, 2, 2, 1, 1]);
899     /// ```
900     ///
901     /// [`rchunks_exact_mut`]: #method.rchunks_exact_mut
902     /// [`chunks_mut`]: #method.chunks_mut
903     #[stable(feature = "rchunks", since = "1.31.0")]
904     #[inline]
905     pub fn rchunks_mut(&mut self, chunk_size: usize) -> RChunksMut<'_, T> {
906         assert!(chunk_size != 0);
907         RChunksMut { v: self, chunk_size }
908     }
909
910     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the
911     /// end of the slice.
912     ///
913     /// The chunks are slices and do not overlap. If `chunk_size` does not divide the length of the
914     /// slice, then the last up to `chunk_size-1` elements will be omitted and can be retrieved
915     /// from the `remainder` function of the iterator.
916     ///
917     /// Due to each chunk having exactly `chunk_size` elements, the compiler can often optimize the
918     /// resulting code better than in the case of [`chunks`].
919     ///
920     /// See [`rchunks`] for a variant of this iterator that also returns the remainder as a smaller
921     /// chunk, and [`chunks_exact`] for the same iterator but starting at the beginning of the
922     /// slice.
923     ///
924     /// # Panics
925     ///
926     /// Panics if `chunk_size` is 0.
927     ///
928     /// # Examples
929     ///
930     /// ```
931     /// let slice = ['l', 'o', 'r', 'e', 'm'];
932     /// let mut iter = slice.rchunks_exact(2);
933     /// assert_eq!(iter.next().unwrap(), &['e', 'm']);
934     /// assert_eq!(iter.next().unwrap(), &['o', 'r']);
935     /// assert!(iter.next().is_none());
936     /// assert_eq!(iter.remainder(), &['l']);
937     /// ```
938     ///
939     /// [`chunks`]: #method.chunks
940     /// [`rchunks`]: #method.rchunks
941     /// [`chunks_exact`]: #method.chunks_exact
942     #[stable(feature = "rchunks", since = "1.31.0")]
943     #[inline]
944     pub fn rchunks_exact(&self, chunk_size: usize) -> RChunksExact<'_, T> {
945         assert!(chunk_size != 0);
946         let rem = self.len() % chunk_size;
947         let (fst, snd) = self.split_at(rem);
948         RChunksExact { v: snd, rem: fst, chunk_size }
949     }
950
951     /// Returns an iterator over `chunk_size` elements of the slice at a time, starting at the end
952     /// of the slice.
953     ///
954     /// The chunks are mutable slices, and do not overlap. If `chunk_size` does not divide the
955     /// length of the slice, then the last up to `chunk_size-1` elements will be omitted and can be
956     /// retrieved from the `into_remainder` function of the iterator.
957     ///
958     /// Due to each chunk having exactly `chunk_size` elements, the compiler can often optimize the
959     /// resulting code better than in the case of [`chunks_mut`].
960     ///
961     /// See [`rchunks_mut`] for a variant of this iterator that also returns the remainder as a
962     /// smaller chunk, and [`chunks_exact_mut`] for the same iterator but starting at the beginning
963     /// of the slice.
964     ///
965     /// # Panics
966     ///
967     /// Panics if `chunk_size` is 0.
968     ///
969     /// # Examples
970     ///
971     /// ```
972     /// let v = &mut [0, 0, 0, 0, 0];
973     /// let mut count = 1;
974     ///
975     /// for chunk in v.rchunks_exact_mut(2) {
976     ///     for elem in chunk.iter_mut() {
977     ///         *elem += count;
978     ///     }
979     ///     count += 1;
980     /// }
981     /// assert_eq!(v, &[0, 2, 2, 1, 1]);
982     /// ```
983     ///
984     /// [`chunks_mut`]: #method.chunks_mut
985     /// [`rchunks_mut`]: #method.rchunks_mut
986     /// [`chunks_exact_mut`]: #method.chunks_exact_mut
987     #[stable(feature = "rchunks", since = "1.31.0")]
988     #[inline]
989     pub fn rchunks_exact_mut(&mut self, chunk_size: usize) -> RChunksExactMut<'_, T> {
990         assert!(chunk_size != 0);
991         let rem = self.len() % chunk_size;
992         let (fst, snd) = self.split_at_mut(rem);
993         RChunksExactMut { v: snd, rem: fst, chunk_size }
994     }
995
996     /// Divides one slice into two at an index.
997     ///
998     /// The first will contain all indices from `[0, mid)` (excluding
999     /// the index `mid` itself) and the second will contain all
1000     /// indices from `[mid, len)` (excluding the index `len` itself).
1001     ///
1002     /// # Panics
1003     ///
1004     /// Panics if `mid > len`.
1005     ///
1006     /// # Examples
1007     ///
1008     /// ```
1009     /// let v = [1, 2, 3, 4, 5, 6];
1010     ///
1011     /// {
1012     ///    let (left, right) = v.split_at(0);
1013     ///    assert!(left == []);
1014     ///    assert!(right == [1, 2, 3, 4, 5, 6]);
1015     /// }
1016     ///
1017     /// {
1018     ///     let (left, right) = v.split_at(2);
1019     ///     assert!(left == [1, 2]);
1020     ///     assert!(right == [3, 4, 5, 6]);
1021     /// }
1022     ///
1023     /// {
1024     ///     let (left, right) = v.split_at(6);
1025     ///     assert!(left == [1, 2, 3, 4, 5, 6]);
1026     ///     assert!(right == []);
1027     /// }
1028     /// ```
1029     #[stable(feature = "rust1", since = "1.0.0")]
1030     #[inline]
1031     pub fn split_at(&self, mid: usize) -> (&[T], &[T]) {
1032         (&self[..mid], &self[mid..])
1033     }
1034
1035     /// Divides one mutable slice into two at an index.
1036     ///
1037     /// The first will contain all indices from `[0, mid)` (excluding
1038     /// the index `mid` itself) and the second will contain all
1039     /// indices from `[mid, len)` (excluding the index `len` itself).
1040     ///
1041     /// # Panics
1042     ///
1043     /// Panics if `mid > len`.
1044     ///
1045     /// # Examples
1046     ///
1047     /// ```
1048     /// let mut v = [1, 0, 3, 0, 5, 6];
1049     /// // scoped to restrict the lifetime of the borrows
1050     /// {
1051     ///     let (left, right) = v.split_at_mut(2);
1052     ///     assert!(left == [1, 0]);
1053     ///     assert!(right == [3, 0, 5, 6]);
1054     ///     left[1] = 2;
1055     ///     right[1] = 4;
1056     /// }
1057     /// assert!(v == [1, 2, 3, 4, 5, 6]);
1058     /// ```
1059     #[stable(feature = "rust1", since = "1.0.0")]
1060     #[inline]
1061     pub fn split_at_mut(&mut self, mid: usize) -> (&mut [T], &mut [T]) {
1062         let len = self.len();
1063         let ptr = self.as_mut_ptr();
1064
1065         unsafe {
1066             assert!(mid <= len);
1067
1068             (from_raw_parts_mut(ptr, mid), from_raw_parts_mut(ptr.add(mid), len - mid))
1069         }
1070     }
1071
1072     /// Returns an iterator over subslices separated by elements that match
1073     /// `pred`. The matched element is not contained in the subslices.
1074     ///
1075     /// # Examples
1076     ///
1077     /// ```
1078     /// let slice = [10, 40, 33, 20];
1079     /// let mut iter = slice.split(|num| num % 3 == 0);
1080     ///
1081     /// assert_eq!(iter.next().unwrap(), &[10, 40]);
1082     /// assert_eq!(iter.next().unwrap(), &[20]);
1083     /// assert!(iter.next().is_none());
1084     /// ```
1085     ///
1086     /// If the first element is matched, an empty slice will be the first item
1087     /// returned by the iterator. Similarly, if the last element in the slice
1088     /// is matched, an empty slice will be the last item returned by the
1089     /// iterator:
1090     ///
1091     /// ```
1092     /// let slice = [10, 40, 33];
1093     /// let mut iter = slice.split(|num| num % 3 == 0);
1094     ///
1095     /// assert_eq!(iter.next().unwrap(), &[10, 40]);
1096     /// assert_eq!(iter.next().unwrap(), &[]);
1097     /// assert!(iter.next().is_none());
1098     /// ```
1099     ///
1100     /// If two matched elements are directly adjacent, an empty slice will be
1101     /// present between them:
1102     ///
1103     /// ```
1104     /// let slice = [10, 6, 33, 20];
1105     /// let mut iter = slice.split(|num| num % 3 == 0);
1106     ///
1107     /// assert_eq!(iter.next().unwrap(), &[10]);
1108     /// assert_eq!(iter.next().unwrap(), &[]);
1109     /// assert_eq!(iter.next().unwrap(), &[20]);
1110     /// assert!(iter.next().is_none());
1111     /// ```
1112     #[stable(feature = "rust1", since = "1.0.0")]
1113     #[inline]
1114     pub fn split<F>(&self, pred: F) -> Split<'_, T, F>
1115     where
1116         F: FnMut(&T) -> bool,
1117     {
1118         Split { v: self, pred, finished: false }
1119     }
1120
1121     /// Returns an iterator over mutable subslices separated by elements that
1122     /// match `pred`. The matched element is not contained in the subslices.
1123     ///
1124     /// # Examples
1125     ///
1126     /// ```
1127     /// let mut v = [10, 40, 30, 20, 60, 50];
1128     ///
1129     /// for group in v.split_mut(|num| *num % 3 == 0) {
1130     ///     group[0] = 1;
1131     /// }
1132     /// assert_eq!(v, [1, 40, 30, 1, 60, 1]);
1133     /// ```
1134     #[stable(feature = "rust1", since = "1.0.0")]
1135     #[inline]
1136     pub fn split_mut<F>(&mut self, pred: F) -> SplitMut<'_, T, F>
1137     where
1138         F: FnMut(&T) -> bool,
1139     {
1140         SplitMut { v: self, pred, finished: false }
1141     }
1142
1143     /// Returns an iterator over subslices separated by elements that match
1144     /// `pred`. The matched element is contained in the end of the previous
1145     /// subslice as a terminator.
1146     ///
1147     /// # Examples
1148     ///
1149     /// ```
1150     /// #![feature(split_inclusive)]
1151     /// let slice = [10, 40, 33, 20];
1152     /// let mut iter = slice.split_inclusive(|num| num % 3 == 0);
1153     ///
1154     /// assert_eq!(iter.next().unwrap(), &[10, 40, 33]);
1155     /// assert_eq!(iter.next().unwrap(), &[20]);
1156     /// assert!(iter.next().is_none());
1157     /// ```
1158     ///
1159     /// If the last element of the slice is matched,
1160     /// that element will be considered the terminator of the preceding slice.
1161     /// That slice will be the last item returned by the iterator.
1162     ///
1163     /// ```
1164     /// #![feature(split_inclusive)]
1165     /// let slice = [3, 10, 40, 33];
1166     /// let mut iter = slice.split_inclusive(|num| num % 3 == 0);
1167     ///
1168     /// assert_eq!(iter.next().unwrap(), &[3]);
1169     /// assert_eq!(iter.next().unwrap(), &[10, 40, 33]);
1170     /// assert!(iter.next().is_none());
1171     /// ```
1172     #[unstable(feature = "split_inclusive", issue = "72360")]
1173     #[inline]
1174     pub fn split_inclusive<F>(&self, pred: F) -> SplitInclusive<'_, T, F>
1175     where
1176         F: FnMut(&T) -> bool,
1177     {
1178         SplitInclusive { v: self, pred, finished: false }
1179     }
1180
1181     /// Returns an iterator over mutable subslices separated by elements that
1182     /// match `pred`. The matched element is contained in the previous
1183     /// subslice as a terminator.
1184     ///
1185     /// # Examples
1186     ///
1187     /// ```
1188     /// #![feature(split_inclusive)]
1189     /// let mut v = [10, 40, 30, 20, 60, 50];
1190     ///
1191     /// for group in v.split_inclusive_mut(|num| *num % 3 == 0) {
1192     ///     let terminator_idx = group.len()-1;
1193     ///     group[terminator_idx] = 1;
1194     /// }
1195     /// assert_eq!(v, [10, 40, 1, 20, 1, 1]);
1196     /// ```
1197     #[unstable(feature = "split_inclusive", issue = "72360")]
1198     #[inline]
1199     pub fn split_inclusive_mut<F>(&mut self, pred: F) -> SplitInclusiveMut<'_, T, F>
1200     where
1201         F: FnMut(&T) -> bool,
1202     {
1203         SplitInclusiveMut { v: self, pred, finished: false }
1204     }
1205
1206     /// Returns an iterator over subslices separated by elements that match
1207     /// `pred`, starting at the end of the slice and working backwards.
1208     /// The matched element is not contained in the subslices.
1209     ///
1210     /// # Examples
1211     ///
1212     /// ```
1213     /// let slice = [11, 22, 33, 0, 44, 55];
1214     /// let mut iter = slice.rsplit(|num| *num == 0);
1215     ///
1216     /// assert_eq!(iter.next().unwrap(), &[44, 55]);
1217     /// assert_eq!(iter.next().unwrap(), &[11, 22, 33]);
1218     /// assert_eq!(iter.next(), None);
1219     /// ```
1220     ///
1221     /// As with `split()`, if the first or last element is matched, an empty
1222     /// slice will be the first (or last) item returned by the iterator.
1223     ///
1224     /// ```
1225     /// let v = &[0, 1, 1, 2, 3, 5, 8];
1226     /// let mut it = v.rsplit(|n| *n % 2 == 0);
1227     /// assert_eq!(it.next().unwrap(), &[]);
1228     /// assert_eq!(it.next().unwrap(), &[3, 5]);
1229     /// assert_eq!(it.next().unwrap(), &[1, 1]);
1230     /// assert_eq!(it.next().unwrap(), &[]);
1231     /// assert_eq!(it.next(), None);
1232     /// ```
1233     #[stable(feature = "slice_rsplit", since = "1.27.0")]
1234     #[inline]
1235     pub fn rsplit<F>(&self, pred: F) -> RSplit<'_, T, F>
1236     where
1237         F: FnMut(&T) -> bool,
1238     {
1239         RSplit { inner: self.split(pred) }
1240     }
1241
1242     /// Returns an iterator over mutable subslices separated by elements that
1243     /// match `pred`, starting at the end of the slice and working
1244     /// backwards. The matched element is not contained in the subslices.
1245     ///
1246     /// # Examples
1247     ///
1248     /// ```
1249     /// let mut v = [100, 400, 300, 200, 600, 500];
1250     ///
1251     /// let mut count = 0;
1252     /// for group in v.rsplit_mut(|num| *num % 3 == 0) {
1253     ///     count += 1;
1254     ///     group[0] = count;
1255     /// }
1256     /// assert_eq!(v, [3, 400, 300, 2, 600, 1]);
1257     /// ```
1258     ///
1259     #[stable(feature = "slice_rsplit", since = "1.27.0")]
1260     #[inline]
1261     pub fn rsplit_mut<F>(&mut self, pred: F) -> RSplitMut<'_, T, F>
1262     where
1263         F: FnMut(&T) -> bool,
1264     {
1265         RSplitMut { inner: self.split_mut(pred) }
1266     }
1267
1268     /// Returns an iterator over subslices separated by elements that match
1269     /// `pred`, limited to returning at most `n` items. The matched element is
1270     /// not contained in the subslices.
1271     ///
1272     /// The last element returned, if any, will contain the remainder of the
1273     /// slice.
1274     ///
1275     /// # Examples
1276     ///
1277     /// Print the slice split once by numbers divisible by 3 (i.e., `[10, 40]`,
1278     /// `[20, 60, 50]`):
1279     ///
1280     /// ```
1281     /// let v = [10, 40, 30, 20, 60, 50];
1282     ///
1283     /// for group in v.splitn(2, |num| *num % 3 == 0) {
1284     ///     println!("{:?}", group);
1285     /// }
1286     /// ```
1287     #[stable(feature = "rust1", since = "1.0.0")]
1288     #[inline]
1289     pub fn splitn<F>(&self, n: usize, pred: F) -> SplitN<'_, T, F>
1290     where
1291         F: FnMut(&T) -> bool,
1292     {
1293         SplitN { inner: GenericSplitN { iter: self.split(pred), count: n } }
1294     }
1295
1296     /// Returns an iterator over subslices separated by elements that match
1297     /// `pred`, limited to returning at most `n` items. The matched element is
1298     /// not contained in the subslices.
1299     ///
1300     /// The last element returned, if any, will contain the remainder of the
1301     /// slice.
1302     ///
1303     /// # Examples
1304     ///
1305     /// ```
1306     /// let mut v = [10, 40, 30, 20, 60, 50];
1307     ///
1308     /// for group in v.splitn_mut(2, |num| *num % 3 == 0) {
1309     ///     group[0] = 1;
1310     /// }
1311     /// assert_eq!(v, [1, 40, 30, 1, 60, 50]);
1312     /// ```
1313     #[stable(feature = "rust1", since = "1.0.0")]
1314     #[inline]
1315     pub fn splitn_mut<F>(&mut self, n: usize, pred: F) -> SplitNMut<'_, T, F>
1316     where
1317         F: FnMut(&T) -> bool,
1318     {
1319         SplitNMut { inner: GenericSplitN { iter: self.split_mut(pred), count: n } }
1320     }
1321
1322     /// Returns an iterator over subslices separated by elements that match
1323     /// `pred` limited to returning at most `n` items. This starts at the end of
1324     /// the slice and works backwards. The matched element is not contained in
1325     /// the subslices.
1326     ///
1327     /// The last element returned, if any, will contain the remainder of the
1328     /// slice.
1329     ///
1330     /// # Examples
1331     ///
1332     /// Print the slice split once, starting from the end, by numbers divisible
1333     /// by 3 (i.e., `[50]`, `[10, 40, 30, 20]`):
1334     ///
1335     /// ```
1336     /// let v = [10, 40, 30, 20, 60, 50];
1337     ///
1338     /// for group in v.rsplitn(2, |num| *num % 3 == 0) {
1339     ///     println!("{:?}", group);
1340     /// }
1341     /// ```
1342     #[stable(feature = "rust1", since = "1.0.0")]
1343     #[inline]
1344     pub fn rsplitn<F>(&self, n: usize, pred: F) -> RSplitN<'_, T, F>
1345     where
1346         F: FnMut(&T) -> bool,
1347     {
1348         RSplitN { inner: GenericSplitN { iter: self.rsplit(pred), count: n } }
1349     }
1350
1351     /// Returns an iterator over subslices separated by elements that match
1352     /// `pred` limited to returning at most `n` items. This starts at the end of
1353     /// the slice and works backwards. The matched element is not contained in
1354     /// the subslices.
1355     ///
1356     /// The last element returned, if any, will contain the remainder of the
1357     /// slice.
1358     ///
1359     /// # Examples
1360     ///
1361     /// ```
1362     /// let mut s = [10, 40, 30, 20, 60, 50];
1363     ///
1364     /// for group in s.rsplitn_mut(2, |num| *num % 3 == 0) {
1365     ///     group[0] = 1;
1366     /// }
1367     /// assert_eq!(s, [1, 40, 30, 20, 60, 1]);
1368     /// ```
1369     #[stable(feature = "rust1", since = "1.0.0")]
1370     #[inline]
1371     pub fn rsplitn_mut<F>(&mut self, n: usize, pred: F) -> RSplitNMut<'_, T, F>
1372     where
1373         F: FnMut(&T) -> bool,
1374     {
1375         RSplitNMut { inner: GenericSplitN { iter: self.rsplit_mut(pred), count: n } }
1376     }
1377
1378     /// Returns `true` if the slice contains an element with the given value.
1379     ///
1380     /// # Examples
1381     ///
1382     /// ```
1383     /// let v = [10, 40, 30];
1384     /// assert!(v.contains(&30));
1385     /// assert!(!v.contains(&50));
1386     /// ```
1387     ///
1388     /// If you do not have an `&T`, but just an `&U` such that `T: Borrow<U>`
1389     /// (e.g. `String: Borrow<str>`), you can use `iter().any`:
1390     ///
1391     /// ```
1392     /// let v = [String::from("hello"), String::from("world")]; // slice of `String`
1393     /// assert!(v.iter().any(|e| e == "hello")); // search with `&str`
1394     /// assert!(!v.iter().any(|e| e == "hi"));
1395     /// ```
1396     #[stable(feature = "rust1", since = "1.0.0")]
1397     pub fn contains(&self, x: &T) -> bool
1398     where
1399         T: PartialEq,
1400     {
1401         x.slice_contains(self)
1402     }
1403
1404     /// Returns `true` if `needle` is a prefix of the slice.
1405     ///
1406     /// # Examples
1407     ///
1408     /// ```
1409     /// let v = [10, 40, 30];
1410     /// assert!(v.starts_with(&[10]));
1411     /// assert!(v.starts_with(&[10, 40]));
1412     /// assert!(!v.starts_with(&[50]));
1413     /// assert!(!v.starts_with(&[10, 50]));
1414     /// ```
1415     ///
1416     /// Always returns `true` if `needle` is an empty slice:
1417     ///
1418     /// ```
1419     /// let v = &[10, 40, 30];
1420     /// assert!(v.starts_with(&[]));
1421     /// let v: &[u8] = &[];
1422     /// assert!(v.starts_with(&[]));
1423     /// ```
1424     #[stable(feature = "rust1", since = "1.0.0")]
1425     pub fn starts_with(&self, needle: &[T]) -> bool
1426     where
1427         T: PartialEq,
1428     {
1429         let n = needle.len();
1430         self.len() >= n && needle == &self[..n]
1431     }
1432
1433     /// Returns `true` if `needle` is a suffix of the slice.
1434     ///
1435     /// # Examples
1436     ///
1437     /// ```
1438     /// let v = [10, 40, 30];
1439     /// assert!(v.ends_with(&[30]));
1440     /// assert!(v.ends_with(&[40, 30]));
1441     /// assert!(!v.ends_with(&[50]));
1442     /// assert!(!v.ends_with(&[50, 30]));
1443     /// ```
1444     ///
1445     /// Always returns `true` if `needle` is an empty slice:
1446     ///
1447     /// ```
1448     /// let v = &[10, 40, 30];
1449     /// assert!(v.ends_with(&[]));
1450     /// let v: &[u8] = &[];
1451     /// assert!(v.ends_with(&[]));
1452     /// ```
1453     #[stable(feature = "rust1", since = "1.0.0")]
1454     pub fn ends_with(&self, needle: &[T]) -> bool
1455     where
1456         T: PartialEq,
1457     {
1458         let (m, n) = (self.len(), needle.len());
1459         m >= n && needle == &self[m - n..]
1460     }
1461
1462     /// Binary searches this sorted slice for a given element.
1463     ///
1464     /// If the value is found then [`Result::Ok`] is returned, containing the
1465     /// index of the matching element. If there are multiple matches, then any
1466     /// one of the matches could be returned. If the value is not found then
1467     /// [`Result::Err`] is returned, containing the index where a matching
1468     /// element could be inserted while maintaining sorted order.
1469     ///
1470     /// # Examples
1471     ///
1472     /// Looks up a series of four elements. The first is found, with a
1473     /// uniquely determined position; the second and third are not
1474     /// found; the fourth could match any position in `[1, 4]`.
1475     ///
1476     /// ```
1477     /// let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
1478     ///
1479     /// assert_eq!(s.binary_search(&13),  Ok(9));
1480     /// assert_eq!(s.binary_search(&4),   Err(7));
1481     /// assert_eq!(s.binary_search(&100), Err(13));
1482     /// let r = s.binary_search(&1);
1483     /// assert!(match r { Ok(1..=4) => true, _ => false, });
1484     /// ```
1485     ///
1486     /// If you want to insert an item to a sorted vector, while maintaining
1487     /// sort order:
1488     ///
1489     /// ```
1490     /// let mut s = vec![0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
1491     /// let num = 42;
1492     /// let idx = s.binary_search(&num).unwrap_or_else(|x| x);
1493     /// s.insert(idx, num);
1494     /// assert_eq!(s, [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 42, 55]);
1495     /// ```
1496     #[stable(feature = "rust1", since = "1.0.0")]
1497     pub fn binary_search(&self, x: &T) -> Result<usize, usize>
1498     where
1499         T: Ord,
1500     {
1501         self.binary_search_by(|p| p.cmp(x))
1502     }
1503
1504     /// Binary searches this sorted slice with a comparator function.
1505     ///
1506     /// The comparator function should implement an order consistent
1507     /// with the sort order of the underlying slice, returning an
1508     /// order code that indicates whether its argument is `Less`,
1509     /// `Equal` or `Greater` the desired target.
1510     ///
1511     /// If the value is found then [`Result::Ok`] is returned, containing the
1512     /// index of the matching element. If there are multiple matches, then any
1513     /// one of the matches could be returned. If the value is not found then
1514     /// [`Result::Err`] is returned, containing the index where a matching
1515     /// element could be inserted while maintaining sorted order.
1516     ///
1517     /// # Examples
1518     ///
1519     /// Looks up a series of four elements. The first is found, with a
1520     /// uniquely determined position; the second and third are not
1521     /// found; the fourth could match any position in `[1, 4]`.
1522     ///
1523     /// ```
1524     /// let s = [0, 1, 1, 1, 1, 2, 3, 5, 8, 13, 21, 34, 55];
1525     ///
1526     /// let seek = 13;
1527     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Ok(9));
1528     /// let seek = 4;
1529     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(7));
1530     /// let seek = 100;
1531     /// assert_eq!(s.binary_search_by(|probe| probe.cmp(&seek)), Err(13));
1532     /// let seek = 1;
1533     /// let r = s.binary_search_by(|probe| probe.cmp(&seek));
1534     /// assert!(match r { Ok(1..=4) => true, _ => false, });
1535     /// ```
1536     #[stable(feature = "rust1", since = "1.0.0")]
1537     #[inline]
1538     pub fn binary_search_by<'a, F>(&'a self, mut f: F) -> Result<usize, usize>
1539     where
1540         F: FnMut(&'a T) -> Ordering,
1541     {
1542         let s = self;
1543         let mut size = s.len();
1544         if size == 0 {
1545             return Err(0);
1546         }
1547         let mut base = 0usize;
1548         while size > 1 {
1549             let half = size / 2;
1550             let mid = base + half;
1551             // mid is always in [0, size), that means mid is >= 0 and < size.
1552             // mid >= 0: by definition
1553             // mid < size: mid = size / 2 + size / 4 + size / 8 ...
1554             let cmp = f(unsafe { s.get_unchecked(mid) });
1555             base = if cmp == Greater { base } else { mid };
1556             size -= half;
1557         }
1558         // base is always in [0, size) because base <= mid.
1559         let cmp = f(unsafe { s.get_unchecked(base) });
1560         if cmp == Equal { Ok(base) } else { Err(base + (cmp == Less) as usize) }
1561     }
1562
1563     /// Binary searches this sorted slice with a key extraction function.
1564     ///
1565     /// Assumes that the slice is sorted by the key, for instance with
1566     /// [`sort_by_key`] using the same key extraction function.
1567     ///
1568     /// If the value is found then [`Result::Ok`] is returned, containing the
1569     /// index of the matching element. If there are multiple matches, then any
1570     /// one of the matches could be returned. If the value is not found then
1571     /// [`Result::Err`] is returned, containing the index where a matching
1572     /// element could be inserted while maintaining sorted order.
1573     ///
1574     /// [`sort_by_key`]: #method.sort_by_key
1575     ///
1576     /// # Examples
1577     ///
1578     /// Looks up a series of four elements in a slice of pairs sorted by
1579     /// their second elements. The first is found, with a uniquely
1580     /// determined position; the second and third are not found; the
1581     /// fourth could match any position in `[1, 4]`.
1582     ///
1583     /// ```
1584     /// let s = [(0, 0), (2, 1), (4, 1), (5, 1), (3, 1),
1585     ///          (1, 2), (2, 3), (4, 5), (5, 8), (3, 13),
1586     ///          (1, 21), (2, 34), (4, 55)];
1587     ///
1588     /// assert_eq!(s.binary_search_by_key(&13, |&(a,b)| b),  Ok(9));
1589     /// assert_eq!(s.binary_search_by_key(&4, |&(a,b)| b),   Err(7));
1590     /// assert_eq!(s.binary_search_by_key(&100, |&(a,b)| b), Err(13));
1591     /// let r = s.binary_search_by_key(&1, |&(a,b)| b);
1592     /// assert!(match r { Ok(1..=4) => true, _ => false, });
1593     /// ```
1594     #[stable(feature = "slice_binary_search_by_key", since = "1.10.0")]
1595     #[inline]
1596     pub fn binary_search_by_key<'a, B, F>(&'a self, b: &B, mut f: F) -> Result<usize, usize>
1597     where
1598         F: FnMut(&'a T) -> B,
1599         B: Ord,
1600     {
1601         self.binary_search_by(|k| f(k).cmp(b))
1602     }
1603
1604     /// Sorts the slice, but may not preserve the order of equal elements.
1605     ///
1606     /// This sort is unstable (i.e., may reorder equal elements), in-place
1607     /// (i.e., does not allocate), and `O(n * log(n))` worst-case.
1608     ///
1609     /// # Current implementation
1610     ///
1611     /// The current algorithm is based on [pattern-defeating quicksort][pdqsort] by Orson Peters,
1612     /// which combines the fast average case of randomized quicksort with the fast worst case of
1613     /// heapsort, while achieving linear time on slices with certain patterns. It uses some
1614     /// randomization to avoid degenerate cases, but with a fixed seed to always provide
1615     /// deterministic behavior.
1616     ///
1617     /// It is typically faster than stable sorting, except in a few special cases, e.g., when the
1618     /// slice consists of several concatenated sorted sequences.
1619     ///
1620     /// # Examples
1621     ///
1622     /// ```
1623     /// let mut v = [-5, 4, 1, -3, 2];
1624     ///
1625     /// v.sort_unstable();
1626     /// assert!(v == [-5, -3, 1, 2, 4]);
1627     /// ```
1628     ///
1629     /// [pdqsort]: https://github.com/orlp/pdqsort
1630     #[stable(feature = "sort_unstable", since = "1.20.0")]
1631     #[inline]
1632     pub fn sort_unstable(&mut self)
1633     where
1634         T: Ord,
1635     {
1636         sort::quicksort(self, |a, b| a.lt(b));
1637     }
1638
1639     /// Sorts the slice with a comparator function, but may not preserve the order of equal
1640     /// elements.
1641     ///
1642     /// This sort is unstable (i.e., may reorder equal elements), in-place
1643     /// (i.e., does not allocate), and `O(n * log(n))` worst-case.
1644     ///
1645     /// The comparator function must define a total ordering for the elements in the slice. If
1646     /// the ordering is not total, the order of the elements is unspecified. An order is a
1647     /// total order if it is (for all a, b and c):
1648     ///
1649     /// * total and antisymmetric: exactly one of a < b, a == b or a > b is true; and
1650     /// * transitive, a < b and b < c implies a < c. The same must hold for both == and >.
1651     ///
1652     /// For example, while [`f64`] doesn't implement [`Ord`] because `NaN != NaN`, we can use
1653     /// `partial_cmp` as our sort function when we know the slice doesn't contain a `NaN`.
1654     ///
1655     /// ```
1656     /// let mut floats = [5f64, 4.0, 1.0, 3.0, 2.0];
1657     /// floats.sort_unstable_by(|a, b| a.partial_cmp(b).unwrap());
1658     /// assert_eq!(floats, [1.0, 2.0, 3.0, 4.0, 5.0]);
1659     /// ```
1660     ///
1661     /// # Current implementation
1662     ///
1663     /// The current algorithm is based on [pattern-defeating quicksort][pdqsort] by Orson Peters,
1664     /// which combines the fast average case of randomized quicksort with the fast worst case of
1665     /// heapsort, while achieving linear time on slices with certain patterns. It uses some
1666     /// randomization to avoid degenerate cases, but with a fixed seed to always provide
1667     /// deterministic behavior.
1668     ///
1669     /// It is typically faster than stable sorting, except in a few special cases, e.g., when the
1670     /// slice consists of several concatenated sorted sequences.
1671     ///
1672     /// # Examples
1673     ///
1674     /// ```
1675     /// let mut v = [5, 4, 1, 3, 2];
1676     /// v.sort_unstable_by(|a, b| a.cmp(b));
1677     /// assert!(v == [1, 2, 3, 4, 5]);
1678     ///
1679     /// // reverse sorting
1680     /// v.sort_unstable_by(|a, b| b.cmp(a));
1681     /// assert!(v == [5, 4, 3, 2, 1]);
1682     /// ```
1683     ///
1684     /// [pdqsort]: https://github.com/orlp/pdqsort
1685     #[stable(feature = "sort_unstable", since = "1.20.0")]
1686     #[inline]
1687     pub fn sort_unstable_by<F>(&mut self, mut compare: F)
1688     where
1689         F: FnMut(&T, &T) -> Ordering,
1690     {
1691         sort::quicksort(self, |a, b| compare(a, b) == Ordering::Less);
1692     }
1693
1694     /// Sorts the slice with a key extraction function, but may not preserve the order of equal
1695     /// elements.
1696     ///
1697     /// This sort is unstable (i.e., may reorder equal elements), in-place
1698     /// (i.e., does not allocate), and `O(m * n * log(n))` worst-case, where the key function is
1699     /// `O(m)`.
1700     ///
1701     /// # Current implementation
1702     ///
1703     /// The current algorithm is based on [pattern-defeating quicksort][pdqsort] by Orson Peters,
1704     /// which combines the fast average case of randomized quicksort with the fast worst case of
1705     /// heapsort, while achieving linear time on slices with certain patterns. It uses some
1706     /// randomization to avoid degenerate cases, but with a fixed seed to always provide
1707     /// deterministic behavior.
1708     ///
1709     /// Due to its key calling strategy, [`sort_unstable_by_key`](#method.sort_unstable_by_key)
1710     /// is likely to be slower than [`sort_by_cached_key`](#method.sort_by_cached_key) in
1711     /// cases where the key function is expensive.
1712     ///
1713     /// # Examples
1714     ///
1715     /// ```
1716     /// let mut v = [-5i32, 4, 1, -3, 2];
1717     ///
1718     /// v.sort_unstable_by_key(|k| k.abs());
1719     /// assert!(v == [1, 2, -3, 4, -5]);
1720     /// ```
1721     ///
1722     /// [pdqsort]: https://github.com/orlp/pdqsort
1723     #[stable(feature = "sort_unstable", since = "1.20.0")]
1724     #[inline]
1725     pub fn sort_unstable_by_key<K, F>(&mut self, mut f: F)
1726     where
1727         F: FnMut(&T) -> K,
1728         K: Ord,
1729     {
1730         sort::quicksort(self, |a, b| f(a).lt(&f(b)));
1731     }
1732
1733     /// Reorder the slice such that the element at `index` is at its final sorted position.
1734     ///
1735     /// This reordering has the additional property that any value at position `i < index` will be
1736     /// less than or equal to any value at a position `j > index`. Additionally, this reordering is
1737     /// unstable (i.e. any number of equal elements may end up at position `index`), in-place
1738     /// (i.e. does not allocate), and `O(n)` worst-case. This function is also/ known as "kth
1739     /// element" in other libraries. It returns a triplet of the following values: all elements less
1740     /// than the one at the given index, the value at the given index, and all elements greater than
1741     /// the one at the given index.
1742     ///
1743     /// # Current implementation
1744     ///
1745     /// The current algorithm is based on the quickselect portion of the same quicksort algorithm
1746     /// used for [`sort_unstable`].
1747     ///
1748     /// [`sort_unstable`]: #method.sort_unstable
1749     ///
1750     /// # Panics
1751     ///
1752     /// Panics when `index >= len()`, meaning it always panics on empty slices.
1753     ///
1754     /// # Examples
1755     ///
1756     /// ```
1757     /// #![feature(slice_partition_at_index)]
1758     ///
1759     /// let mut v = [-5i32, 4, 1, -3, 2];
1760     ///
1761     /// // Find the median
1762     /// v.partition_at_index(2);
1763     ///
1764     /// // We are only guaranteed the slice will be one of the following, based on the way we sort
1765     /// // about the specified index.
1766     /// assert!(v == [-3, -5, 1, 2, 4] ||
1767     ///         v == [-5, -3, 1, 2, 4] ||
1768     ///         v == [-3, -5, 1, 4, 2] ||
1769     ///         v == [-5, -3, 1, 4, 2]);
1770     /// ```
1771     #[unstable(feature = "slice_partition_at_index", issue = "55300")]
1772     #[inline]
1773     pub fn partition_at_index(&mut self, index: usize) -> (&mut [T], &mut T, &mut [T])
1774     where
1775         T: Ord,
1776     {
1777         let mut f = |a: &T, b: &T| a.lt(b);
1778         sort::partition_at_index(self, index, &mut f)
1779     }
1780
1781     /// Reorder the slice with a comparator function such that the element at `index` is at its
1782     /// final sorted position.
1783     ///
1784     /// This reordering has the additional property that any value at position `i < index` will be
1785     /// less than or equal to any value at a position `j > index` using the comparator function.
1786     /// Additionally, this reordering is unstable (i.e. any number of equal elements may end up at
1787     /// position `index`), in-place (i.e. does not allocate), and `O(n)` worst-case. This function
1788     /// is also known as "kth element" in other libraries. It returns a triplet of the following
1789     /// values: all elements less than the one at the given index, the value at the given index,
1790     /// and all elements greater than the one at the given index, using the provided comparator
1791     /// function.
1792     ///
1793     /// # Current implementation
1794     ///
1795     /// The current algorithm is based on the quickselect portion of the same quicksort algorithm
1796     /// used for [`sort_unstable`].
1797     ///
1798     /// [`sort_unstable`]: #method.sort_unstable
1799     ///
1800     /// # Panics
1801     ///
1802     /// Panics when `index >= len()`, meaning it always panics on empty slices.
1803     ///
1804     /// # Examples
1805     ///
1806     /// ```
1807     /// #![feature(slice_partition_at_index)]
1808     ///
1809     /// let mut v = [-5i32, 4, 1, -3, 2];
1810     ///
1811     /// // Find the median as if the slice were sorted in descending order.
1812     /// v.partition_at_index_by(2, |a, b| b.cmp(a));
1813     ///
1814     /// // We are only guaranteed the slice will be one of the following, based on the way we sort
1815     /// // about the specified index.
1816     /// assert!(v == [2, 4, 1, -5, -3] ||
1817     ///         v == [2, 4, 1, -3, -5] ||
1818     ///         v == [4, 2, 1, -5, -3] ||
1819     ///         v == [4, 2, 1, -3, -5]);
1820     /// ```
1821     #[unstable(feature = "slice_partition_at_index", issue = "55300")]
1822     #[inline]
1823     pub fn partition_at_index_by<F>(
1824         &mut self,
1825         index: usize,
1826         mut compare: F,
1827     ) -> (&mut [T], &mut T, &mut [T])
1828     where
1829         F: FnMut(&T, &T) -> Ordering,
1830     {
1831         let mut f = |a: &T, b: &T| compare(a, b) == Less;
1832         sort::partition_at_index(self, index, &mut f)
1833     }
1834
1835     /// Reorder the slice with a key extraction function such that the element at `index` is at its
1836     /// final sorted position.
1837     ///
1838     /// This reordering has the additional property that any value at position `i < index` will be
1839     /// less than or equal to any value at a position `j > index` using the key extraction function.
1840     /// Additionally, this reordering is unstable (i.e. any number of equal elements may end up at
1841     /// position `index`), in-place (i.e. does not allocate), and `O(n)` worst-case. This function
1842     /// is also known as "kth element" in other libraries. It returns a triplet of the following
1843     /// values: all elements less than the one at the given index, the value at the given index, and
1844     /// all elements greater than the one at the given index, using the provided key extraction
1845     /// function.
1846     ///
1847     /// # Current implementation
1848     ///
1849     /// The current algorithm is based on the quickselect portion of the same quicksort algorithm
1850     /// used for [`sort_unstable`].
1851     ///
1852     /// [`sort_unstable`]: #method.sort_unstable
1853     ///
1854     /// # Panics
1855     ///
1856     /// Panics when `index >= len()`, meaning it always panics on empty slices.
1857     ///
1858     /// # Examples
1859     ///
1860     /// ```
1861     /// #![feature(slice_partition_at_index)]
1862     ///
1863     /// let mut v = [-5i32, 4, 1, -3, 2];
1864     ///
1865     /// // Return the median as if the array were sorted according to absolute value.
1866     /// v.partition_at_index_by_key(2, |a| a.abs());
1867     ///
1868     /// // We are only guaranteed the slice will be one of the following, based on the way we sort
1869     /// // about the specified index.
1870     /// assert!(v == [1, 2, -3, 4, -5] ||
1871     ///         v == [1, 2, -3, -5, 4] ||
1872     ///         v == [2, 1, -3, 4, -5] ||
1873     ///         v == [2, 1, -3, -5, 4]);
1874     /// ```
1875     #[unstable(feature = "slice_partition_at_index", issue = "55300")]
1876     #[inline]
1877     pub fn partition_at_index_by_key<K, F>(
1878         &mut self,
1879         index: usize,
1880         mut f: F,
1881     ) -> (&mut [T], &mut T, &mut [T])
1882     where
1883         F: FnMut(&T) -> K,
1884         K: Ord,
1885     {
1886         let mut g = |a: &T, b: &T| f(a).lt(&f(b));
1887         sort::partition_at_index(self, index, &mut g)
1888     }
1889
1890     /// Moves all consecutive repeated elements to the end of the slice according to the
1891     /// [`PartialEq`] trait implementation.
1892     ///
1893     /// Returns two slices. The first contains no consecutive repeated elements.
1894     /// The second contains all the duplicates in no specified order.
1895     ///
1896     /// If the slice is sorted, the first returned slice contains no duplicates.
1897     ///
1898     /// # Examples
1899     ///
1900     /// ```
1901     /// #![feature(slice_partition_dedup)]
1902     ///
1903     /// let mut slice = [1, 2, 2, 3, 3, 2, 1, 1];
1904     ///
1905     /// let (dedup, duplicates) = slice.partition_dedup();
1906     ///
1907     /// assert_eq!(dedup, [1, 2, 3, 2, 1]);
1908     /// assert_eq!(duplicates, [2, 3, 1]);
1909     /// ```
1910     #[unstable(feature = "slice_partition_dedup", issue = "54279")]
1911     #[inline]
1912     pub fn partition_dedup(&mut self) -> (&mut [T], &mut [T])
1913     where
1914         T: PartialEq,
1915     {
1916         self.partition_dedup_by(|a, b| a == b)
1917     }
1918
1919     /// Moves all but the first of consecutive elements to the end of the slice satisfying
1920     /// a given equality relation.
1921     ///
1922     /// Returns two slices. The first contains no consecutive repeated elements.
1923     /// The second contains all the duplicates in no specified order.
1924     ///
1925     /// The `same_bucket` function is passed references to two elements from the slice and
1926     /// must determine if the elements compare equal. The elements are passed in opposite order
1927     /// from their order in the slice, so if `same_bucket(a, b)` returns `true`, `a` is moved
1928     /// at the end of the slice.
1929     ///
1930     /// If the slice is sorted, the first returned slice contains no duplicates.
1931     ///
1932     /// # Examples
1933     ///
1934     /// ```
1935     /// #![feature(slice_partition_dedup)]
1936     ///
1937     /// let mut slice = ["foo", "Foo", "BAZ", "Bar", "bar", "baz", "BAZ"];
1938     ///
1939     /// let (dedup, duplicates) = slice.partition_dedup_by(|a, b| a.eq_ignore_ascii_case(b));
1940     ///
1941     /// assert_eq!(dedup, ["foo", "BAZ", "Bar", "baz"]);
1942     /// assert_eq!(duplicates, ["bar", "Foo", "BAZ"]);
1943     /// ```
1944     #[unstable(feature = "slice_partition_dedup", issue = "54279")]
1945     #[inline]
1946     pub fn partition_dedup_by<F>(&mut self, mut same_bucket: F) -> (&mut [T], &mut [T])
1947     where
1948         F: FnMut(&mut T, &mut T) -> bool,
1949     {
1950         // Although we have a mutable reference to `self`, we cannot make
1951         // *arbitrary* changes. The `same_bucket` calls could panic, so we
1952         // must ensure that the slice is in a valid state at all times.
1953         //
1954         // The way that we handle this is by using swaps; we iterate
1955         // over all the elements, swapping as we go so that at the end
1956         // the elements we wish to keep are in the front, and those we
1957         // wish to reject are at the back. We can then split the slice.
1958         // This operation is still `O(n)`.
1959         //
1960         // Example: We start in this state, where `r` represents "next
1961         // read" and `w` represents "next_write`.
1962         //
1963         //           r
1964         //     +---+---+---+---+---+---+
1965         //     | 0 | 1 | 1 | 2 | 3 | 3 |
1966         //     +---+---+---+---+---+---+
1967         //           w
1968         //
1969         // Comparing self[r] against self[w-1], this is not a duplicate, so
1970         // we swap self[r] and self[w] (no effect as r==w) and then increment both
1971         // r and w, leaving us with:
1972         //
1973         //               r
1974         //     +---+---+---+---+---+---+
1975         //     | 0 | 1 | 1 | 2 | 3 | 3 |
1976         //     +---+---+---+---+---+---+
1977         //               w
1978         //
1979         // Comparing self[r] against self[w-1], this value is a duplicate,
1980         // so we increment `r` but leave everything else unchanged:
1981         //
1982         //                   r
1983         //     +---+---+---+---+---+---+
1984         //     | 0 | 1 | 1 | 2 | 3 | 3 |
1985         //     +---+---+---+---+---+---+
1986         //               w
1987         //
1988         // Comparing self[r] against self[w-1], this is not a duplicate,
1989         // so swap self[r] and self[w] and advance r and w:
1990         //
1991         //                       r
1992         //     +---+---+---+---+---+---+
1993         //     | 0 | 1 | 2 | 1 | 3 | 3 |
1994         //     +---+---+---+---+---+---+
1995         //                   w
1996         //
1997         // Not a duplicate, repeat:
1998         //
1999         //                           r
2000         //     +---+---+---+---+---+---+
2001         //     | 0 | 1 | 2 | 3 | 1 | 3 |
2002         //     +---+---+---+---+---+---+
2003         //                       w
2004         //
2005         // Duplicate, advance r. End of slice. Split at w.
2006
2007         let len = self.len();
2008         if len <= 1 {
2009             return (self, &mut []);
2010         }
2011
2012         let ptr = self.as_mut_ptr();
2013         let mut next_read: usize = 1;
2014         let mut next_write: usize = 1;
2015
2016         unsafe {
2017             // Avoid bounds checks by using raw pointers.
2018             while next_read < len {
2019                 let ptr_read = ptr.add(next_read);
2020                 let prev_ptr_write = ptr.add(next_write - 1);
2021                 if !same_bucket(&mut *ptr_read, &mut *prev_ptr_write) {
2022                     if next_read != next_write {
2023                         let ptr_write = prev_ptr_write.offset(1);
2024                         mem::swap(&mut *ptr_read, &mut *ptr_write);
2025                     }
2026                     next_write += 1;
2027                 }
2028                 next_read += 1;
2029             }
2030         }
2031
2032         self.split_at_mut(next_write)
2033     }
2034
2035     /// Moves all but the first of consecutive elements to the end of the slice that resolve
2036     /// to the same key.
2037     ///
2038     /// Returns two slices. The first contains no consecutive repeated elements.
2039     /// The second contains all the duplicates in no specified order.
2040     ///
2041     /// If the slice is sorted, the first returned slice contains no duplicates.
2042     ///
2043     /// # Examples
2044     ///
2045     /// ```
2046     /// #![feature(slice_partition_dedup)]
2047     ///
2048     /// let mut slice = [10, 20, 21, 30, 30, 20, 11, 13];
2049     ///
2050     /// let (dedup, duplicates) = slice.partition_dedup_by_key(|i| *i / 10);
2051     ///
2052     /// assert_eq!(dedup, [10, 20, 30, 20, 11]);
2053     /// assert_eq!(duplicates, [21, 30, 13]);
2054     /// ```
2055     #[unstable(feature = "slice_partition_dedup", issue = "54279")]
2056     #[inline]
2057     pub fn partition_dedup_by_key<K, F>(&mut self, mut key: F) -> (&mut [T], &mut [T])
2058     where
2059         F: FnMut(&mut T) -> K,
2060         K: PartialEq,
2061     {
2062         self.partition_dedup_by(|a, b| key(a) == key(b))
2063     }
2064
2065     /// Rotates the slice in-place such that the first `mid` elements of the
2066     /// slice move to the end while the last `self.len() - mid` elements move to
2067     /// the front. After calling `rotate_left`, the element previously at index
2068     /// `mid` will become the first element in the slice.
2069     ///
2070     /// # Panics
2071     ///
2072     /// This function will panic if `mid` is greater than the length of the
2073     /// slice. Note that `mid == self.len()` does _not_ panic and is a no-op
2074     /// rotation.
2075     ///
2076     /// # Complexity
2077     ///
2078     /// Takes linear (in `self.len()`) time.
2079     ///
2080     /// # Examples
2081     ///
2082     /// ```
2083     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
2084     /// a.rotate_left(2);
2085     /// assert_eq!(a, ['c', 'd', 'e', 'f', 'a', 'b']);
2086     /// ```
2087     ///
2088     /// Rotating a subslice:
2089     ///
2090     /// ```
2091     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
2092     /// a[1..5].rotate_left(1);
2093     /// assert_eq!(a, ['a', 'c', 'd', 'e', 'b', 'f']);
2094     /// ```
2095     #[stable(feature = "slice_rotate", since = "1.26.0")]
2096     pub fn rotate_left(&mut self, mid: usize) {
2097         assert!(mid <= self.len());
2098         let k = self.len() - mid;
2099
2100         unsafe {
2101             let p = self.as_mut_ptr();
2102             rotate::ptr_rotate(mid, p.add(mid), k);
2103         }
2104     }
2105
2106     /// Rotates the slice in-place such that the first `self.len() - k`
2107     /// elements of the slice move to the end while the last `k` elements move
2108     /// to the front. After calling `rotate_right`, the element previously at
2109     /// index `self.len() - k` will become the first element in the slice.
2110     ///
2111     /// # Panics
2112     ///
2113     /// This function will panic if `k` is greater than the length of the
2114     /// slice. Note that `k == self.len()` does _not_ panic and is a no-op
2115     /// rotation.
2116     ///
2117     /// # Complexity
2118     ///
2119     /// Takes linear (in `self.len()`) time.
2120     ///
2121     /// # Examples
2122     ///
2123     /// ```
2124     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
2125     /// a.rotate_right(2);
2126     /// assert_eq!(a, ['e', 'f', 'a', 'b', 'c', 'd']);
2127     /// ```
2128     ///
2129     /// Rotate a subslice:
2130     ///
2131     /// ```
2132     /// let mut a = ['a', 'b', 'c', 'd', 'e', 'f'];
2133     /// a[1..5].rotate_right(1);
2134     /// assert_eq!(a, ['a', 'e', 'b', 'c', 'd', 'f']);
2135     /// ```
2136     #[stable(feature = "slice_rotate", since = "1.26.0")]
2137     pub fn rotate_right(&mut self, k: usize) {
2138         assert!(k <= self.len());
2139         let mid = self.len() - k;
2140
2141         unsafe {
2142             let p = self.as_mut_ptr();
2143             rotate::ptr_rotate(mid, p.add(mid), k);
2144         }
2145     }
2146
2147     /// Fills `self` with elements by cloning `value`.
2148     ///
2149     /// # Examples
2150     ///
2151     /// ```
2152     /// #![feature(slice_fill)]
2153     ///
2154     /// let mut buf = vec![0; 10];
2155     /// buf.fill(1);
2156     /// assert_eq!(buf, vec![1; 10]);
2157     /// ```
2158     #[unstable(feature = "slice_fill", issue = "70758")]
2159     pub fn fill(&mut self, value: T)
2160     where
2161         T: Clone,
2162     {
2163         if let Some((last, elems)) = self.split_last_mut() {
2164             for el in elems {
2165                 el.clone_from(&value);
2166             }
2167
2168             *last = value
2169         }
2170     }
2171
2172     /// Copies the elements from `src` into `self`.
2173     ///
2174     /// The length of `src` must be the same as `self`.
2175     ///
2176     /// If `T` implements `Copy`, it can be more performant to use
2177     /// [`copy_from_slice`].
2178     ///
2179     /// # Panics
2180     ///
2181     /// This function will panic if the two slices have different lengths.
2182     ///
2183     /// # Examples
2184     ///
2185     /// Cloning two elements from a slice into another:
2186     ///
2187     /// ```
2188     /// let src = [1, 2, 3, 4];
2189     /// let mut dst = [0, 0];
2190     ///
2191     /// // Because the slices have to be the same length,
2192     /// // we slice the source slice from four elements
2193     /// // to two. It will panic if we don't do this.
2194     /// dst.clone_from_slice(&src[2..]);
2195     ///
2196     /// assert_eq!(src, [1, 2, 3, 4]);
2197     /// assert_eq!(dst, [3, 4]);
2198     /// ```
2199     ///
2200     /// Rust enforces that there can only be one mutable reference with no
2201     /// immutable references to a particular piece of data in a particular
2202     /// scope. Because of this, attempting to use `clone_from_slice` on a
2203     /// single slice will result in a compile failure:
2204     ///
2205     /// ```compile_fail
2206     /// let mut slice = [1, 2, 3, 4, 5];
2207     ///
2208     /// slice[..2].clone_from_slice(&slice[3..]); // compile fail!
2209     /// ```
2210     ///
2211     /// To work around this, we can use [`split_at_mut`] to create two distinct
2212     /// sub-slices from a slice:
2213     ///
2214     /// ```
2215     /// let mut slice = [1, 2, 3, 4, 5];
2216     ///
2217     /// {
2218     ///     let (left, right) = slice.split_at_mut(2);
2219     ///     left.clone_from_slice(&right[1..]);
2220     /// }
2221     ///
2222     /// assert_eq!(slice, [4, 5, 3, 4, 5]);
2223     /// ```
2224     ///
2225     /// [`copy_from_slice`]: #method.copy_from_slice
2226     /// [`split_at_mut`]: #method.split_at_mut
2227     #[stable(feature = "clone_from_slice", since = "1.7.0")]
2228     pub fn clone_from_slice(&mut self, src: &[T])
2229     where
2230         T: Clone,
2231     {
2232         assert!(self.len() == src.len(), "destination and source slices have different lengths");
2233         // NOTE: We need to explicitly slice them to the same length
2234         // for bounds checking to be elided, and the optimizer will
2235         // generate memcpy for simple cases (for example T = u8).
2236         let len = self.len();
2237         let src = &src[..len];
2238         for i in 0..len {
2239             self[i].clone_from(&src[i]);
2240         }
2241     }
2242
2243     /// Copies all elements from `src` into `self`, using a memcpy.
2244     ///
2245     /// The length of `src` must be the same as `self`.
2246     ///
2247     /// If `T` does not implement `Copy`, use [`clone_from_slice`].
2248     ///
2249     /// # Panics
2250     ///
2251     /// This function will panic if the two slices have different lengths.
2252     ///
2253     /// # Examples
2254     ///
2255     /// Copying two elements from a slice into another:
2256     ///
2257     /// ```
2258     /// let src = [1, 2, 3, 4];
2259     /// let mut dst = [0, 0];
2260     ///
2261     /// // Because the slices have to be the same length,
2262     /// // we slice the source slice from four elements
2263     /// // to two. It will panic if we don't do this.
2264     /// dst.copy_from_slice(&src[2..]);
2265     ///
2266     /// assert_eq!(src, [1, 2, 3, 4]);
2267     /// assert_eq!(dst, [3, 4]);
2268     /// ```
2269     ///
2270     /// Rust enforces that there can only be one mutable reference with no
2271     /// immutable references to a particular piece of data in a particular
2272     /// scope. Because of this, attempting to use `copy_from_slice` on a
2273     /// single slice will result in a compile failure:
2274     ///
2275     /// ```compile_fail
2276     /// let mut slice = [1, 2, 3, 4, 5];
2277     ///
2278     /// slice[..2].copy_from_slice(&slice[3..]); // compile fail!
2279     /// ```
2280     ///
2281     /// To work around this, we can use [`split_at_mut`] to create two distinct
2282     /// sub-slices from a slice:
2283     ///
2284     /// ```
2285     /// let mut slice = [1, 2, 3, 4, 5];
2286     ///
2287     /// {
2288     ///     let (left, right) = slice.split_at_mut(2);
2289     ///     left.copy_from_slice(&right[1..]);
2290     /// }
2291     ///
2292     /// assert_eq!(slice, [4, 5, 3, 4, 5]);
2293     /// ```
2294     ///
2295     /// [`clone_from_slice`]: #method.clone_from_slice
2296     /// [`split_at_mut`]: #method.split_at_mut
2297     #[stable(feature = "copy_from_slice", since = "1.9.0")]
2298     pub fn copy_from_slice(&mut self, src: &[T])
2299     where
2300         T: Copy,
2301     {
2302         assert_eq!(self.len(), src.len(), "destination and source slices have different lengths");
2303         unsafe {
2304             ptr::copy_nonoverlapping(src.as_ptr(), self.as_mut_ptr(), self.len());
2305         }
2306     }
2307
2308     /// Copies elements from one part of the slice to another part of itself,
2309     /// using a memmove.
2310     ///
2311     /// `src` is the range within `self` to copy from. `dest` is the starting
2312     /// index of the range within `self` to copy to, which will have the same
2313     /// length as `src`. The two ranges may overlap. The ends of the two ranges
2314     /// must be less than or equal to `self.len()`.
2315     ///
2316     /// # Panics
2317     ///
2318     /// This function will panic if either range exceeds the end of the slice,
2319     /// or if the end of `src` is before the start.
2320     ///
2321     /// # Examples
2322     ///
2323     /// Copying four bytes within a slice:
2324     ///
2325     /// ```
2326     /// let mut bytes = *b"Hello, World!";
2327     ///
2328     /// bytes.copy_within(1..5, 8);
2329     ///
2330     /// assert_eq!(&bytes, b"Hello, Wello!");
2331     /// ```
2332     #[stable(feature = "copy_within", since = "1.37.0")]
2333     #[track_caller]
2334     pub fn copy_within<R: ops::RangeBounds<usize>>(&mut self, src: R, dest: usize)
2335     where
2336         T: Copy,
2337     {
2338         let src_start = match src.start_bound() {
2339             ops::Bound::Included(&n) => n,
2340             ops::Bound::Excluded(&n) => {
2341                 n.checked_add(1).unwrap_or_else(|| slice_index_overflow_fail())
2342             }
2343             ops::Bound::Unbounded => 0,
2344         };
2345         let src_end = match src.end_bound() {
2346             ops::Bound::Included(&n) => {
2347                 n.checked_add(1).unwrap_or_else(|| slice_index_overflow_fail())
2348             }
2349             ops::Bound::Excluded(&n) => n,
2350             ops::Bound::Unbounded => self.len(),
2351         };
2352         assert!(src_start <= src_end, "src end is before src start");
2353         assert!(src_end <= self.len(), "src is out of bounds");
2354         let count = src_end - src_start;
2355         assert!(dest <= self.len() - count, "dest is out of bounds");
2356         unsafe {
2357             ptr::copy(self.as_ptr().add(src_start), self.as_mut_ptr().add(dest), count);
2358         }
2359     }
2360
2361     /// Swaps all elements in `self` with those in `other`.
2362     ///
2363     /// The length of `other` must be the same as `self`.
2364     ///
2365     /// # Panics
2366     ///
2367     /// This function will panic if the two slices have different lengths.
2368     ///
2369     /// # Example
2370     ///
2371     /// Swapping two elements across slices:
2372     ///
2373     /// ```
2374     /// let mut slice1 = [0, 0];
2375     /// let mut slice2 = [1, 2, 3, 4];
2376     ///
2377     /// slice1.swap_with_slice(&mut slice2[2..]);
2378     ///
2379     /// assert_eq!(slice1, [3, 4]);
2380     /// assert_eq!(slice2, [1, 2, 0, 0]);
2381     /// ```
2382     ///
2383     /// Rust enforces that there can only be one mutable reference to a
2384     /// particular piece of data in a particular scope. Because of this,
2385     /// attempting to use `swap_with_slice` on a single slice will result in
2386     /// a compile failure:
2387     ///
2388     /// ```compile_fail
2389     /// let mut slice = [1, 2, 3, 4, 5];
2390     /// slice[..2].swap_with_slice(&mut slice[3..]); // compile fail!
2391     /// ```
2392     ///
2393     /// To work around this, we can use [`split_at_mut`] to create two distinct
2394     /// mutable sub-slices from a slice:
2395     ///
2396     /// ```
2397     /// let mut slice = [1, 2, 3, 4, 5];
2398     ///
2399     /// {
2400     ///     let (left, right) = slice.split_at_mut(2);
2401     ///     left.swap_with_slice(&mut right[1..]);
2402     /// }
2403     ///
2404     /// assert_eq!(slice, [4, 5, 3, 1, 2]);
2405     /// ```
2406     ///
2407     /// [`split_at_mut`]: #method.split_at_mut
2408     #[stable(feature = "swap_with_slice", since = "1.27.0")]
2409     pub fn swap_with_slice(&mut self, other: &mut [T]) {
2410         assert!(self.len() == other.len(), "destination and source slices have different lengths");
2411         unsafe {
2412             ptr::swap_nonoverlapping(self.as_mut_ptr(), other.as_mut_ptr(), self.len());
2413         }
2414     }
2415
2416     /// Function to calculate lengths of the middle and trailing slice for `align_to{,_mut}`.
2417     fn align_to_offsets<U>(&self) -> (usize, usize) {
2418         // What we gonna do about `rest` is figure out what multiple of `U`s we can put in a
2419         // lowest number of `T`s. And how many `T`s we need for each such "multiple".
2420         //
2421         // Consider for example T=u8 U=u16. Then we can put 1 U in 2 Ts. Simple. Now, consider
2422         // for example a case where size_of::<T> = 16, size_of::<U> = 24. We can put 2 Us in
2423         // place of every 3 Ts in the `rest` slice. A bit more complicated.
2424         //
2425         // Formula to calculate this is:
2426         //
2427         // Us = lcm(size_of::<T>, size_of::<U>) / size_of::<U>
2428         // Ts = lcm(size_of::<T>, size_of::<U>) / size_of::<T>
2429         //
2430         // Expanded and simplified:
2431         //
2432         // Us = size_of::<T> / gcd(size_of::<T>, size_of::<U>)
2433         // Ts = size_of::<U> / gcd(size_of::<T>, size_of::<U>)
2434         //
2435         // Luckily since all this is constant-evaluated... performance here matters not!
2436         #[inline]
2437         fn gcd(a: usize, b: usize) -> usize {
2438             use crate::intrinsics;
2439             // iterative stein’s algorithm
2440             // We should still make this `const fn` (and revert to recursive algorithm if we do)
2441             // because relying on llvm to consteval all this is… well, it makes me uncomfortable.
2442             let (ctz_a, mut ctz_b) = unsafe {
2443                 if a == 0 {
2444                     return b;
2445                 }
2446                 if b == 0 {
2447                     return a;
2448                 }
2449                 (intrinsics::cttz_nonzero(a), intrinsics::cttz_nonzero(b))
2450             };
2451             let k = ctz_a.min(ctz_b);
2452             let mut a = a >> ctz_a;
2453             let mut b = b;
2454             loop {
2455                 // remove all factors of 2 from b
2456                 b >>= ctz_b;
2457                 if a > b {
2458                     mem::swap(&mut a, &mut b);
2459                 }
2460                 b = b - a;
2461                 unsafe {
2462                     if b == 0 {
2463                         break;
2464                     }
2465                     ctz_b = intrinsics::cttz_nonzero(b);
2466                 }
2467             }
2468             a << k
2469         }
2470         let gcd: usize = gcd(mem::size_of::<T>(), mem::size_of::<U>());
2471         let ts: usize = mem::size_of::<U>() / gcd;
2472         let us: usize = mem::size_of::<T>() / gcd;
2473
2474         // Armed with this knowledge, we can find how many `U`s we can fit!
2475         let us_len = self.len() / ts * us;
2476         // And how many `T`s will be in the trailing slice!
2477         let ts_len = self.len() % ts;
2478         (us_len, ts_len)
2479     }
2480
2481     /// Transmute the slice to a slice of another type, ensuring alignment of the types is
2482     /// maintained.
2483     ///
2484     /// This method splits the slice into three distinct slices: prefix, correctly aligned middle
2485     /// slice of a new type, and the suffix slice. The method may make the middle slice the greatest
2486     /// length possible for a given type and input slice, but only your algorithm's performance
2487     /// should depend on that, not its correctness. It is permissible for all of the input data to
2488     /// be returned as the prefix or suffix slice.
2489     ///
2490     /// This method has no purpose when either input element `T` or output element `U` are
2491     /// zero-sized and will return the original slice without splitting anything.
2492     ///
2493     /// # Safety
2494     ///
2495     /// This method is essentially a `transmute` with respect to the elements in the returned
2496     /// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here.
2497     ///
2498     /// # Examples
2499     ///
2500     /// Basic usage:
2501     ///
2502     /// ```
2503     /// unsafe {
2504     ///     let bytes: [u8; 7] = [1, 2, 3, 4, 5, 6, 7];
2505     ///     let (prefix, shorts, suffix) = bytes.align_to::<u16>();
2506     ///     // less_efficient_algorithm_for_bytes(prefix);
2507     ///     // more_efficient_algorithm_for_aligned_shorts(shorts);
2508     ///     // less_efficient_algorithm_for_bytes(suffix);
2509     /// }
2510     /// ```
2511     #[stable(feature = "slice_align_to", since = "1.30.0")]
2512     pub unsafe fn align_to<U>(&self) -> (&[T], &[U], &[T]) {
2513         // Note that most of this function will be constant-evaluated,
2514         if mem::size_of::<U>() == 0 || mem::size_of::<T>() == 0 {
2515             // handle ZSTs specially, which is – don't handle them at all.
2516             return (self, &[], &[]);
2517         }
2518
2519         // First, find at what point do we split between the first and 2nd slice. Easy with
2520         // ptr.align_offset.
2521         let ptr = self.as_ptr();
2522         let offset = crate::ptr::align_offset(ptr, mem::align_of::<U>());
2523         if offset > self.len() {
2524             (self, &[], &[])
2525         } else {
2526             let (left, rest) = self.split_at(offset);
2527             // now `rest` is definitely aligned, so `from_raw_parts_mut` below is okay
2528             let (us_len, ts_len) = rest.align_to_offsets::<U>();
2529             (
2530                 left,
2531                 from_raw_parts(rest.as_ptr() as *const U, us_len),
2532                 from_raw_parts(rest.as_ptr().add(rest.len() - ts_len), ts_len),
2533             )
2534         }
2535     }
2536
2537     /// Transmute the slice to a slice of another type, ensuring alignment of the types is
2538     /// maintained.
2539     ///
2540     /// This method splits the slice into three distinct slices: prefix, correctly aligned middle
2541     /// slice of a new type, and the suffix slice. The method may make the middle slice the greatest
2542     /// length possible for a given type and input slice, but only your algorithm's performance
2543     /// should depend on that, not its correctness. It is permissible for all of the input data to
2544     /// be returned as the prefix or suffix slice.
2545     ///
2546     /// This method has no purpose when either input element `T` or output element `U` are
2547     /// zero-sized and will return the original slice without splitting anything.
2548     ///
2549     /// # Safety
2550     ///
2551     /// This method is essentially a `transmute` with respect to the elements in the returned
2552     /// middle slice, so all the usual caveats pertaining to `transmute::<T, U>` also apply here.
2553     ///
2554     /// # Examples
2555     ///
2556     /// Basic usage:
2557     ///
2558     /// ```
2559     /// unsafe {
2560     ///     let mut bytes: [u8; 7] = [1, 2, 3, 4, 5, 6, 7];
2561     ///     let (prefix, shorts, suffix) = bytes.align_to_mut::<u16>();
2562     ///     // less_efficient_algorithm_for_bytes(prefix);
2563     ///     // more_efficient_algorithm_for_aligned_shorts(shorts);
2564     ///     // less_efficient_algorithm_for_bytes(suffix);
2565     /// }
2566     /// ```
2567     #[stable(feature = "slice_align_to", since = "1.30.0")]
2568     pub unsafe fn align_to_mut<U>(&mut self) -> (&mut [T], &mut [U], &mut [T]) {
2569         // Note that most of this function will be constant-evaluated,
2570         if mem::size_of::<U>() == 0 || mem::size_of::<T>() == 0 {
2571             // handle ZSTs specially, which is – don't handle them at all.
2572             return (self, &mut [], &mut []);
2573         }
2574
2575         // First, find at what point do we split between the first and 2nd slice. Easy with
2576         // ptr.align_offset.
2577         let ptr = self.as_ptr();
2578         let offset = crate::ptr::align_offset(ptr, mem::align_of::<U>());
2579         if offset > self.len() {
2580             (self, &mut [], &mut [])
2581         } else {
2582             let (left, rest) = self.split_at_mut(offset);
2583             // now `rest` is definitely aligned, so `from_raw_parts_mut` below is okay
2584             let (us_len, ts_len) = rest.align_to_offsets::<U>();
2585             let rest_len = rest.len();
2586             let mut_ptr = rest.as_mut_ptr();
2587             // We can't use `rest` again after this, that would invalidate its alias `mut_ptr`!
2588             (
2589                 left,
2590                 from_raw_parts_mut(mut_ptr as *mut U, us_len),
2591                 from_raw_parts_mut(mut_ptr.add(rest_len - ts_len), ts_len),
2592             )
2593         }
2594     }
2595
2596     /// Checks if the elements of this slice are sorted.
2597     ///
2598     /// That is, for each element `a` and its following element `b`, `a <= b` must hold. If the
2599     /// slice yields exactly zero or one element, `true` is returned.
2600     ///
2601     /// Note that if `Self::Item` is only `PartialOrd`, but not `Ord`, the above definition
2602     /// implies that this function returns `false` if any two consecutive items are not
2603     /// comparable.
2604     ///
2605     /// # Examples
2606     ///
2607     /// ```
2608     /// #![feature(is_sorted)]
2609     /// let empty: [i32; 0] = [];
2610     ///
2611     /// assert!([1, 2, 2, 9].is_sorted());
2612     /// assert!(![1, 3, 2, 4].is_sorted());
2613     /// assert!([0].is_sorted());
2614     /// assert!(empty.is_sorted());
2615     /// assert!(![0.0, 1.0, f32::NAN].is_sorted());
2616     /// ```
2617     #[inline]
2618     #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
2619     pub fn is_sorted(&self) -> bool
2620     where
2621         T: PartialOrd,
2622     {
2623         self.is_sorted_by(|a, b| a.partial_cmp(b))
2624     }
2625
2626     /// Checks if the elements of this slice are sorted using the given comparator function.
2627     ///
2628     /// Instead of using `PartialOrd::partial_cmp`, this function uses the given `compare`
2629     /// function to determine the ordering of two elements. Apart from that, it's equivalent to
2630     /// [`is_sorted`]; see its documentation for more information.
2631     ///
2632     /// [`is_sorted`]: #method.is_sorted
2633     #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
2634     pub fn is_sorted_by<F>(&self, mut compare: F) -> bool
2635     where
2636         F: FnMut(&T, &T) -> Option<Ordering>,
2637     {
2638         self.iter().is_sorted_by(|a, b| compare(*a, *b))
2639     }
2640
2641     /// Checks if the elements of this slice are sorted using the given key extraction function.
2642     ///
2643     /// Instead of comparing the slice's elements directly, this function compares the keys of the
2644     /// elements, as determined by `f`. Apart from that, it's equivalent to [`is_sorted`]; see its
2645     /// documentation for more information.
2646     ///
2647     /// [`is_sorted`]: #method.is_sorted
2648     ///
2649     /// # Examples
2650     ///
2651     /// ```
2652     /// #![feature(is_sorted)]
2653     ///
2654     /// assert!(["c", "bb", "aaa"].is_sorted_by_key(|s| s.len()));
2655     /// assert!(![-2i32, -1, 0, 3].is_sorted_by_key(|n| n.abs()));
2656     /// ```
2657     #[inline]
2658     #[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
2659     pub fn is_sorted_by_key<F, K>(&self, f: F) -> bool
2660     where
2661         F: FnMut(&T) -> K,
2662         K: PartialOrd,
2663     {
2664         self.iter().is_sorted_by_key(f)
2665     }
2666
2667     /// Returns index of partition point according to the given predicate,
2668     /// such that all those that return true precede the index and
2669     /// such that all those that return false succeed the index.
2670     ///
2671     /// The slice must be partitioned
2672     /// so that all elements where the predicate returns true
2673     /// precede the elements where the predicate returns false.
2674     ///
2675     /// # Examples
2676     ///
2677     /// ```
2678     /// #![feature(partition_point)]
2679     ///
2680     /// let v = [1, 2, 3, 3, 5, 6, 7];
2681     /// let i = v.partition_point(|&x| x < 5);
2682     ///
2683     /// assert_eq!(i, 4);
2684     /// assert!(v[..i].iter().all(|&x| x < 5));
2685     /// assert!(v[i..].iter().all(|&x| !(x < 5)));
2686     /// ```
2687     #[unstable(feature = "partition_point", reason = "new API", issue = "99999")]
2688     pub fn partition_point<P>(&self, mut pred: P) -> usize
2689     where
2690         P: FnMut(&T) -> bool,
2691     {
2692         let mut left = 0;
2693         let mut right = self.len();
2694
2695         while left != right {
2696             let mid = left + (right - left) / 2;
2697             // SAFETY:
2698             // When left < right, left <= mid < right.
2699             // Therefore left always increases and right always decreases,
2700             // and eigher of them is selected.
2701             // In both cases left <= right is satisfied.
2702             // Therefore if left < right in a step,
2703             // left <= right is satisfied in the next step.
2704             // Therefore as long as left != right, 0 <= left < right <= len is satisfied
2705             // and if this case 0 <= mid < len is satisfied too.
2706             let value = unsafe { self.get_unchecked(mid) };
2707             if pred(value) {
2708                 left = mid + 1;
2709             } else {
2710                 right = mid;
2711             }
2712         }
2713
2714         left
2715     }
2716 }
2717
2718 #[lang = "slice_u8"]
2719 #[cfg(not(test))]
2720 impl [u8] {
2721     /// Checks if all bytes in this slice are within the ASCII range.
2722     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2723     #[inline]
2724     pub fn is_ascii(&self) -> bool {
2725         self.iter().all(|b| b.is_ascii())
2726     }
2727
2728     /// Checks that two slices are an ASCII case-insensitive match.
2729     ///
2730     /// Same as `to_ascii_lowercase(a) == to_ascii_lowercase(b)`,
2731     /// but without allocating and copying temporaries.
2732     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2733     #[inline]
2734     pub fn eq_ignore_ascii_case(&self, other: &[u8]) -> bool {
2735         self.len() == other.len() && self.iter().zip(other).all(|(a, b)| a.eq_ignore_ascii_case(b))
2736     }
2737
2738     /// Converts this slice to its ASCII upper case equivalent in-place.
2739     ///
2740     /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
2741     /// but non-ASCII letters are unchanged.
2742     ///
2743     /// To return a new uppercased value without modifying the existing one, use
2744     /// [`to_ascii_uppercase`].
2745     ///
2746     /// [`to_ascii_uppercase`]: #method.to_ascii_uppercase
2747     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2748     #[inline]
2749     pub fn make_ascii_uppercase(&mut self) {
2750         for byte in self {
2751             byte.make_ascii_uppercase();
2752         }
2753     }
2754
2755     /// Converts this slice to its ASCII lower case equivalent in-place.
2756     ///
2757     /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
2758     /// but non-ASCII letters are unchanged.
2759     ///
2760     /// To return a new lowercased value without modifying the existing one, use
2761     /// [`to_ascii_lowercase`].
2762     ///
2763     /// [`to_ascii_lowercase`]: #method.to_ascii_lowercase
2764     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2765     #[inline]
2766     pub fn make_ascii_lowercase(&mut self) {
2767         for byte in self {
2768             byte.make_ascii_lowercase();
2769         }
2770     }
2771 }
2772
2773 #[stable(feature = "rust1", since = "1.0.0")]
2774 impl<T, I> ops::Index<I> for [T]
2775 where
2776     I: SliceIndex<[T]>,
2777 {
2778     type Output = I::Output;
2779
2780     #[inline]
2781     fn index(&self, index: I) -> &I::Output {
2782         index.index(self)
2783     }
2784 }
2785
2786 #[stable(feature = "rust1", since = "1.0.0")]
2787 impl<T, I> ops::IndexMut<I> for [T]
2788 where
2789     I: SliceIndex<[T]>,
2790 {
2791     #[inline]
2792     fn index_mut(&mut self, index: I) -> &mut I::Output {
2793         index.index_mut(self)
2794     }
2795 }
2796
2797 #[inline(never)]
2798 #[cold]
2799 #[track_caller]
2800 fn slice_index_len_fail(index: usize, len: usize) -> ! {
2801     panic!("index {} out of range for slice of length {}", index, len);
2802 }
2803
2804 #[inline(never)]
2805 #[cold]
2806 #[track_caller]
2807 fn slice_index_order_fail(index: usize, end: usize) -> ! {
2808     panic!("slice index starts at {} but ends at {}", index, end);
2809 }
2810
2811 #[inline(never)]
2812 #[cold]
2813 #[track_caller]
2814 fn slice_index_overflow_fail() -> ! {
2815     panic!("attempted to index slice up to maximum usize");
2816 }
2817
2818 mod private_slice_index {
2819     use super::ops;
2820     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2821     pub trait Sealed {}
2822
2823     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2824     impl Sealed for usize {}
2825     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2826     impl Sealed for ops::Range<usize> {}
2827     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2828     impl Sealed for ops::RangeTo<usize> {}
2829     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2830     impl Sealed for ops::RangeFrom<usize> {}
2831     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2832     impl Sealed for ops::RangeFull {}
2833     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2834     impl Sealed for ops::RangeInclusive<usize> {}
2835     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2836     impl Sealed for ops::RangeToInclusive<usize> {}
2837 }
2838
2839 /// A helper trait used for indexing operations.
2840 #[stable(feature = "slice_get_slice", since = "1.28.0")]
2841 #[rustc_on_unimplemented(
2842     on(T = "str", label = "string indices are ranges of `usize`",),
2843     on(
2844         all(any(T = "str", T = "&str", T = "std::string::String"), _Self = "{integer}"),
2845         note = "you can use `.chars().nth()` or `.bytes().nth()`
2846 see chapter in The Book <https://doc.rust-lang.org/book/ch08-02-strings.html#indexing-into-strings>"
2847     ),
2848     message = "the type `{T}` cannot be indexed by `{Self}`",
2849     label = "slice indices are of type `usize` or ranges of `usize`"
2850 )]
2851 pub trait SliceIndex<T: ?Sized>: private_slice_index::Sealed {
2852     /// The output type returned by methods.
2853     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2854     type Output: ?Sized;
2855
2856     /// Returns a shared reference to the output at this location, if in
2857     /// bounds.
2858     #[unstable(feature = "slice_index_methods", issue = "none")]
2859     fn get(self, slice: &T) -> Option<&Self::Output>;
2860
2861     /// Returns a mutable reference to the output at this location, if in
2862     /// bounds.
2863     #[unstable(feature = "slice_index_methods", issue = "none")]
2864     fn get_mut(self, slice: &mut T) -> Option<&mut Self::Output>;
2865
2866     /// Returns a shared reference to the output at this location, without
2867     /// performing any bounds checking.
2868     /// Calling this method with an out-of-bounds index is *[undefined behavior]*
2869     /// even if the resulting reference is not used.
2870     /// [undefined behavior]: ../../reference/behavior-considered-undefined.html
2871     #[unstable(feature = "slice_index_methods", issue = "none")]
2872     unsafe fn get_unchecked(self, slice: &T) -> &Self::Output;
2873
2874     /// Returns a mutable reference to the output at this location, without
2875     /// performing any bounds checking.
2876     /// Calling this method with an out-of-bounds index is *[undefined behavior]*
2877     /// even if the resulting reference is not used.
2878     /// [undefined behavior]: ../../reference/behavior-considered-undefined.html
2879     #[unstable(feature = "slice_index_methods", issue = "none")]
2880     unsafe fn get_unchecked_mut(self, slice: &mut T) -> &mut Self::Output;
2881
2882     /// Returns a shared reference to the output at this location, panicking
2883     /// if out of bounds.
2884     #[unstable(feature = "slice_index_methods", issue = "none")]
2885     #[track_caller]
2886     fn index(self, slice: &T) -> &Self::Output;
2887
2888     /// Returns a mutable reference to the output at this location, panicking
2889     /// if out of bounds.
2890     #[unstable(feature = "slice_index_methods", issue = "none")]
2891     #[track_caller]
2892     fn index_mut(self, slice: &mut T) -> &mut Self::Output;
2893 }
2894
2895 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2896 impl<T> SliceIndex<[T]> for usize {
2897     type Output = T;
2898
2899     #[inline]
2900     fn get(self, slice: &[T]) -> Option<&T> {
2901         if self < slice.len() { unsafe { Some(self.get_unchecked(slice)) } } else { None }
2902     }
2903
2904     #[inline]
2905     fn get_mut(self, slice: &mut [T]) -> Option<&mut T> {
2906         if self < slice.len() { unsafe { Some(self.get_unchecked_mut(slice)) } } else { None }
2907     }
2908
2909     #[inline]
2910     unsafe fn get_unchecked(self, slice: &[T]) -> &T {
2911         &*slice.as_ptr().add(self)
2912     }
2913
2914     #[inline]
2915     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut T {
2916         &mut *slice.as_mut_ptr().add(self)
2917     }
2918
2919     #[inline]
2920     fn index(self, slice: &[T]) -> &T {
2921         // N.B., use intrinsic indexing
2922         &(*slice)[self]
2923     }
2924
2925     #[inline]
2926     fn index_mut(self, slice: &mut [T]) -> &mut T {
2927         // N.B., use intrinsic indexing
2928         &mut (*slice)[self]
2929     }
2930 }
2931
2932 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2933 impl<T> SliceIndex<[T]> for ops::Range<usize> {
2934     type Output = [T];
2935
2936     #[inline]
2937     fn get(self, slice: &[T]) -> Option<&[T]> {
2938         if self.start > self.end || self.end > slice.len() {
2939             None
2940         } else {
2941             unsafe { Some(self.get_unchecked(slice)) }
2942         }
2943     }
2944
2945     #[inline]
2946     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2947         if self.start > self.end || self.end > slice.len() {
2948             None
2949         } else {
2950             unsafe { Some(self.get_unchecked_mut(slice)) }
2951         }
2952     }
2953
2954     #[inline]
2955     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2956         from_raw_parts(slice.as_ptr().add(self.start), self.end - self.start)
2957     }
2958
2959     #[inline]
2960     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2961         from_raw_parts_mut(slice.as_mut_ptr().add(self.start), self.end - self.start)
2962     }
2963
2964     #[inline]
2965     fn index(self, slice: &[T]) -> &[T] {
2966         if self.start > self.end {
2967             slice_index_order_fail(self.start, self.end);
2968         } else if self.end > slice.len() {
2969             slice_index_len_fail(self.end, slice.len());
2970         }
2971         unsafe { self.get_unchecked(slice) }
2972     }
2973
2974     #[inline]
2975     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2976         if self.start > self.end {
2977             slice_index_order_fail(self.start, self.end);
2978         } else if self.end > slice.len() {
2979             slice_index_len_fail(self.end, slice.len());
2980         }
2981         unsafe { self.get_unchecked_mut(slice) }
2982     }
2983 }
2984
2985 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2986 impl<T> SliceIndex<[T]> for ops::RangeTo<usize> {
2987     type Output = [T];
2988
2989     #[inline]
2990     fn get(self, slice: &[T]) -> Option<&[T]> {
2991         (0..self.end).get(slice)
2992     }
2993
2994     #[inline]
2995     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2996         (0..self.end).get_mut(slice)
2997     }
2998
2999     #[inline]
3000     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3001         (0..self.end).get_unchecked(slice)
3002     }
3003
3004     #[inline]
3005     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3006         (0..self.end).get_unchecked_mut(slice)
3007     }
3008
3009     #[inline]
3010     fn index(self, slice: &[T]) -> &[T] {
3011         (0..self.end).index(slice)
3012     }
3013
3014     #[inline]
3015     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3016         (0..self.end).index_mut(slice)
3017     }
3018 }
3019
3020 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
3021 impl<T> SliceIndex<[T]> for ops::RangeFrom<usize> {
3022     type Output = [T];
3023
3024     #[inline]
3025     fn get(self, slice: &[T]) -> Option<&[T]> {
3026         (self.start..slice.len()).get(slice)
3027     }
3028
3029     #[inline]
3030     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
3031         (self.start..slice.len()).get_mut(slice)
3032     }
3033
3034     #[inline]
3035     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3036         (self.start..slice.len()).get_unchecked(slice)
3037     }
3038
3039     #[inline]
3040     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3041         (self.start..slice.len()).get_unchecked_mut(slice)
3042     }
3043
3044     #[inline]
3045     fn index(self, slice: &[T]) -> &[T] {
3046         (self.start..slice.len()).index(slice)
3047     }
3048
3049     #[inline]
3050     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3051         (self.start..slice.len()).index_mut(slice)
3052     }
3053 }
3054
3055 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
3056 impl<T> SliceIndex<[T]> for ops::RangeFull {
3057     type Output = [T];
3058
3059     #[inline]
3060     fn get(self, slice: &[T]) -> Option<&[T]> {
3061         Some(slice)
3062     }
3063
3064     #[inline]
3065     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
3066         Some(slice)
3067     }
3068
3069     #[inline]
3070     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3071         slice
3072     }
3073
3074     #[inline]
3075     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3076         slice
3077     }
3078
3079     #[inline]
3080     fn index(self, slice: &[T]) -> &[T] {
3081         slice
3082     }
3083
3084     #[inline]
3085     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3086         slice
3087     }
3088 }
3089
3090 #[stable(feature = "inclusive_range", since = "1.26.0")]
3091 impl<T> SliceIndex<[T]> for ops::RangeInclusive<usize> {
3092     type Output = [T];
3093
3094     #[inline]
3095     fn get(self, slice: &[T]) -> Option<&[T]> {
3096         if *self.end() == usize::MAX { None } else { (*self.start()..self.end() + 1).get(slice) }
3097     }
3098
3099     #[inline]
3100     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
3101         if *self.end() == usize::MAX {
3102             None
3103         } else {
3104             (*self.start()..self.end() + 1).get_mut(slice)
3105         }
3106     }
3107
3108     #[inline]
3109     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3110         (*self.start()..self.end() + 1).get_unchecked(slice)
3111     }
3112
3113     #[inline]
3114     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3115         (*self.start()..self.end() + 1).get_unchecked_mut(slice)
3116     }
3117
3118     #[inline]
3119     fn index(self, slice: &[T]) -> &[T] {
3120         if *self.end() == usize::MAX {
3121             slice_index_overflow_fail();
3122         }
3123         (*self.start()..self.end() + 1).index(slice)
3124     }
3125
3126     #[inline]
3127     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3128         if *self.end() == usize::MAX {
3129             slice_index_overflow_fail();
3130         }
3131         (*self.start()..self.end() + 1).index_mut(slice)
3132     }
3133 }
3134
3135 #[stable(feature = "inclusive_range", since = "1.26.0")]
3136 impl<T> SliceIndex<[T]> for ops::RangeToInclusive<usize> {
3137     type Output = [T];
3138
3139     #[inline]
3140     fn get(self, slice: &[T]) -> Option<&[T]> {
3141         (0..=self.end).get(slice)
3142     }
3143
3144     #[inline]
3145     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
3146         (0..=self.end).get_mut(slice)
3147     }
3148
3149     #[inline]
3150     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3151         (0..=self.end).get_unchecked(slice)
3152     }
3153
3154     #[inline]
3155     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3156         (0..=self.end).get_unchecked_mut(slice)
3157     }
3158
3159     #[inline]
3160     fn index(self, slice: &[T]) -> &[T] {
3161         (0..=self.end).index(slice)
3162     }
3163
3164     #[inline]
3165     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3166         (0..=self.end).index_mut(slice)
3167     }
3168 }
3169
3170 ////////////////////////////////////////////////////////////////////////////////
3171 // Common traits
3172 ////////////////////////////////////////////////////////////////////////////////
3173
3174 #[stable(feature = "rust1", since = "1.0.0")]
3175 impl<T> Default for &[T] {
3176     /// Creates an empty slice.
3177     fn default() -> Self {
3178         &[]
3179     }
3180 }
3181
3182 #[stable(feature = "mut_slice_default", since = "1.5.0")]
3183 impl<T> Default for &mut [T] {
3184     /// Creates a mutable empty slice.
3185     fn default() -> Self {
3186         &mut []
3187     }
3188 }
3189
3190 //
3191 // Iterators
3192 //
3193
3194 #[stable(feature = "rust1", since = "1.0.0")]
3195 impl<'a, T> IntoIterator for &'a [T] {
3196     type Item = &'a T;
3197     type IntoIter = Iter<'a, T>;
3198
3199     fn into_iter(self) -> Iter<'a, T> {
3200         self.iter()
3201     }
3202 }
3203
3204 #[stable(feature = "rust1", since = "1.0.0")]
3205 impl<'a, T> IntoIterator for &'a mut [T] {
3206     type Item = &'a mut T;
3207     type IntoIter = IterMut<'a, T>;
3208
3209     fn into_iter(self) -> IterMut<'a, T> {
3210         self.iter_mut()
3211     }
3212 }
3213
3214 // Macro helper functions
3215 #[inline(always)]
3216 fn size_from_ptr<T>(_: *const T) -> usize {
3217     mem::size_of::<T>()
3218 }
3219
3220 // Inlining is_empty and len makes a huge performance difference
3221 macro_rules! is_empty {
3222     // The way we encode the length of a ZST iterator, this works both for ZST
3223     // and non-ZST.
3224     ($self: ident) => {
3225         $self.ptr.as_ptr() as *const T == $self.end
3226     };
3227 }
3228
3229 // To get rid of some bounds checks (see `position`), we compute the length in a somewhat
3230 // unexpected way. (Tested by `codegen/slice-position-bounds-check`.)
3231 macro_rules! len {
3232     ($self: ident) => {{
3233         #![allow(unused_unsafe)] // we're sometimes used within an unsafe block
3234
3235         let start = $self.ptr;
3236         let size = size_from_ptr(start.as_ptr());
3237         if size == 0 {
3238             // This _cannot_ use `unchecked_sub` because we depend on wrapping
3239             // to represent the length of long ZST slice iterators.
3240             ($self.end as usize).wrapping_sub(start.as_ptr() as usize)
3241         } else {
3242             // We know that `start <= end`, so can do better than `offset_from`,
3243             // which needs to deal in signed.  By setting appropriate flags here
3244             // we can tell LLVM this, which helps it remove bounds checks.
3245             // SAFETY: By the type invariant, `start <= end`
3246             let diff = unsafe { unchecked_sub($self.end as usize, start.as_ptr() as usize) };
3247             // By also telling LLVM that the pointers are apart by an exact
3248             // multiple of the type size, it can optimize `len() == 0` down to
3249             // `start == end` instead of `(end - start) < size`.
3250             // SAFETY: By the type invariant, the pointers are aligned so the
3251             //         distance between them must be a multiple of pointee size
3252             unsafe { exact_div(diff, size) }
3253         }
3254     }};
3255 }
3256
3257 // The shared definition of the `Iter` and `IterMut` iterators
3258 macro_rules! iterator {
3259     (
3260         struct $name:ident -> $ptr:ty,
3261         $elem:ty,
3262         $raw_mut:tt,
3263         {$( $mut_:tt )*},
3264         {$($extra:tt)*}
3265     ) => {
3266         // Returns the first element and moves the start of the iterator forwards by 1.
3267         // Greatly improves performance compared to an inlined function. The iterator
3268         // must not be empty.
3269         macro_rules! next_unchecked {
3270             ($self: ident) => {& $( $mut_ )* *$self.post_inc_start(1)}
3271         }
3272
3273         // Returns the last element and moves the end of the iterator backwards by 1.
3274         // Greatly improves performance compared to an inlined function. The iterator
3275         // must not be empty.
3276         macro_rules! next_back_unchecked {
3277             ($self: ident) => {& $( $mut_ )* *$self.pre_dec_end(1)}
3278         }
3279
3280         // Shrinks the iterator when T is a ZST, by moving the end of the iterator
3281         // backwards by `n`. `n` must not exceed `self.len()`.
3282         macro_rules! zst_shrink {
3283             ($self: ident, $n: ident) => {
3284                 $self.end = ($self.end as * $raw_mut u8).wrapping_offset(-$n) as * $raw_mut T;
3285             }
3286         }
3287
3288         impl<'a, T> $name<'a, T> {
3289             // Helper function for creating a slice from the iterator.
3290             #[inline(always)]
3291             fn make_slice(&self) -> &'a [T] {
3292                 unsafe { from_raw_parts(self.ptr.as_ptr(), len!(self)) }
3293             }
3294
3295             // Helper function for moving the start of the iterator forwards by `offset` elements,
3296             // returning the old start.
3297             // Unsafe because the offset must not exceed `self.len()`.
3298             #[inline(always)]
3299             unsafe fn post_inc_start(&mut self, offset: isize) -> * $raw_mut T {
3300                 if mem::size_of::<T>() == 0 {
3301                     zst_shrink!(self, offset);
3302                     self.ptr.as_ptr()
3303                 } else {
3304                     let old = self.ptr.as_ptr();
3305                     self.ptr = NonNull::new_unchecked(self.ptr.as_ptr().offset(offset));
3306                     old
3307                 }
3308             }
3309
3310             // Helper function for moving the end of the iterator backwards by `offset` elements,
3311             // returning the new end.
3312             // Unsafe because the offset must not exceed `self.len()`.
3313             #[inline(always)]
3314             unsafe fn pre_dec_end(&mut self, offset: isize) -> * $raw_mut T {
3315                 if mem::size_of::<T>() == 0 {
3316                     zst_shrink!(self, offset);
3317                     self.ptr.as_ptr()
3318                 } else {
3319                     self.end = self.end.offset(-offset);
3320                     self.end
3321                 }
3322             }
3323         }
3324
3325         #[stable(feature = "rust1", since = "1.0.0")]
3326         impl<T> ExactSizeIterator for $name<'_, T> {
3327             #[inline(always)]
3328             fn len(&self) -> usize {
3329                 len!(self)
3330             }
3331
3332             #[inline(always)]
3333             fn is_empty(&self) -> bool {
3334                 is_empty!(self)
3335             }
3336         }
3337
3338         #[stable(feature = "rust1", since = "1.0.0")]
3339         impl<'a, T> Iterator for $name<'a, T> {
3340             type Item = $elem;
3341
3342             #[inline]
3343             fn next(&mut self) -> Option<$elem> {
3344                 // could be implemented with slices, but this avoids bounds checks
3345                 unsafe {
3346                     assume(!self.ptr.as_ptr().is_null());
3347                     if mem::size_of::<T>() != 0 {
3348                         assume(!self.end.is_null());
3349                     }
3350                     if is_empty!(self) {
3351                         None
3352                     } else {
3353                         Some(next_unchecked!(self))
3354                     }
3355                 }
3356             }
3357
3358             #[inline]
3359             fn size_hint(&self) -> (usize, Option<usize>) {
3360                 let exact = len!(self);
3361                 (exact, Some(exact))
3362             }
3363
3364             #[inline]
3365             fn count(self) -> usize {
3366                 len!(self)
3367             }
3368
3369             #[inline]
3370             fn nth(&mut self, n: usize) -> Option<$elem> {
3371                 if n >= len!(self) {
3372                     // This iterator is now empty.
3373                     if mem::size_of::<T>() == 0 {
3374                         // We have to do it this way as `ptr` may never be 0, but `end`
3375                         // could be (due to wrapping).
3376                         self.end = self.ptr.as_ptr();
3377                     } else {
3378                         unsafe {
3379                             // End can't be 0 if T isn't ZST because ptr isn't 0 and end >= ptr
3380                             self.ptr = NonNull::new_unchecked(self.end as *mut T);
3381                         }
3382                     }
3383                     return None;
3384                 }
3385                 // We are in bounds. `post_inc_start` does the right thing even for ZSTs.
3386                 unsafe {
3387                     self.post_inc_start(n as isize);
3388                     Some(next_unchecked!(self))
3389                 }
3390             }
3391
3392             #[inline]
3393             fn last(mut self) -> Option<$elem> {
3394                 self.next_back()
3395             }
3396
3397             // We override the default implementation, which uses `try_fold`,
3398             // because this simple implementation generates less LLVM IR and is
3399             // faster to compile.
3400             #[inline]
3401             fn for_each<F>(mut self, mut f: F)
3402             where
3403                 Self: Sized,
3404                 F: FnMut(Self::Item),
3405             {
3406                 while let Some(x) = self.next() {
3407                     f(x);
3408                 }
3409             }
3410
3411             // We override the default implementation, which uses `try_fold`,
3412             // because this simple implementation generates less LLVM IR and is
3413             // faster to compile.
3414             #[inline]
3415             fn all<F>(&mut self, mut f: F) -> bool
3416             where
3417                 Self: Sized,
3418                 F: FnMut(Self::Item) -> bool,
3419             {
3420                 while let Some(x) = self.next() {
3421                     if !f(x) {
3422                         return false;
3423                     }
3424                 }
3425                 true
3426             }
3427
3428             // We override the default implementation, which uses `try_fold`,
3429             // because this simple implementation generates less LLVM IR and is
3430             // faster to compile.
3431             #[inline]
3432             fn any<F>(&mut self, mut f: F) -> bool
3433             where
3434                 Self: Sized,
3435                 F: FnMut(Self::Item) -> bool,
3436             {
3437                 while let Some(x) = self.next() {
3438                     if f(x) {
3439                         return true;
3440                     }
3441                 }
3442                 false
3443             }
3444
3445             // We override the default implementation, which uses `try_fold`,
3446             // because this simple implementation generates less LLVM IR and is
3447             // faster to compile.
3448             #[inline]
3449             fn find<P>(&mut self, mut predicate: P) -> Option<Self::Item>
3450             where
3451                 Self: Sized,
3452                 P: FnMut(&Self::Item) -> bool,
3453             {
3454                 while let Some(x) = self.next() {
3455                     if predicate(&x) {
3456                         return Some(x);
3457                     }
3458                 }
3459                 None
3460             }
3461
3462             // We override the default implementation, which uses `try_fold`,
3463             // because this simple implementation generates less LLVM IR and is
3464             // faster to compile.
3465             #[inline]
3466             fn find_map<B, F>(&mut self, mut f: F) -> Option<B>
3467             where
3468                 Self: Sized,
3469                 F: FnMut(Self::Item) -> Option<B>,
3470             {
3471                 while let Some(x) = self.next() {
3472                     if let Some(y) = f(x) {
3473                         return Some(y);
3474                     }
3475                 }
3476                 None
3477             }
3478
3479             // We override the default implementation, which uses `try_fold`,
3480             // because this simple implementation generates less LLVM IR and is
3481             // faster to compile. Also, the `assume` avoids a bounds check.
3482             #[inline]
3483             #[rustc_inherit_overflow_checks]
3484             fn position<P>(&mut self, mut predicate: P) -> Option<usize> where
3485                 Self: Sized,
3486                 P: FnMut(Self::Item) -> bool,
3487             {
3488                 let n = len!(self);
3489                 let mut i = 0;
3490                 while let Some(x) = self.next() {
3491                     if predicate(x) {
3492                         unsafe { assume(i < n) };
3493                         return Some(i);
3494                     }
3495                     i += 1;
3496                 }
3497                 None
3498             }
3499
3500             // We override the default implementation, which uses `try_fold`,
3501             // because this simple implementation generates less LLVM IR and is
3502             // faster to compile. Also, the `assume` avoids a bounds check.
3503             #[inline]
3504             fn rposition<P>(&mut self, mut predicate: P) -> Option<usize> where
3505                 P: FnMut(Self::Item) -> bool,
3506                 Self: Sized + ExactSizeIterator + DoubleEndedIterator
3507             {
3508                 let n = len!(self);
3509                 let mut i = n;
3510                 while let Some(x) = self.next_back() {
3511                     i -= 1;
3512                     if predicate(x) {
3513                         unsafe { assume(i < n) };
3514                         return Some(i);
3515                     }
3516                 }
3517                 None
3518             }
3519
3520             $($extra)*
3521         }
3522
3523         #[stable(feature = "rust1", since = "1.0.0")]
3524         impl<'a, T> DoubleEndedIterator for $name<'a, T> {
3525             #[inline]
3526             fn next_back(&mut self) -> Option<$elem> {
3527                 // could be implemented with slices, but this avoids bounds checks
3528                 unsafe {
3529                     assume(!self.ptr.as_ptr().is_null());
3530                     if mem::size_of::<T>() != 0 {
3531                         assume(!self.end.is_null());
3532                     }
3533                     if is_empty!(self) {
3534                         None
3535                     } else {
3536                         Some(next_back_unchecked!(self))
3537                     }
3538                 }
3539             }
3540
3541             #[inline]
3542             fn nth_back(&mut self, n: usize) -> Option<$elem> {
3543                 if n >= len!(self) {
3544                     // This iterator is now empty.
3545                     self.end = self.ptr.as_ptr();
3546                     return None;
3547                 }
3548                 // We are in bounds. `pre_dec_end` does the right thing even for ZSTs.
3549                 unsafe {
3550                     self.pre_dec_end(n as isize);
3551                     Some(next_back_unchecked!(self))
3552                 }
3553             }
3554         }
3555
3556         #[stable(feature = "fused", since = "1.26.0")]
3557         impl<T> FusedIterator for $name<'_, T> {}
3558
3559         #[unstable(feature = "trusted_len", issue = "37572")]
3560         unsafe impl<T> TrustedLen for $name<'_, T> {}
3561     }
3562 }
3563
3564 /// Immutable slice iterator
3565 ///
3566 /// This struct is created by the [`iter`] method on [slices].
3567 ///
3568 /// # Examples
3569 ///
3570 /// Basic usage:
3571 ///
3572 /// ```
3573 /// // First, we declare a type which has `iter` method to get the `Iter` struct (&[usize here]):
3574 /// let slice = &[1, 2, 3];
3575 ///
3576 /// // Then, we iterate over it:
3577 /// for element in slice.iter() {
3578 ///     println!("{}", element);
3579 /// }
3580 /// ```
3581 ///
3582 /// [`iter`]: ../../std/primitive.slice.html#method.iter
3583 /// [slices]: ../../std/primitive.slice.html
3584 #[stable(feature = "rust1", since = "1.0.0")]
3585 pub struct Iter<'a, T: 'a> {
3586     ptr: NonNull<T>,
3587     end: *const T, // If T is a ZST, this is actually ptr+len.  This encoding is picked so that
3588     // ptr == end is a quick test for the Iterator being empty, that works
3589     // for both ZST and non-ZST.
3590     _marker: marker::PhantomData<&'a T>,
3591 }
3592
3593 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3594 impl<T: fmt::Debug> fmt::Debug for Iter<'_, T> {
3595     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3596         f.debug_tuple("Iter").field(&self.as_slice()).finish()
3597     }
3598 }
3599
3600 #[stable(feature = "rust1", since = "1.0.0")]
3601 unsafe impl<T: Sync> Sync for Iter<'_, T> {}
3602 #[stable(feature = "rust1", since = "1.0.0")]
3603 unsafe impl<T: Sync> Send for Iter<'_, T> {}
3604
3605 impl<'a, T> Iter<'a, T> {
3606     /// Views the underlying data as a subslice of the original data.
3607     ///
3608     /// This has the same lifetime as the original slice, and so the
3609     /// iterator can continue to be used while this exists.
3610     ///
3611     /// # Examples
3612     ///
3613     /// Basic usage:
3614     ///
3615     /// ```
3616     /// // First, we declare a type which has the `iter` method to get the `Iter`
3617     /// // struct (&[usize here]):
3618     /// let slice = &[1, 2, 3];
3619     ///
3620     /// // Then, we get the iterator:
3621     /// let mut iter = slice.iter();
3622     /// // So if we print what `as_slice` method returns here, we have "[1, 2, 3]":
3623     /// println!("{:?}", iter.as_slice());
3624     ///
3625     /// // Next, we move to the second element of the slice:
3626     /// iter.next();
3627     /// // Now `as_slice` returns "[2, 3]":
3628     /// println!("{:?}", iter.as_slice());
3629     /// ```
3630     #[stable(feature = "iter_to_slice", since = "1.4.0")]
3631     pub fn as_slice(&self) -> &'a [T] {
3632         self.make_slice()
3633     }
3634 }
3635
3636 iterator! {struct Iter -> *const T, &'a T, const, {/* no mut */}, {
3637     fn is_sorted_by<F>(self, mut compare: F) -> bool
3638     where
3639         Self: Sized,
3640         F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,
3641     {
3642         self.as_slice().windows(2).all(|w| {
3643             compare(&&w[0], &&w[1]).map(|o| o != Ordering::Greater).unwrap_or(false)
3644         })
3645     }
3646 }}
3647
3648 #[stable(feature = "rust1", since = "1.0.0")]
3649 impl<T> Clone for Iter<'_, T> {
3650     fn clone(&self) -> Self {
3651         Iter { ptr: self.ptr, end: self.end, _marker: self._marker }
3652     }
3653 }
3654
3655 #[stable(feature = "slice_iter_as_ref", since = "1.13.0")]
3656 impl<T> AsRef<[T]> for Iter<'_, T> {
3657     fn as_ref(&self) -> &[T] {
3658         self.as_slice()
3659     }
3660 }
3661
3662 /// Mutable slice iterator.
3663 ///
3664 /// This struct is created by the [`iter_mut`] method on [slices].
3665 ///
3666 /// # Examples
3667 ///
3668 /// Basic usage:
3669 ///
3670 /// ```
3671 /// // First, we declare a type which has `iter_mut` method to get the `IterMut`
3672 /// // struct (&[usize here]):
3673 /// let mut slice = &mut [1, 2, 3];
3674 ///
3675 /// // Then, we iterate over it and increment each element value:
3676 /// for element in slice.iter_mut() {
3677 ///     *element += 1;
3678 /// }
3679 ///
3680 /// // We now have "[2, 3, 4]":
3681 /// println!("{:?}", slice);
3682 /// ```
3683 ///
3684 /// [`iter_mut`]: ../../std/primitive.slice.html#method.iter_mut
3685 /// [slices]: ../../std/primitive.slice.html
3686 #[stable(feature = "rust1", since = "1.0.0")]
3687 pub struct IterMut<'a, T: 'a> {
3688     ptr: NonNull<T>,
3689     end: *mut T, // If T is a ZST, this is actually ptr+len.  This encoding is picked so that
3690     // ptr == end is a quick test for the Iterator being empty, that works
3691     // for both ZST and non-ZST.
3692     _marker: marker::PhantomData<&'a mut T>,
3693 }
3694
3695 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3696 impl<T: fmt::Debug> fmt::Debug for IterMut<'_, T> {
3697     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3698         f.debug_tuple("IterMut").field(&self.make_slice()).finish()
3699     }
3700 }
3701
3702 #[stable(feature = "rust1", since = "1.0.0")]
3703 unsafe impl<T: Sync> Sync for IterMut<'_, T> {}
3704 #[stable(feature = "rust1", since = "1.0.0")]
3705 unsafe impl<T: Send> Send for IterMut<'_, T> {}
3706
3707 impl<'a, T> IterMut<'a, T> {
3708     /// Views the underlying data as a subslice of the original data.
3709     ///
3710     /// To avoid creating `&mut` references that alias, this is forced
3711     /// to consume the iterator.
3712     ///
3713     /// # Examples
3714     ///
3715     /// Basic usage:
3716     ///
3717     /// ```
3718     /// // First, we declare a type which has `iter_mut` method to get the `IterMut`
3719     /// // struct (&[usize here]):
3720     /// let mut slice = &mut [1, 2, 3];
3721     ///
3722     /// {
3723     ///     // Then, we get the iterator:
3724     ///     let mut iter = slice.iter_mut();
3725     ///     // We move to next element:
3726     ///     iter.next();
3727     ///     // So if we print what `into_slice` method returns here, we have "[2, 3]":
3728     ///     println!("{:?}", iter.into_slice());
3729     /// }
3730     ///
3731     /// // Now let's modify a value of the slice:
3732     /// {
3733     ///     // First we get back the iterator:
3734     ///     let mut iter = slice.iter_mut();
3735     ///     // We change the value of the first element of the slice returned by the `next` method:
3736     ///     *iter.next().unwrap() += 1;
3737     /// }
3738     /// // Now slice is "[2, 2, 3]":
3739     /// println!("{:?}", slice);
3740     /// ```
3741     #[stable(feature = "iter_to_slice", since = "1.4.0")]
3742     pub fn into_slice(self) -> &'a mut [T] {
3743         unsafe { from_raw_parts_mut(self.ptr.as_ptr(), len!(self)) }
3744     }
3745
3746     /// Views the underlying data as a subslice of the original data.
3747     ///
3748     /// To avoid creating `&mut [T]` references that alias, the returned slice
3749     /// borrows its lifetime from the iterator the method is applied on.
3750     ///
3751     /// # Examples
3752     ///
3753     /// Basic usage:
3754     ///
3755     /// ```
3756     /// # #![feature(slice_iter_mut_as_slice)]
3757     /// let mut slice: &mut [usize] = &mut [1, 2, 3];
3758     ///
3759     /// // First, we get the iterator:
3760     /// let mut iter = slice.iter_mut();
3761     /// // So if we check what the `as_slice` method returns here, we have "[1, 2, 3]":
3762     /// assert_eq!(iter.as_slice(), &[1, 2, 3]);
3763     ///
3764     /// // Next, we move to the second element of the slice:
3765     /// iter.next();
3766     /// // Now `as_slice` returns "[2, 3]":
3767     /// assert_eq!(iter.as_slice(), &[2, 3]);
3768     /// ```
3769     #[unstable(feature = "slice_iter_mut_as_slice", reason = "recently added", issue = "58957")]
3770     pub fn as_slice(&self) -> &[T] {
3771         self.make_slice()
3772     }
3773 }
3774
3775 iterator! {struct IterMut -> *mut T, &'a mut T, mut, {mut}, {}}
3776
3777 /// An internal abstraction over the splitting iterators, so that
3778 /// splitn, splitn_mut etc can be implemented once.
3779 #[doc(hidden)]
3780 trait SplitIter: DoubleEndedIterator {
3781     /// Marks the underlying iterator as complete, extracting the remaining
3782     /// portion of the slice.
3783     fn finish(&mut self) -> Option<Self::Item>;
3784 }
3785
3786 /// An iterator over subslices separated by elements that match a predicate
3787 /// function.
3788 ///
3789 /// This struct is created by the [`split`] method on [slices].
3790 ///
3791 /// [`split`]: ../../std/primitive.slice.html#method.split
3792 /// [slices]: ../../std/primitive.slice.html
3793 #[stable(feature = "rust1", since = "1.0.0")]
3794 pub struct Split<'a, T: 'a, P>
3795 where
3796     P: FnMut(&T) -> bool,
3797 {
3798     v: &'a [T],
3799     pred: P,
3800     finished: bool,
3801 }
3802
3803 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3804 impl<T: fmt::Debug, P> fmt::Debug for Split<'_, T, P>
3805 where
3806     P: FnMut(&T) -> bool,
3807 {
3808     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3809         f.debug_struct("Split").field("v", &self.v).field("finished", &self.finished).finish()
3810     }
3811 }
3812
3813 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
3814 #[stable(feature = "rust1", since = "1.0.0")]
3815 impl<T, P> Clone for Split<'_, T, P>
3816 where
3817     P: Clone + FnMut(&T) -> bool,
3818 {
3819     fn clone(&self) -> Self {
3820         Split { v: self.v, pred: self.pred.clone(), finished: self.finished }
3821     }
3822 }
3823
3824 #[stable(feature = "rust1", since = "1.0.0")]
3825 impl<'a, T, P> Iterator for Split<'a, T, P>
3826 where
3827     P: FnMut(&T) -> bool,
3828 {
3829     type Item = &'a [T];
3830
3831     #[inline]
3832     fn next(&mut self) -> Option<&'a [T]> {
3833         if self.finished {
3834             return None;
3835         }
3836
3837         match self.v.iter().position(|x| (self.pred)(x)) {
3838             None => self.finish(),
3839             Some(idx) => {
3840                 let ret = Some(&self.v[..idx]);
3841                 self.v = &self.v[idx + 1..];
3842                 ret
3843             }
3844         }
3845     }
3846
3847     #[inline]
3848     fn size_hint(&self) -> (usize, Option<usize>) {
3849         if self.finished { (0, Some(0)) } else { (1, Some(self.v.len() + 1)) }
3850     }
3851 }
3852
3853 #[stable(feature = "rust1", since = "1.0.0")]
3854 impl<'a, T, P> DoubleEndedIterator for Split<'a, T, P>
3855 where
3856     P: FnMut(&T) -> bool,
3857 {
3858     #[inline]
3859     fn next_back(&mut self) -> Option<&'a [T]> {
3860         if self.finished {
3861             return None;
3862         }
3863
3864         match self.v.iter().rposition(|x| (self.pred)(x)) {
3865             None => self.finish(),
3866             Some(idx) => {
3867                 let ret = Some(&self.v[idx + 1..]);
3868                 self.v = &self.v[..idx];
3869                 ret
3870             }
3871         }
3872     }
3873 }
3874
3875 impl<'a, T, P> SplitIter for Split<'a, T, P>
3876 where
3877     P: FnMut(&T) -> bool,
3878 {
3879     #[inline]
3880     fn finish(&mut self) -> Option<&'a [T]> {
3881         if self.finished {
3882             None
3883         } else {
3884             self.finished = true;
3885             Some(self.v)
3886         }
3887     }
3888 }
3889
3890 #[stable(feature = "fused", since = "1.26.0")]
3891 impl<T, P> FusedIterator for Split<'_, T, P> where P: FnMut(&T) -> bool {}
3892
3893 /// An iterator over subslices separated by elements that match a predicate
3894 /// function. Unlike `Split`, it contains the matched part as a terminator
3895 /// of the subslice.
3896 ///
3897 /// This struct is created by the [`split_inclusive`] method on [slices].
3898 ///
3899 /// [`split_inclusive`]: ../../std/primitive.slice.html#method.split_inclusive
3900 /// [slices]: ../../std/primitive.slice.html
3901 #[unstable(feature = "split_inclusive", issue = "72360")]
3902 pub struct SplitInclusive<'a, T: 'a, P>
3903 where
3904     P: FnMut(&T) -> bool,
3905 {
3906     v: &'a [T],
3907     pred: P,
3908     finished: bool,
3909 }
3910
3911 #[unstable(feature = "split_inclusive", issue = "72360")]
3912 impl<T: fmt::Debug, P> fmt::Debug for SplitInclusive<'_, T, P>
3913 where
3914     P: FnMut(&T) -> bool,
3915 {
3916     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3917         f.debug_struct("SplitInclusive")
3918             .field("v", &self.v)
3919             .field("finished", &self.finished)
3920             .finish()
3921     }
3922 }
3923
3924 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
3925 #[unstable(feature = "split_inclusive", issue = "72360")]
3926 impl<T, P> Clone for SplitInclusive<'_, T, P>
3927 where
3928     P: Clone + FnMut(&T) -> bool,
3929 {
3930     fn clone(&self) -> Self {
3931         SplitInclusive { v: self.v, pred: self.pred.clone(), finished: self.finished }
3932     }
3933 }
3934
3935 #[unstable(feature = "split_inclusive", issue = "72360")]
3936 impl<'a, T, P> Iterator for SplitInclusive<'a, T, P>
3937 where
3938     P: FnMut(&T) -> bool,
3939 {
3940     type Item = &'a [T];
3941
3942     #[inline]
3943     fn next(&mut self) -> Option<&'a [T]> {
3944         if self.finished {
3945             return None;
3946         }
3947
3948         let idx =
3949             self.v.iter().position(|x| (self.pred)(x)).map(|idx| idx + 1).unwrap_or(self.v.len());
3950         if idx == self.v.len() {
3951             self.finished = true;
3952         }
3953         let ret = Some(&self.v[..idx]);
3954         self.v = &self.v[idx..];
3955         ret
3956     }
3957
3958     #[inline]
3959     fn size_hint(&self) -> (usize, Option<usize>) {
3960         if self.finished { (0, Some(0)) } else { (1, Some(self.v.len() + 1)) }
3961     }
3962 }
3963
3964 #[unstable(feature = "split_inclusive", issue = "72360")]
3965 impl<'a, T, P> DoubleEndedIterator for SplitInclusive<'a, T, P>
3966 where
3967     P: FnMut(&T) -> bool,
3968 {
3969     #[inline]
3970     fn next_back(&mut self) -> Option<&'a [T]> {
3971         if self.finished {
3972             return None;
3973         }
3974
3975         // The last index of self.v is already checked and found to match
3976         // by the last iteration, so we start searching a new match
3977         // one index to the left.
3978         let remainder = if self.v.is_empty() { &[] } else { &self.v[..(self.v.len() - 1)] };
3979         let idx = remainder.iter().rposition(|x| (self.pred)(x)).map(|idx| idx + 1).unwrap_or(0);
3980         if idx == 0 {
3981             self.finished = true;
3982         }
3983         let ret = Some(&self.v[idx..]);
3984         self.v = &self.v[..idx];
3985         ret
3986     }
3987 }
3988
3989 #[unstable(feature = "split_inclusive", issue = "72360")]
3990 impl<T, P> FusedIterator for SplitInclusive<'_, T, P> where P: FnMut(&T) -> bool {}
3991
3992 /// An iterator over the mutable subslices of the vector which are separated
3993 /// by elements that match `pred`.
3994 ///
3995 /// This struct is created by the [`split_mut`] method on [slices].
3996 ///
3997 /// [`split_mut`]: ../../std/primitive.slice.html#method.split_mut
3998 /// [slices]: ../../std/primitive.slice.html
3999 #[stable(feature = "rust1", since = "1.0.0")]
4000 pub struct SplitMut<'a, T: 'a, P>
4001 where
4002     P: FnMut(&T) -> bool,
4003 {
4004     v: &'a mut [T],
4005     pred: P,
4006     finished: bool,
4007 }
4008
4009 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4010 impl<T: fmt::Debug, P> fmt::Debug for SplitMut<'_, T, P>
4011 where
4012     P: FnMut(&T) -> bool,
4013 {
4014     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4015         f.debug_struct("SplitMut").field("v", &self.v).field("finished", &self.finished).finish()
4016     }
4017 }
4018
4019 impl<'a, T, P> SplitIter for SplitMut<'a, T, P>
4020 where
4021     P: FnMut(&T) -> bool,
4022 {
4023     #[inline]
4024     fn finish(&mut self) -> Option<&'a mut [T]> {
4025         if self.finished {
4026             None
4027         } else {
4028             self.finished = true;
4029             Some(mem::replace(&mut self.v, &mut []))
4030         }
4031     }
4032 }
4033
4034 #[stable(feature = "rust1", since = "1.0.0")]
4035 impl<'a, T, P> Iterator for SplitMut<'a, T, P>
4036 where
4037     P: FnMut(&T) -> bool,
4038 {
4039     type Item = &'a mut [T];
4040
4041     #[inline]
4042     fn next(&mut self) -> Option<&'a mut [T]> {
4043         if self.finished {
4044             return None;
4045         }
4046
4047         let idx_opt = {
4048             // work around borrowck limitations
4049             let pred = &mut self.pred;
4050             self.v.iter().position(|x| (*pred)(x))
4051         };
4052         match idx_opt {
4053             None => self.finish(),
4054             Some(idx) => {
4055                 let tmp = mem::replace(&mut self.v, &mut []);
4056                 let (head, tail) = tmp.split_at_mut(idx);
4057                 self.v = &mut tail[1..];
4058                 Some(head)
4059             }
4060         }
4061     }
4062
4063     #[inline]
4064     fn size_hint(&self) -> (usize, Option<usize>) {
4065         if self.finished {
4066             (0, Some(0))
4067         } else {
4068             // if the predicate doesn't match anything, we yield one slice
4069             // if it matches every element, we yield len+1 empty slices.
4070             (1, Some(self.v.len() + 1))
4071         }
4072     }
4073 }
4074
4075 #[stable(feature = "rust1", since = "1.0.0")]
4076 impl<'a, T, P> DoubleEndedIterator for SplitMut<'a, T, P>
4077 where
4078     P: FnMut(&T) -> bool,
4079 {
4080     #[inline]
4081     fn next_back(&mut self) -> Option<&'a mut [T]> {
4082         if self.finished {
4083             return None;
4084         }
4085
4086         let idx_opt = {
4087             // work around borrowck limitations
4088             let pred = &mut self.pred;
4089             self.v.iter().rposition(|x| (*pred)(x))
4090         };
4091         match idx_opt {
4092             None => self.finish(),
4093             Some(idx) => {
4094                 let tmp = mem::replace(&mut self.v, &mut []);
4095                 let (head, tail) = tmp.split_at_mut(idx);
4096                 self.v = head;
4097                 Some(&mut tail[1..])
4098             }
4099         }
4100     }
4101 }
4102
4103 #[stable(feature = "fused", since = "1.26.0")]
4104 impl<T, P> FusedIterator for SplitMut<'_, T, P> where P: FnMut(&T) -> bool {}
4105
4106 /// An iterator over the mutable subslices of the vector which are separated
4107 /// by elements that match `pred`. Unlike `SplitMut`, it contains the matched
4108 /// parts in the ends of the subslices.
4109 ///
4110 /// This struct is created by the [`split_inclusive_mut`] method on [slices].
4111 ///
4112 /// [`split_inclusive_mut`]: ../../std/primitive.slice.html#method.split_inclusive_mut
4113 /// [slices]: ../../std/primitive.slice.html
4114 #[unstable(feature = "split_inclusive", issue = "72360")]
4115 pub struct SplitInclusiveMut<'a, T: 'a, P>
4116 where
4117     P: FnMut(&T) -> bool,
4118 {
4119     v: &'a mut [T],
4120     pred: P,
4121     finished: bool,
4122 }
4123
4124 #[unstable(feature = "split_inclusive", issue = "72360")]
4125 impl<T: fmt::Debug, P> fmt::Debug for SplitInclusiveMut<'_, T, P>
4126 where
4127     P: FnMut(&T) -> bool,
4128 {
4129     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4130         f.debug_struct("SplitInclusiveMut")
4131             .field("v", &self.v)
4132             .field("finished", &self.finished)
4133             .finish()
4134     }
4135 }
4136
4137 #[unstable(feature = "split_inclusive", issue = "72360")]
4138 impl<'a, T, P> Iterator for SplitInclusiveMut<'a, T, P>
4139 where
4140     P: FnMut(&T) -> bool,
4141 {
4142     type Item = &'a mut [T];
4143
4144     #[inline]
4145     fn next(&mut self) -> Option<&'a mut [T]> {
4146         if self.finished {
4147             return None;
4148         }
4149
4150         let idx_opt = {
4151             // work around borrowck limitations
4152             let pred = &mut self.pred;
4153             self.v.iter().position(|x| (*pred)(x))
4154         };
4155         let idx = idx_opt.map(|idx| idx + 1).unwrap_or(self.v.len());
4156         if idx == self.v.len() {
4157             self.finished = true;
4158         }
4159         let tmp = mem::replace(&mut self.v, &mut []);
4160         let (head, tail) = tmp.split_at_mut(idx);
4161         self.v = tail;
4162         Some(head)
4163     }
4164
4165     #[inline]
4166     fn size_hint(&self) -> (usize, Option<usize>) {
4167         if self.finished {
4168             (0, Some(0))
4169         } else {
4170             // if the predicate doesn't match anything, we yield one slice
4171             // if it matches every element, we yield len+1 empty slices.
4172             (1, Some(self.v.len() + 1))
4173         }
4174     }
4175 }
4176
4177 #[unstable(feature = "split_inclusive", issue = "72360")]
4178 impl<'a, T, P> DoubleEndedIterator for SplitInclusiveMut<'a, T, P>
4179 where
4180     P: FnMut(&T) -> bool,
4181 {
4182     #[inline]
4183     fn next_back(&mut self) -> Option<&'a mut [T]> {
4184         if self.finished {
4185             return None;
4186         }
4187
4188         let idx_opt = if self.v.is_empty() {
4189             None
4190         } else {
4191             // work around borrowck limitations
4192             let pred = &mut self.pred;
4193
4194             // The last index of self.v is already checked and found to match
4195             // by the last iteration, so we start searching a new match
4196             // one index to the left.
4197             let remainder = &self.v[..(self.v.len() - 1)];
4198             remainder.iter().rposition(|x| (*pred)(x))
4199         };
4200         let idx = idx_opt.map(|idx| idx + 1).unwrap_or(0);
4201         if idx == 0 {
4202             self.finished = true;
4203         }
4204         let tmp = mem::replace(&mut self.v, &mut []);
4205         let (head, tail) = tmp.split_at_mut(idx);
4206         self.v = head;
4207         Some(tail)
4208     }
4209 }
4210
4211 #[unstable(feature = "split_inclusive", issue = "72360")]
4212 impl<T, P> FusedIterator for SplitInclusiveMut<'_, T, P> where P: FnMut(&T) -> bool {}
4213
4214 /// An iterator over subslices separated by elements that match a predicate
4215 /// function, starting from the end of the slice.
4216 ///
4217 /// This struct is created by the [`rsplit`] method on [slices].
4218 ///
4219 /// [`rsplit`]: ../../std/primitive.slice.html#method.rsplit
4220 /// [slices]: ../../std/primitive.slice.html
4221 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4222 #[derive(Clone)] // Is this correct, or does it incorrectly require `T: Clone`?
4223 pub struct RSplit<'a, T: 'a, P>
4224 where
4225     P: FnMut(&T) -> bool,
4226 {
4227     inner: Split<'a, T, P>,
4228 }
4229
4230 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4231 impl<T: fmt::Debug, P> fmt::Debug for RSplit<'_, T, P>
4232 where
4233     P: FnMut(&T) -> bool,
4234 {
4235     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4236         f.debug_struct("RSplit")
4237             .field("v", &self.inner.v)
4238             .field("finished", &self.inner.finished)
4239             .finish()
4240     }
4241 }
4242
4243 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4244 impl<'a, T, P> Iterator for RSplit<'a, T, P>
4245 where
4246     P: FnMut(&T) -> bool,
4247 {
4248     type Item = &'a [T];
4249
4250     #[inline]
4251     fn next(&mut self) -> Option<&'a [T]> {
4252         self.inner.next_back()
4253     }
4254
4255     #[inline]
4256     fn size_hint(&self) -> (usize, Option<usize>) {
4257         self.inner.size_hint()
4258     }
4259 }
4260
4261 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4262 impl<'a, T, P> DoubleEndedIterator for RSplit<'a, T, P>
4263 where
4264     P: FnMut(&T) -> bool,
4265 {
4266     #[inline]
4267     fn next_back(&mut self) -> Option<&'a [T]> {
4268         self.inner.next()
4269     }
4270 }
4271
4272 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4273 impl<'a, T, P> SplitIter for RSplit<'a, T, P>
4274 where
4275     P: FnMut(&T) -> bool,
4276 {
4277     #[inline]
4278     fn finish(&mut self) -> Option<&'a [T]> {
4279         self.inner.finish()
4280     }
4281 }
4282
4283 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4284 impl<T, P> FusedIterator for RSplit<'_, T, P> where P: FnMut(&T) -> bool {}
4285
4286 /// An iterator over the subslices of the vector which are separated
4287 /// by elements that match `pred`, starting from the end of the slice.
4288 ///
4289 /// This struct is created by the [`rsplit_mut`] method on [slices].
4290 ///
4291 /// [`rsplit_mut`]: ../../std/primitive.slice.html#method.rsplit_mut
4292 /// [slices]: ../../std/primitive.slice.html
4293 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4294 pub struct RSplitMut<'a, T: 'a, P>
4295 where
4296     P: FnMut(&T) -> bool,
4297 {
4298     inner: SplitMut<'a, T, P>,
4299 }
4300
4301 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4302 impl<T: fmt::Debug, P> fmt::Debug for RSplitMut<'_, T, P>
4303 where
4304     P: FnMut(&T) -> bool,
4305 {
4306     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4307         f.debug_struct("RSplitMut")
4308             .field("v", &self.inner.v)
4309             .field("finished", &self.inner.finished)
4310             .finish()
4311     }
4312 }
4313
4314 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4315 impl<'a, T, P> SplitIter for RSplitMut<'a, T, P>
4316 where
4317     P: FnMut(&T) -> bool,
4318 {
4319     #[inline]
4320     fn finish(&mut self) -> Option<&'a mut [T]> {
4321         self.inner.finish()
4322     }
4323 }
4324
4325 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4326 impl<'a, T, P> Iterator for RSplitMut<'a, T, P>
4327 where
4328     P: FnMut(&T) -> bool,
4329 {
4330     type Item = &'a mut [T];
4331
4332     #[inline]
4333     fn next(&mut self) -> Option<&'a mut [T]> {
4334         self.inner.next_back()
4335     }
4336
4337     #[inline]
4338     fn size_hint(&self) -> (usize, Option<usize>) {
4339         self.inner.size_hint()
4340     }
4341 }
4342
4343 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4344 impl<'a, T, P> DoubleEndedIterator for RSplitMut<'a, T, P>
4345 where
4346     P: FnMut(&T) -> bool,
4347 {
4348     #[inline]
4349     fn next_back(&mut self) -> Option<&'a mut [T]> {
4350         self.inner.next()
4351     }
4352 }
4353
4354 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4355 impl<T, P> FusedIterator for RSplitMut<'_, T, P> where P: FnMut(&T) -> bool {}
4356
4357 /// An private iterator over subslices separated by elements that
4358 /// match a predicate function, splitting at most a fixed number of
4359 /// times.
4360 #[derive(Debug)]
4361 struct GenericSplitN<I> {
4362     iter: I,
4363     count: usize,
4364 }
4365
4366 impl<T, I: SplitIter<Item = T>> Iterator for GenericSplitN<I> {
4367     type Item = T;
4368
4369     #[inline]
4370     fn next(&mut self) -> Option<T> {
4371         match self.count {
4372             0 => None,
4373             1 => {
4374                 self.count -= 1;
4375                 self.iter.finish()
4376             }
4377             _ => {
4378                 self.count -= 1;
4379                 self.iter.next()
4380             }
4381         }
4382     }
4383
4384     #[inline]
4385     fn size_hint(&self) -> (usize, Option<usize>) {
4386         let (lower, upper_opt) = self.iter.size_hint();
4387         (lower, upper_opt.map(|upper| cmp::min(self.count, upper)))
4388     }
4389 }
4390
4391 /// An iterator over subslices separated by elements that match a predicate
4392 /// function, limited to a given number of splits.
4393 ///
4394 /// This struct is created by the [`splitn`] method on [slices].
4395 ///
4396 /// [`splitn`]: ../../std/primitive.slice.html#method.splitn
4397 /// [slices]: ../../std/primitive.slice.html
4398 #[stable(feature = "rust1", since = "1.0.0")]
4399 pub struct SplitN<'a, T: 'a, P>
4400 where
4401     P: FnMut(&T) -> bool,
4402 {
4403     inner: GenericSplitN<Split<'a, T, P>>,
4404 }
4405
4406 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4407 impl<T: fmt::Debug, P> fmt::Debug for SplitN<'_, T, P>
4408 where
4409     P: FnMut(&T) -> bool,
4410 {
4411     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4412         f.debug_struct("SplitN").field("inner", &self.inner).finish()
4413     }
4414 }
4415
4416 /// An iterator over subslices separated by elements that match a
4417 /// predicate function, limited to a given number of splits, starting
4418 /// from the end of the slice.
4419 ///
4420 /// This struct is created by the [`rsplitn`] method on [slices].
4421 ///
4422 /// [`rsplitn`]: ../../std/primitive.slice.html#method.rsplitn
4423 /// [slices]: ../../std/primitive.slice.html
4424 #[stable(feature = "rust1", since = "1.0.0")]
4425 pub struct RSplitN<'a, T: 'a, P>
4426 where
4427     P: FnMut(&T) -> bool,
4428 {
4429     inner: GenericSplitN<RSplit<'a, T, P>>,
4430 }
4431
4432 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4433 impl<T: fmt::Debug, P> fmt::Debug for RSplitN<'_, T, P>
4434 where
4435     P: FnMut(&T) -> bool,
4436 {
4437     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4438         f.debug_struct("RSplitN").field("inner", &self.inner).finish()
4439     }
4440 }
4441
4442 /// An iterator over subslices separated by elements that match a predicate
4443 /// function, limited to a given number of splits.
4444 ///
4445 /// This struct is created by the [`splitn_mut`] method on [slices].
4446 ///
4447 /// [`splitn_mut`]: ../../std/primitive.slice.html#method.splitn_mut
4448 /// [slices]: ../../std/primitive.slice.html
4449 #[stable(feature = "rust1", since = "1.0.0")]
4450 pub struct SplitNMut<'a, T: 'a, P>
4451 where
4452     P: FnMut(&T) -> bool,
4453 {
4454     inner: GenericSplitN<SplitMut<'a, T, P>>,
4455 }
4456
4457 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4458 impl<T: fmt::Debug, P> fmt::Debug for SplitNMut<'_, T, P>
4459 where
4460     P: FnMut(&T) -> bool,
4461 {
4462     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4463         f.debug_struct("SplitNMut").field("inner", &self.inner).finish()
4464     }
4465 }
4466
4467 /// An iterator over subslices separated by elements that match a
4468 /// predicate function, limited to a given number of splits, starting
4469 /// from the end of the slice.
4470 ///
4471 /// This struct is created by the [`rsplitn_mut`] method on [slices].
4472 ///
4473 /// [`rsplitn_mut`]: ../../std/primitive.slice.html#method.rsplitn_mut
4474 /// [slices]: ../../std/primitive.slice.html
4475 #[stable(feature = "rust1", since = "1.0.0")]
4476 pub struct RSplitNMut<'a, T: 'a, P>
4477 where
4478     P: FnMut(&T) -> bool,
4479 {
4480     inner: GenericSplitN<RSplitMut<'a, T, P>>,
4481 }
4482
4483 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4484 impl<T: fmt::Debug, P> fmt::Debug for RSplitNMut<'_, T, P>
4485 where
4486     P: FnMut(&T) -> bool,
4487 {
4488     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4489         f.debug_struct("RSplitNMut").field("inner", &self.inner).finish()
4490     }
4491 }
4492
4493 macro_rules! forward_iterator {
4494     ($name:ident: $elem:ident, $iter_of:ty) => {
4495         #[stable(feature = "rust1", since = "1.0.0")]
4496         impl<'a, $elem, P> Iterator for $name<'a, $elem, P>
4497         where
4498             P: FnMut(&T) -> bool,
4499         {
4500             type Item = $iter_of;
4501
4502             #[inline]
4503             fn next(&mut self) -> Option<$iter_of> {
4504                 self.inner.next()
4505             }
4506
4507             #[inline]
4508             fn size_hint(&self) -> (usize, Option<usize>) {
4509                 self.inner.size_hint()
4510             }
4511         }
4512
4513         #[stable(feature = "fused", since = "1.26.0")]
4514         impl<'a, $elem, P> FusedIterator for $name<'a, $elem, P> where P: FnMut(&T) -> bool {}
4515     };
4516 }
4517
4518 forward_iterator! { SplitN: T, &'a [T] }
4519 forward_iterator! { RSplitN: T, &'a [T] }
4520 forward_iterator! { SplitNMut: T, &'a mut [T] }
4521 forward_iterator! { RSplitNMut: T, &'a mut [T] }
4522
4523 /// An iterator over overlapping subslices of length `size`.
4524 ///
4525 /// This struct is created by the [`windows`] method on [slices].
4526 ///
4527 /// [`windows`]: ../../std/primitive.slice.html#method.windows
4528 /// [slices]: ../../std/primitive.slice.html
4529 #[derive(Debug)]
4530 #[stable(feature = "rust1", since = "1.0.0")]
4531 pub struct Windows<'a, T: 'a> {
4532     v: &'a [T],
4533     size: usize,
4534 }
4535
4536 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
4537 #[stable(feature = "rust1", since = "1.0.0")]
4538 impl<T> Clone for Windows<'_, T> {
4539     fn clone(&self) -> Self {
4540         Windows { v: self.v, size: self.size }
4541     }
4542 }
4543
4544 #[stable(feature = "rust1", since = "1.0.0")]
4545 impl<'a, T> Iterator for Windows<'a, T> {
4546     type Item = &'a [T];
4547
4548     #[inline]
4549     fn next(&mut self) -> Option<&'a [T]> {
4550         if self.size > self.v.len() {
4551             None
4552         } else {
4553             let ret = Some(&self.v[..self.size]);
4554             self.v = &self.v[1..];
4555             ret
4556         }
4557     }
4558
4559     #[inline]
4560     fn size_hint(&self) -> (usize, Option<usize>) {
4561         if self.size > self.v.len() {
4562             (0, Some(0))
4563         } else {
4564             let size = self.v.len() - self.size + 1;
4565             (size, Some(size))
4566         }
4567     }
4568
4569     #[inline]
4570     fn count(self) -> usize {
4571         self.len()
4572     }
4573
4574     #[inline]
4575     fn nth(&mut self, n: usize) -> Option<Self::Item> {
4576         let (end, overflow) = self.size.overflowing_add(n);
4577         if end > self.v.len() || overflow {
4578             self.v = &[];
4579             None
4580         } else {
4581             let nth = &self.v[n..end];
4582             self.v = &self.v[n + 1..];
4583             Some(nth)
4584         }
4585     }
4586
4587     #[inline]
4588     fn last(self) -> Option<Self::Item> {
4589         if self.size > self.v.len() {
4590             None
4591         } else {
4592             let start = self.v.len() - self.size;
4593             Some(&self.v[start..])
4594         }
4595     }
4596 }
4597
4598 #[stable(feature = "rust1", since = "1.0.0")]
4599 impl<'a, T> DoubleEndedIterator for Windows<'a, T> {
4600     #[inline]
4601     fn next_back(&mut self) -> Option<&'a [T]> {
4602         if self.size > self.v.len() {
4603             None
4604         } else {
4605             let ret = Some(&self.v[self.v.len() - self.size..]);
4606             self.v = &self.v[..self.v.len() - 1];
4607             ret
4608         }
4609     }
4610
4611     #[inline]
4612     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
4613         let (end, overflow) = self.v.len().overflowing_sub(n);
4614         if end < self.size || overflow {
4615             self.v = &[];
4616             None
4617         } else {
4618             let ret = &self.v[end - self.size..end];
4619             self.v = &self.v[..end - 1];
4620             Some(ret)
4621         }
4622     }
4623 }
4624
4625 #[stable(feature = "rust1", since = "1.0.0")]
4626 impl<T> ExactSizeIterator for Windows<'_, T> {}
4627
4628 #[unstable(feature = "trusted_len", issue = "37572")]
4629 unsafe impl<T> TrustedLen for Windows<'_, T> {}
4630
4631 #[stable(feature = "fused", since = "1.26.0")]
4632 impl<T> FusedIterator for Windows<'_, T> {}
4633
4634 #[doc(hidden)]
4635 unsafe impl<'a, T> TrustedRandomAccess for Windows<'a, T> {
4636     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
4637         from_raw_parts(self.v.as_ptr().add(i), self.size)
4638     }
4639     fn may_have_side_effect() -> bool {
4640         false
4641     }
4642 }
4643
4644 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
4645 /// time), starting at the beginning of the slice.
4646 ///
4647 /// When the slice len is not evenly divided by the chunk size, the last slice
4648 /// of the iteration will be the remainder.
4649 ///
4650 /// This struct is created by the [`chunks`] method on [slices].
4651 ///
4652 /// [`chunks`]: ../../std/primitive.slice.html#method.chunks
4653 /// [slices]: ../../std/primitive.slice.html
4654 #[derive(Debug)]
4655 #[stable(feature = "rust1", since = "1.0.0")]
4656 pub struct Chunks<'a, T: 'a> {
4657     v: &'a [T],
4658     chunk_size: usize,
4659 }
4660
4661 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
4662 #[stable(feature = "rust1", since = "1.0.0")]
4663 impl<T> Clone for Chunks<'_, T> {
4664     fn clone(&self) -> Self {
4665         Chunks { v: self.v, chunk_size: self.chunk_size }
4666     }
4667 }
4668
4669 #[stable(feature = "rust1", since = "1.0.0")]
4670 impl<'a, T> Iterator for Chunks<'a, T> {
4671     type Item = &'a [T];
4672
4673     #[inline]
4674     fn next(&mut self) -> Option<&'a [T]> {
4675         if self.v.is_empty() {
4676             None
4677         } else {
4678             let chunksz = cmp::min(self.v.len(), self.chunk_size);
4679             let (fst, snd) = self.v.split_at(chunksz);
4680             self.v = snd;
4681             Some(fst)
4682         }
4683     }
4684
4685     #[inline]
4686     fn size_hint(&self) -> (usize, Option<usize>) {
4687         if self.v.is_empty() {
4688             (0, Some(0))
4689         } else {
4690             let n = self.v.len() / self.chunk_size;
4691             let rem = self.v.len() % self.chunk_size;
4692             let n = if rem > 0 { n + 1 } else { n };
4693             (n, Some(n))
4694         }
4695     }
4696
4697     #[inline]
4698     fn count(self) -> usize {
4699         self.len()
4700     }
4701
4702     #[inline]
4703     fn nth(&mut self, n: usize) -> Option<Self::Item> {
4704         let (start, overflow) = n.overflowing_mul(self.chunk_size);
4705         if start >= self.v.len() || overflow {
4706             self.v = &[];
4707             None
4708         } else {
4709             let end = match start.checked_add(self.chunk_size) {
4710                 Some(sum) => cmp::min(self.v.len(), sum),
4711                 None => self.v.len(),
4712             };
4713             let nth = &self.v[start..end];
4714             self.v = &self.v[end..];
4715             Some(nth)
4716         }
4717     }
4718
4719     #[inline]
4720     fn last(self) -> Option<Self::Item> {
4721         if self.v.is_empty() {
4722             None
4723         } else {
4724             let start = (self.v.len() - 1) / self.chunk_size * self.chunk_size;
4725             Some(&self.v[start..])
4726         }
4727     }
4728 }
4729
4730 #[stable(feature = "rust1", since = "1.0.0")]
4731 impl<'a, T> DoubleEndedIterator for Chunks<'a, T> {
4732     #[inline]
4733     fn next_back(&mut self) -> Option<&'a [T]> {
4734         if self.v.is_empty() {
4735             None
4736         } else {
4737             let remainder = self.v.len() % self.chunk_size;
4738             let chunksz = if remainder != 0 { remainder } else { self.chunk_size };
4739             let (fst, snd) = self.v.split_at(self.v.len() - chunksz);
4740             self.v = fst;
4741             Some(snd)
4742         }
4743     }
4744
4745     #[inline]
4746     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
4747         let len = self.len();
4748         if n >= len {
4749             self.v = &[];
4750             None
4751         } else {
4752             let start = (len - 1 - n) * self.chunk_size;
4753             let end = match start.checked_add(self.chunk_size) {
4754                 Some(res) => cmp::min(res, self.v.len()),
4755                 None => self.v.len(),
4756             };
4757             let nth_back = &self.v[start..end];
4758             self.v = &self.v[..start];
4759             Some(nth_back)
4760         }
4761     }
4762 }
4763
4764 #[stable(feature = "rust1", since = "1.0.0")]
4765 impl<T> ExactSizeIterator for Chunks<'_, T> {}
4766
4767 #[unstable(feature = "trusted_len", issue = "37572")]
4768 unsafe impl<T> TrustedLen for Chunks<'_, T> {}
4769
4770 #[stable(feature = "fused", since = "1.26.0")]
4771 impl<T> FusedIterator for Chunks<'_, T> {}
4772
4773 #[doc(hidden)]
4774 unsafe impl<'a, T> TrustedRandomAccess for Chunks<'a, T> {
4775     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
4776         let start = i * self.chunk_size;
4777         let end = match start.checked_add(self.chunk_size) {
4778             None => self.v.len(),
4779             Some(end) => cmp::min(end, self.v.len()),
4780         };
4781         from_raw_parts(self.v.as_ptr().add(start), end - start)
4782     }
4783     fn may_have_side_effect() -> bool {
4784         false
4785     }
4786 }
4787
4788 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
4789 /// elements at a time), starting at the beginning of the slice.
4790 ///
4791 /// When the slice len is not evenly divided by the chunk size, the last slice
4792 /// of the iteration will be the remainder.
4793 ///
4794 /// This struct is created by the [`chunks_mut`] method on [slices].
4795 ///
4796 /// [`chunks_mut`]: ../../std/primitive.slice.html#method.chunks_mut
4797 /// [slices]: ../../std/primitive.slice.html
4798 #[derive(Debug)]
4799 #[stable(feature = "rust1", since = "1.0.0")]
4800 pub struct ChunksMut<'a, T: 'a> {
4801     v: &'a mut [T],
4802     chunk_size: usize,
4803 }
4804
4805 #[stable(feature = "rust1", since = "1.0.0")]
4806 impl<'a, T> Iterator for ChunksMut<'a, T> {
4807     type Item = &'a mut [T];
4808
4809     #[inline]
4810     fn next(&mut self) -> Option<&'a mut [T]> {
4811         if self.v.is_empty() {
4812             None
4813         } else {
4814             let sz = cmp::min(self.v.len(), self.chunk_size);
4815             let tmp = mem::replace(&mut self.v, &mut []);
4816             let (head, tail) = tmp.split_at_mut(sz);
4817             self.v = tail;
4818             Some(head)
4819         }
4820     }
4821
4822     #[inline]
4823     fn size_hint(&self) -> (usize, Option<usize>) {
4824         if self.v.is_empty() {
4825             (0, Some(0))
4826         } else {
4827             let n = self.v.len() / self.chunk_size;
4828             let rem = self.v.len() % self.chunk_size;
4829             let n = if rem > 0 { n + 1 } else { n };
4830             (n, Some(n))
4831         }
4832     }
4833
4834     #[inline]
4835     fn count(self) -> usize {
4836         self.len()
4837     }
4838
4839     #[inline]
4840     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
4841         let (start, overflow) = n.overflowing_mul(self.chunk_size);
4842         if start >= self.v.len() || overflow {
4843             self.v = &mut [];
4844             None
4845         } else {
4846             let end = match start.checked_add(self.chunk_size) {
4847                 Some(sum) => cmp::min(self.v.len(), sum),
4848                 None => self.v.len(),
4849             };
4850             let tmp = mem::replace(&mut self.v, &mut []);
4851             let (head, tail) = tmp.split_at_mut(end);
4852             let (_, nth) = head.split_at_mut(start);
4853             self.v = tail;
4854             Some(nth)
4855         }
4856     }
4857
4858     #[inline]
4859     fn last(self) -> Option<Self::Item> {
4860         if self.v.is_empty() {
4861             None
4862         } else {
4863             let start = (self.v.len() - 1) / self.chunk_size * self.chunk_size;
4864             Some(&mut self.v[start..])
4865         }
4866     }
4867 }
4868
4869 #[stable(feature = "rust1", since = "1.0.0")]
4870 impl<'a, T> DoubleEndedIterator for ChunksMut<'a, T> {
4871     #[inline]
4872     fn next_back(&mut self) -> Option<&'a mut [T]> {
4873         if self.v.is_empty() {
4874             None
4875         } else {
4876             let remainder = self.v.len() % self.chunk_size;
4877             let sz = if remainder != 0 { remainder } else { self.chunk_size };
4878             let tmp = mem::replace(&mut self.v, &mut []);
4879             let tmp_len = tmp.len();
4880             let (head, tail) = tmp.split_at_mut(tmp_len - sz);
4881             self.v = head;
4882             Some(tail)
4883         }
4884     }
4885
4886     #[inline]
4887     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
4888         let len = self.len();
4889         if n >= len {
4890             self.v = &mut [];
4891             None
4892         } else {
4893             let start = (len - 1 - n) * self.chunk_size;
4894             let end = match start.checked_add(self.chunk_size) {
4895                 Some(res) => cmp::min(res, self.v.len()),
4896                 None => self.v.len(),
4897             };
4898             let (temp, _tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
4899             let (head, nth_back) = temp.split_at_mut(start);
4900             self.v = head;
4901             Some(nth_back)
4902         }
4903     }
4904 }
4905
4906 #[stable(feature = "rust1", since = "1.0.0")]
4907 impl<T> ExactSizeIterator for ChunksMut<'_, T> {}
4908
4909 #[unstable(feature = "trusted_len", issue = "37572")]
4910 unsafe impl<T> TrustedLen for ChunksMut<'_, T> {}
4911
4912 #[stable(feature = "fused", since = "1.26.0")]
4913 impl<T> FusedIterator for ChunksMut<'_, T> {}
4914
4915 #[doc(hidden)]
4916 unsafe impl<'a, T> TrustedRandomAccess for ChunksMut<'a, T> {
4917     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
4918         let start = i * self.chunk_size;
4919         let end = match start.checked_add(self.chunk_size) {
4920             None => self.v.len(),
4921             Some(end) => cmp::min(end, self.v.len()),
4922         };
4923         from_raw_parts_mut(self.v.as_mut_ptr().add(start), end - start)
4924     }
4925     fn may_have_side_effect() -> bool {
4926         false
4927     }
4928 }
4929
4930 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
4931 /// time), starting at the beginning of the slice.
4932 ///
4933 /// When the slice len is not evenly divided by the chunk size, the last
4934 /// up to `chunk_size-1` elements will be omitted but can be retrieved from
4935 /// the [`remainder`] function from the iterator.
4936 ///
4937 /// This struct is created by the [`chunks_exact`] method on [slices].
4938 ///
4939 /// [`chunks_exact`]: ../../std/primitive.slice.html#method.chunks_exact
4940 /// [`remainder`]: ../../std/slice/struct.ChunksExact.html#method.remainder
4941 /// [slices]: ../../std/primitive.slice.html
4942 #[derive(Debug)]
4943 #[stable(feature = "chunks_exact", since = "1.31.0")]
4944 pub struct ChunksExact<'a, T: 'a> {
4945     v: &'a [T],
4946     rem: &'a [T],
4947     chunk_size: usize,
4948 }
4949
4950 impl<'a, T> ChunksExact<'a, T> {
4951     /// Returns the remainder of the original slice that is not going to be
4952     /// returned by the iterator. The returned slice has at most `chunk_size-1`
4953     /// elements.
4954     #[stable(feature = "chunks_exact", since = "1.31.0")]
4955     pub fn remainder(&self) -> &'a [T] {
4956         self.rem
4957     }
4958 }
4959
4960 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
4961 #[stable(feature = "chunks_exact", since = "1.31.0")]
4962 impl<T> Clone for ChunksExact<'_, T> {
4963     fn clone(&self) -> Self {
4964         ChunksExact { v: self.v, rem: self.rem, chunk_size: self.chunk_size }
4965     }
4966 }
4967
4968 #[stable(feature = "chunks_exact", since = "1.31.0")]
4969 impl<'a, T> Iterator for ChunksExact<'a, T> {
4970     type Item = &'a [T];
4971
4972     #[inline]
4973     fn next(&mut self) -> Option<&'a [T]> {
4974         if self.v.len() < self.chunk_size {
4975             None
4976         } else {
4977             let (fst, snd) = self.v.split_at(self.chunk_size);
4978             self.v = snd;
4979             Some(fst)
4980         }
4981     }
4982
4983     #[inline]
4984     fn size_hint(&self) -> (usize, Option<usize>) {
4985         let n = self.v.len() / self.chunk_size;
4986         (n, Some(n))
4987     }
4988
4989     #[inline]
4990     fn count(self) -> usize {
4991         self.len()
4992     }
4993
4994     #[inline]
4995     fn nth(&mut self, n: usize) -> Option<Self::Item> {
4996         let (start, overflow) = n.overflowing_mul(self.chunk_size);
4997         if start >= self.v.len() || overflow {
4998             self.v = &[];
4999             None
5000         } else {
5001             let (_, snd) = self.v.split_at(start);
5002             self.v = snd;
5003             self.next()
5004         }
5005     }
5006
5007     #[inline]
5008     fn last(mut self) -> Option<Self::Item> {
5009         self.next_back()
5010     }
5011 }
5012
5013 #[stable(feature = "chunks_exact", since = "1.31.0")]
5014 impl<'a, T> DoubleEndedIterator for ChunksExact<'a, T> {
5015     #[inline]
5016     fn next_back(&mut self) -> Option<&'a [T]> {
5017         if self.v.len() < self.chunk_size {
5018             None
5019         } else {
5020             let (fst, snd) = self.v.split_at(self.v.len() - self.chunk_size);
5021             self.v = fst;
5022             Some(snd)
5023         }
5024     }
5025
5026     #[inline]
5027     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5028         let len = self.len();
5029         if n >= len {
5030             self.v = &[];
5031             None
5032         } else {
5033             let start = (len - 1 - n) * self.chunk_size;
5034             let end = start + self.chunk_size;
5035             let nth_back = &self.v[start..end];
5036             self.v = &self.v[..start];
5037             Some(nth_back)
5038         }
5039     }
5040 }
5041
5042 #[stable(feature = "chunks_exact", since = "1.31.0")]
5043 impl<T> ExactSizeIterator for ChunksExact<'_, T> {
5044     fn is_empty(&self) -> bool {
5045         self.v.is_empty()
5046     }
5047 }
5048
5049 #[unstable(feature = "trusted_len", issue = "37572")]
5050 unsafe impl<T> TrustedLen for ChunksExact<'_, T> {}
5051
5052 #[stable(feature = "chunks_exact", since = "1.31.0")]
5053 impl<T> FusedIterator for ChunksExact<'_, T> {}
5054
5055 #[doc(hidden)]
5056 #[stable(feature = "chunks_exact", since = "1.31.0")]
5057 unsafe impl<'a, T> TrustedRandomAccess for ChunksExact<'a, T> {
5058     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
5059         let start = i * self.chunk_size;
5060         from_raw_parts(self.v.as_ptr().add(start), self.chunk_size)
5061     }
5062     fn may_have_side_effect() -> bool {
5063         false
5064     }
5065 }
5066
5067 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
5068 /// elements at a time), starting at the beginning of the slice.
5069 ///
5070 /// When the slice len is not evenly divided by the chunk size, the last up to
5071 /// `chunk_size-1` elements will be omitted but can be retrieved from the
5072 /// [`into_remainder`] function from the iterator.
5073 ///
5074 /// This struct is created by the [`chunks_exact_mut`] method on [slices].
5075 ///
5076 /// [`chunks_exact_mut`]: ../../std/primitive.slice.html#method.chunks_exact_mut
5077 /// [`into_remainder`]: ../../std/slice/struct.ChunksExactMut.html#method.into_remainder
5078 /// [slices]: ../../std/primitive.slice.html
5079 #[derive(Debug)]
5080 #[stable(feature = "chunks_exact", since = "1.31.0")]
5081 pub struct ChunksExactMut<'a, T: 'a> {
5082     v: &'a mut [T],
5083     rem: &'a mut [T],
5084     chunk_size: usize,
5085 }
5086
5087 impl<'a, T> ChunksExactMut<'a, T> {
5088     /// Returns the remainder of the original slice that is not going to be
5089     /// returned by the iterator. The returned slice has at most `chunk_size-1`
5090     /// elements.
5091     #[stable(feature = "chunks_exact", since = "1.31.0")]
5092     pub fn into_remainder(self) -> &'a mut [T] {
5093         self.rem
5094     }
5095 }
5096
5097 #[stable(feature = "chunks_exact", since = "1.31.0")]
5098 impl<'a, T> Iterator for ChunksExactMut<'a, T> {
5099     type Item = &'a mut [T];
5100
5101     #[inline]
5102     fn next(&mut self) -> Option<&'a mut [T]> {
5103         if self.v.len() < self.chunk_size {
5104             None
5105         } else {
5106             let tmp = mem::replace(&mut self.v, &mut []);
5107             let (head, tail) = tmp.split_at_mut(self.chunk_size);
5108             self.v = tail;
5109             Some(head)
5110         }
5111     }
5112
5113     #[inline]
5114     fn size_hint(&self) -> (usize, Option<usize>) {
5115         let n = self.v.len() / self.chunk_size;
5116         (n, Some(n))
5117     }
5118
5119     #[inline]
5120     fn count(self) -> usize {
5121         self.len()
5122     }
5123
5124     #[inline]
5125     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
5126         let (start, overflow) = n.overflowing_mul(self.chunk_size);
5127         if start >= self.v.len() || overflow {
5128             self.v = &mut [];
5129             None
5130         } else {
5131             let tmp = mem::replace(&mut self.v, &mut []);
5132             let (_, snd) = tmp.split_at_mut(start);
5133             self.v = snd;
5134             self.next()
5135         }
5136     }
5137
5138     #[inline]
5139     fn last(mut self) -> Option<Self::Item> {
5140         self.next_back()
5141     }
5142 }
5143
5144 #[stable(feature = "chunks_exact", since = "1.31.0")]
5145 impl<'a, T> DoubleEndedIterator for ChunksExactMut<'a, T> {
5146     #[inline]
5147     fn next_back(&mut self) -> Option<&'a mut [T]> {
5148         if self.v.len() < self.chunk_size {
5149             None
5150         } else {
5151             let tmp = mem::replace(&mut self.v, &mut []);
5152             let tmp_len = tmp.len();
5153             let (head, tail) = tmp.split_at_mut(tmp_len - self.chunk_size);
5154             self.v = head;
5155             Some(tail)
5156         }
5157     }
5158
5159     #[inline]
5160     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5161         let len = self.len();
5162         if n >= len {
5163             self.v = &mut [];
5164             None
5165         } else {
5166             let start = (len - 1 - n) * self.chunk_size;
5167             let end = start + self.chunk_size;
5168             let (temp, _tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
5169             let (head, nth_back) = temp.split_at_mut(start);
5170             self.v = head;
5171             Some(nth_back)
5172         }
5173     }
5174 }
5175
5176 #[stable(feature = "chunks_exact", since = "1.31.0")]
5177 impl<T> ExactSizeIterator for ChunksExactMut<'_, T> {
5178     fn is_empty(&self) -> bool {
5179         self.v.is_empty()
5180     }
5181 }
5182
5183 #[unstable(feature = "trusted_len", issue = "37572")]
5184 unsafe impl<T> TrustedLen for ChunksExactMut<'_, T> {}
5185
5186 #[stable(feature = "chunks_exact", since = "1.31.0")]
5187 impl<T> FusedIterator for ChunksExactMut<'_, T> {}
5188
5189 #[doc(hidden)]
5190 #[stable(feature = "chunks_exact", since = "1.31.0")]
5191 unsafe impl<'a, T> TrustedRandomAccess for ChunksExactMut<'a, T> {
5192     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
5193         let start = i * self.chunk_size;
5194         from_raw_parts_mut(self.v.as_mut_ptr().add(start), self.chunk_size)
5195     }
5196     fn may_have_side_effect() -> bool {
5197         false
5198     }
5199 }
5200
5201 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
5202 /// time), starting at the end of the slice.
5203 ///
5204 /// When the slice len is not evenly divided by the chunk size, the last slice
5205 /// of the iteration will be the remainder.
5206 ///
5207 /// This struct is created by the [`rchunks`] method on [slices].
5208 ///
5209 /// [`rchunks`]: ../../std/primitive.slice.html#method.rchunks
5210 /// [slices]: ../../std/primitive.slice.html
5211 #[derive(Debug)]
5212 #[stable(feature = "rchunks", since = "1.31.0")]
5213 pub struct RChunks<'a, T: 'a> {
5214     v: &'a [T],
5215     chunk_size: usize,
5216 }
5217
5218 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
5219 #[stable(feature = "rchunks", since = "1.31.0")]
5220 impl<T> Clone for RChunks<'_, T> {
5221     fn clone(&self) -> Self {
5222         RChunks { v: self.v, chunk_size: self.chunk_size }
5223     }
5224 }
5225
5226 #[stable(feature = "rchunks", since = "1.31.0")]
5227 impl<'a, T> Iterator for RChunks<'a, T> {
5228     type Item = &'a [T];
5229
5230     #[inline]
5231     fn next(&mut self) -> Option<&'a [T]> {
5232         if self.v.is_empty() {
5233             None
5234         } else {
5235             let chunksz = cmp::min(self.v.len(), self.chunk_size);
5236             let (fst, snd) = self.v.split_at(self.v.len() - chunksz);
5237             self.v = fst;
5238             Some(snd)
5239         }
5240     }
5241
5242     #[inline]
5243     fn size_hint(&self) -> (usize, Option<usize>) {
5244         if self.v.is_empty() {
5245             (0, Some(0))
5246         } else {
5247             let n = self.v.len() / self.chunk_size;
5248             let rem = self.v.len() % self.chunk_size;
5249             let n = if rem > 0 { n + 1 } else { n };
5250             (n, Some(n))
5251         }
5252     }
5253
5254     #[inline]
5255     fn count(self) -> usize {
5256         self.len()
5257     }
5258
5259     #[inline]
5260     fn nth(&mut self, n: usize) -> Option<Self::Item> {
5261         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5262         if end >= self.v.len() || overflow {
5263             self.v = &[];
5264             None
5265         } else {
5266             // Can't underflow because of the check above
5267             let end = self.v.len() - end;
5268             let start = match end.checked_sub(self.chunk_size) {
5269                 Some(sum) => sum,
5270                 None => 0,
5271             };
5272             let nth = &self.v[start..end];
5273             self.v = &self.v[0..start];
5274             Some(nth)
5275         }
5276     }
5277
5278     #[inline]
5279     fn last(self) -> Option<Self::Item> {
5280         if self.v.is_empty() {
5281             None
5282         } else {
5283             let rem = self.v.len() % self.chunk_size;
5284             let end = if rem == 0 { self.chunk_size } else { rem };
5285             Some(&self.v[0..end])
5286         }
5287     }
5288 }
5289
5290 #[stable(feature = "rchunks", since = "1.31.0")]
5291 impl<'a, T> DoubleEndedIterator for RChunks<'a, T> {
5292     #[inline]
5293     fn next_back(&mut self) -> Option<&'a [T]> {
5294         if self.v.is_empty() {
5295             None
5296         } else {
5297             let remainder = self.v.len() % self.chunk_size;
5298             let chunksz = if remainder != 0 { remainder } else { self.chunk_size };
5299             let (fst, snd) = self.v.split_at(chunksz);
5300             self.v = snd;
5301             Some(fst)
5302         }
5303     }
5304
5305     #[inline]
5306     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5307         let len = self.len();
5308         if n >= len {
5309             self.v = &[];
5310             None
5311         } else {
5312             // can't underflow because `n < len`
5313             let offset_from_end = (len - 1 - n) * self.chunk_size;
5314             let end = self.v.len() - offset_from_end;
5315             let start = end.saturating_sub(self.chunk_size);
5316             let nth_back = &self.v[start..end];
5317             self.v = &self.v[end..];
5318             Some(nth_back)
5319         }
5320     }
5321 }
5322
5323 #[stable(feature = "rchunks", since = "1.31.0")]
5324 impl<T> ExactSizeIterator for RChunks<'_, T> {}
5325
5326 #[unstable(feature = "trusted_len", issue = "37572")]
5327 unsafe impl<T> TrustedLen for RChunks<'_, T> {}
5328
5329 #[stable(feature = "rchunks", since = "1.31.0")]
5330 impl<T> FusedIterator for RChunks<'_, T> {}
5331
5332 #[doc(hidden)]
5333 #[stable(feature = "rchunks", since = "1.31.0")]
5334 unsafe impl<'a, T> TrustedRandomAccess for RChunks<'a, T> {
5335     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
5336         let end = self.v.len() - i * self.chunk_size;
5337         let start = match end.checked_sub(self.chunk_size) {
5338             None => 0,
5339             Some(start) => start,
5340         };
5341         from_raw_parts(self.v.as_ptr().add(start), end - start)
5342     }
5343     fn may_have_side_effect() -> bool {
5344         false
5345     }
5346 }
5347
5348 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
5349 /// elements at a time), starting at the end of the slice.
5350 ///
5351 /// When the slice len is not evenly divided by the chunk size, the last slice
5352 /// of the iteration will be the remainder.
5353 ///
5354 /// This struct is created by the [`rchunks_mut`] method on [slices].
5355 ///
5356 /// [`rchunks_mut`]: ../../std/primitive.slice.html#method.rchunks_mut
5357 /// [slices]: ../../std/primitive.slice.html
5358 #[derive(Debug)]
5359 #[stable(feature = "rchunks", since = "1.31.0")]
5360 pub struct RChunksMut<'a, T: 'a> {
5361     v: &'a mut [T],
5362     chunk_size: usize,
5363 }
5364
5365 #[stable(feature = "rchunks", since = "1.31.0")]
5366 impl<'a, T> Iterator for RChunksMut<'a, T> {
5367     type Item = &'a mut [T];
5368
5369     #[inline]
5370     fn next(&mut self) -> Option<&'a mut [T]> {
5371         if self.v.is_empty() {
5372             None
5373         } else {
5374             let sz = cmp::min(self.v.len(), self.chunk_size);
5375             let tmp = mem::replace(&mut self.v, &mut []);
5376             let tmp_len = tmp.len();
5377             let (head, tail) = tmp.split_at_mut(tmp_len - sz);
5378             self.v = head;
5379             Some(tail)
5380         }
5381     }
5382
5383     #[inline]
5384     fn size_hint(&self) -> (usize, Option<usize>) {
5385         if self.v.is_empty() {
5386             (0, Some(0))
5387         } else {
5388             let n = self.v.len() / self.chunk_size;
5389             let rem = self.v.len() % self.chunk_size;
5390             let n = if rem > 0 { n + 1 } else { n };
5391             (n, Some(n))
5392         }
5393     }
5394
5395     #[inline]
5396     fn count(self) -> usize {
5397         self.len()
5398     }
5399
5400     #[inline]
5401     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
5402         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5403         if end >= self.v.len() || overflow {
5404             self.v = &mut [];
5405             None
5406         } else {
5407             // Can't underflow because of the check above
5408             let end = self.v.len() - end;
5409             let start = match end.checked_sub(self.chunk_size) {
5410                 Some(sum) => sum,
5411                 None => 0,
5412             };
5413             let tmp = mem::replace(&mut self.v, &mut []);
5414             let (head, tail) = tmp.split_at_mut(start);
5415             let (nth, _) = tail.split_at_mut(end - start);
5416             self.v = head;
5417             Some(nth)
5418         }
5419     }
5420
5421     #[inline]
5422     fn last(self) -> Option<Self::Item> {
5423         if self.v.is_empty() {
5424             None
5425         } else {
5426             let rem = self.v.len() % self.chunk_size;
5427             let end = if rem == 0 { self.chunk_size } else { rem };
5428             Some(&mut self.v[0..end])
5429         }
5430     }
5431 }
5432
5433 #[stable(feature = "rchunks", since = "1.31.0")]
5434 impl<'a, T> DoubleEndedIterator for RChunksMut<'a, T> {
5435     #[inline]
5436     fn next_back(&mut self) -> Option<&'a mut [T]> {
5437         if self.v.is_empty() {
5438             None
5439         } else {
5440             let remainder = self.v.len() % self.chunk_size;
5441             let sz = if remainder != 0 { remainder } else { self.chunk_size };
5442             let tmp = mem::replace(&mut self.v, &mut []);
5443             let (head, tail) = tmp.split_at_mut(sz);
5444             self.v = tail;
5445             Some(head)
5446         }
5447     }
5448
5449     #[inline]
5450     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5451         let len = self.len();
5452         if n >= len {
5453             self.v = &mut [];
5454             None
5455         } else {
5456             // can't underflow because `n < len`
5457             let offset_from_end = (len - 1 - n) * self.chunk_size;
5458             let end = self.v.len() - offset_from_end;
5459             let start = end.saturating_sub(self.chunk_size);
5460             let (tmp, tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
5461             let (_, nth_back) = tmp.split_at_mut(start);
5462             self.v = tail;
5463             Some(nth_back)
5464         }
5465     }
5466 }
5467
5468 #[stable(feature = "rchunks", since = "1.31.0")]
5469 impl<T> ExactSizeIterator for RChunksMut<'_, T> {}
5470
5471 #[unstable(feature = "trusted_len", issue = "37572")]
5472 unsafe impl<T> TrustedLen for RChunksMut<'_, T> {}
5473
5474 #[stable(feature = "rchunks", since = "1.31.0")]
5475 impl<T> FusedIterator for RChunksMut<'_, T> {}
5476
5477 #[doc(hidden)]
5478 #[stable(feature = "rchunks", since = "1.31.0")]
5479 unsafe impl<'a, T> TrustedRandomAccess for RChunksMut<'a, T> {
5480     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
5481         let end = self.v.len() - i * self.chunk_size;
5482         let start = match end.checked_sub(self.chunk_size) {
5483             None => 0,
5484             Some(start) => start,
5485         };
5486         from_raw_parts_mut(self.v.as_mut_ptr().add(start), end - start)
5487     }
5488     fn may_have_side_effect() -> bool {
5489         false
5490     }
5491 }
5492
5493 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
5494 /// time), starting at the end of the slice.
5495 ///
5496 /// When the slice len is not evenly divided by the chunk size, the last
5497 /// up to `chunk_size-1` elements will be omitted but can be retrieved from
5498 /// the [`remainder`] function from the iterator.
5499 ///
5500 /// This struct is created by the [`rchunks_exact`] method on [slices].
5501 ///
5502 /// [`rchunks_exact`]: ../../std/primitive.slice.html#method.rchunks_exact
5503 /// [`remainder`]: ../../std/slice/struct.ChunksExact.html#method.remainder
5504 /// [slices]: ../../std/primitive.slice.html
5505 #[derive(Debug)]
5506 #[stable(feature = "rchunks", since = "1.31.0")]
5507 pub struct RChunksExact<'a, T: 'a> {
5508     v: &'a [T],
5509     rem: &'a [T],
5510     chunk_size: usize,
5511 }
5512
5513 impl<'a, T> RChunksExact<'a, T> {
5514     /// Returns the remainder of the original slice that is not going to be
5515     /// returned by the iterator. The returned slice has at most `chunk_size-1`
5516     /// elements.
5517     #[stable(feature = "rchunks", since = "1.31.0")]
5518     pub fn remainder(&self) -> &'a [T] {
5519         self.rem
5520     }
5521 }
5522
5523 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
5524 #[stable(feature = "rchunks", since = "1.31.0")]
5525 impl<'a, T> Clone for RChunksExact<'a, T> {
5526     fn clone(&self) -> RChunksExact<'a, T> {
5527         RChunksExact { v: self.v, rem: self.rem, chunk_size: self.chunk_size }
5528     }
5529 }
5530
5531 #[stable(feature = "rchunks", since = "1.31.0")]
5532 impl<'a, T> Iterator for RChunksExact<'a, T> {
5533     type Item = &'a [T];
5534
5535     #[inline]
5536     fn next(&mut self) -> Option<&'a [T]> {
5537         if self.v.len() < self.chunk_size {
5538             None
5539         } else {
5540             let (fst, snd) = self.v.split_at(self.v.len() - self.chunk_size);
5541             self.v = fst;
5542             Some(snd)
5543         }
5544     }
5545
5546     #[inline]
5547     fn size_hint(&self) -> (usize, Option<usize>) {
5548         let n = self.v.len() / self.chunk_size;
5549         (n, Some(n))
5550     }
5551
5552     #[inline]
5553     fn count(self) -> usize {
5554         self.len()
5555     }
5556
5557     #[inline]
5558     fn nth(&mut self, n: usize) -> Option<Self::Item> {
5559         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5560         if end >= self.v.len() || overflow {
5561             self.v = &[];
5562             None
5563         } else {
5564             let (fst, _) = self.v.split_at(self.v.len() - end);
5565             self.v = fst;
5566             self.next()
5567         }
5568     }
5569
5570     #[inline]
5571     fn last(mut self) -> Option<Self::Item> {
5572         self.next_back()
5573     }
5574 }
5575
5576 #[stable(feature = "rchunks", since = "1.31.0")]
5577 impl<'a, T> DoubleEndedIterator for RChunksExact<'a, T> {
5578     #[inline]
5579     fn next_back(&mut self) -> Option<&'a [T]> {
5580         if self.v.len() < self.chunk_size {
5581             None
5582         } else {
5583             let (fst, snd) = self.v.split_at(self.chunk_size);
5584             self.v = snd;
5585             Some(fst)
5586         }
5587     }
5588
5589     #[inline]
5590     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5591         let len = self.len();
5592         if n >= len {
5593             self.v = &[];
5594             None
5595         } else {
5596             // now that we know that `n` corresponds to a chunk,
5597             // none of these operations can underflow/overflow
5598             let offset = (len - n) * self.chunk_size;
5599             let start = self.v.len() - offset;
5600             let end = start + self.chunk_size;
5601             let nth_back = &self.v[start..end];
5602             self.v = &self.v[end..];
5603             Some(nth_back)
5604         }
5605     }
5606 }
5607
5608 #[stable(feature = "rchunks", since = "1.31.0")]
5609 impl<'a, T> ExactSizeIterator for RChunksExact<'a, T> {
5610     fn is_empty(&self) -> bool {
5611         self.v.is_empty()
5612     }
5613 }
5614
5615 #[unstable(feature = "trusted_len", issue = "37572")]
5616 unsafe impl<T> TrustedLen for RChunksExact<'_, T> {}
5617
5618 #[stable(feature = "rchunks", since = "1.31.0")]
5619 impl<T> FusedIterator for RChunksExact<'_, T> {}
5620
5621 #[doc(hidden)]
5622 #[stable(feature = "rchunks", since = "1.31.0")]
5623 unsafe impl<'a, T> TrustedRandomAccess for RChunksExact<'a, T> {
5624     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
5625         let end = self.v.len() - i * self.chunk_size;
5626         let start = end - self.chunk_size;
5627         from_raw_parts(self.v.as_ptr().add(start), self.chunk_size)
5628     }
5629     fn may_have_side_effect() -> bool {
5630         false
5631     }
5632 }
5633
5634 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
5635 /// elements at a time), starting at the end of the slice.
5636 ///
5637 /// When the slice len is not evenly divided by the chunk size, the last up to
5638 /// `chunk_size-1` elements will be omitted but can be retrieved from the
5639 /// [`into_remainder`] function from the iterator.
5640 ///
5641 /// This struct is created by the [`rchunks_exact_mut`] method on [slices].
5642 ///
5643 /// [`rchunks_exact_mut`]: ../../std/primitive.slice.html#method.rchunks_exact_mut
5644 /// [`into_remainder`]: ../../std/slice/struct.ChunksExactMut.html#method.into_remainder
5645 /// [slices]: ../../std/primitive.slice.html
5646 #[derive(Debug)]
5647 #[stable(feature = "rchunks", since = "1.31.0")]
5648 pub struct RChunksExactMut<'a, T: 'a> {
5649     v: &'a mut [T],
5650     rem: &'a mut [T],
5651     chunk_size: usize,
5652 }
5653
5654 impl<'a, T> RChunksExactMut<'a, T> {
5655     /// Returns the remainder of the original slice that is not going to be
5656     /// returned by the iterator. The returned slice has at most `chunk_size-1`
5657     /// elements.
5658     #[stable(feature = "rchunks", since = "1.31.0")]
5659     pub fn into_remainder(self) -> &'a mut [T] {
5660         self.rem
5661     }
5662 }
5663
5664 #[stable(feature = "rchunks", since = "1.31.0")]
5665 impl<'a, T> Iterator for RChunksExactMut<'a, T> {
5666     type Item = &'a mut [T];
5667
5668     #[inline]
5669     fn next(&mut self) -> Option<&'a mut [T]> {
5670         if self.v.len() < self.chunk_size {
5671             None
5672         } else {
5673             let tmp = mem::replace(&mut self.v, &mut []);
5674             let tmp_len = tmp.len();
5675             let (head, tail) = tmp.split_at_mut(tmp_len - self.chunk_size);
5676             self.v = head;
5677             Some(tail)
5678         }
5679     }
5680
5681     #[inline]
5682     fn size_hint(&self) -> (usize, Option<usize>) {
5683         let n = self.v.len() / self.chunk_size;
5684         (n, Some(n))
5685     }
5686
5687     #[inline]
5688     fn count(self) -> usize {
5689         self.len()
5690     }
5691
5692     #[inline]
5693     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
5694         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5695         if end >= self.v.len() || overflow {
5696             self.v = &mut [];
5697             None
5698         } else {
5699             let tmp = mem::replace(&mut self.v, &mut []);
5700             let tmp_len = tmp.len();
5701             let (fst, _) = tmp.split_at_mut(tmp_len - end);
5702             self.v = fst;
5703             self.next()
5704         }
5705     }
5706
5707     #[inline]
5708     fn last(mut self) -> Option<Self::Item> {
5709         self.next_back()
5710     }
5711 }
5712
5713 #[stable(feature = "rchunks", since = "1.31.0")]
5714 impl<'a, T> DoubleEndedIterator for RChunksExactMut<'a, T> {
5715     #[inline]
5716     fn next_back(&mut self) -> Option<&'a mut [T]> {
5717         if self.v.len() < self.chunk_size {
5718             None
5719         } else {
5720             let tmp = mem::replace(&mut self.v, &mut []);
5721             let (head, tail) = tmp.split_at_mut(self.chunk_size);
5722             self.v = tail;
5723             Some(head)
5724         }
5725     }
5726
5727     #[inline]
5728     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5729         let len = self.len();
5730         if n >= len {
5731             self.v = &mut [];
5732             None
5733         } else {
5734             // now that we know that `n` corresponds to a chunk,
5735             // none of these operations can underflow/overflow
5736             let offset = (len - n) * self.chunk_size;
5737             let start = self.v.len() - offset;
5738             let end = start + self.chunk_size;
5739             let (tmp, tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
5740             let (_, nth_back) = tmp.split_at_mut(start);
5741             self.v = tail;
5742             Some(nth_back)
5743         }
5744     }
5745 }
5746
5747 #[stable(feature = "rchunks", since = "1.31.0")]
5748 impl<T> ExactSizeIterator for RChunksExactMut<'_, T> {
5749     fn is_empty(&self) -> bool {
5750         self.v.is_empty()
5751     }
5752 }
5753
5754 #[unstable(feature = "trusted_len", issue = "37572")]
5755 unsafe impl<T> TrustedLen for RChunksExactMut<'_, T> {}
5756
5757 #[stable(feature = "rchunks", since = "1.31.0")]
5758 impl<T> FusedIterator for RChunksExactMut<'_, T> {}
5759
5760 #[doc(hidden)]
5761 #[stable(feature = "rchunks", since = "1.31.0")]
5762 unsafe impl<'a, T> TrustedRandomAccess for RChunksExactMut<'a, T> {
5763     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
5764         let end = self.v.len() - i * self.chunk_size;
5765         let start = end - self.chunk_size;
5766         from_raw_parts_mut(self.v.as_mut_ptr().add(start), self.chunk_size)
5767     }
5768     fn may_have_side_effect() -> bool {
5769         false
5770     }
5771 }
5772
5773 //
5774 // Free functions
5775 //
5776
5777 /// Forms a slice from a pointer and a length.
5778 ///
5779 /// The `len` argument is the number of **elements**, not the number of bytes.
5780 ///
5781 /// # Safety
5782 ///
5783 /// Behavior is undefined if any of the following conditions are violated:
5784 ///
5785 /// * `data` must be [valid] for reads for `len * mem::size_of::<T>()` many bytes,
5786 ///   and it must be properly aligned. This means in particular:
5787 ///
5788 ///     * The entire memory range of this slice must be contained within a single allocated object!
5789 ///       Slices can never span across multiple allocated objects. See [below](#incorrect-usage)
5790 ///       for an example incorrectly not taking this into account.
5791 ///     * `data` must be non-null and aligned even for zero-length slices. One
5792 ///       reason for this is that enum layout optimizations may rely on references
5793 ///       (including slices of any length) being aligned and non-null to distinguish
5794 ///       them from other data. You can obtain a pointer that is usable as `data`
5795 ///       for zero-length slices using [`NonNull::dangling()`].
5796 ///
5797 /// * The memory referenced by the returned slice must not be mutated for the duration
5798 ///   of lifetime `'a`, except inside an `UnsafeCell`.
5799 ///
5800 /// * The total size `len * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`.
5801 ///   See the safety documentation of [`pointer::offset`].
5802 ///
5803 /// # Caveat
5804 ///
5805 /// The lifetime for the returned slice is inferred from its usage. To
5806 /// prevent accidental misuse, it's suggested to tie the lifetime to whichever
5807 /// source lifetime is safe in the context, such as by providing a helper
5808 /// function taking the lifetime of a host value for the slice, or by explicit
5809 /// annotation.
5810 ///
5811 /// # Examples
5812 ///
5813 /// ```
5814 /// use std::slice;
5815 ///
5816 /// // manifest a slice for a single element
5817 /// let x = 42;
5818 /// let ptr = &x as *const _;
5819 /// let slice = unsafe { slice::from_raw_parts(ptr, 1) };
5820 /// assert_eq!(slice[0], 42);
5821 /// ```
5822 ///
5823 /// ### Incorrect usage
5824 ///
5825 /// The following `join_slices` function is **unsound** ⚠️
5826 ///
5827 /// ```rust,no_run
5828 /// use std::slice;
5829 ///
5830 /// fn join_slices<'a, T>(fst: &'a [T], snd: &'a [T]) -> &'a [T] {
5831 ///     let fst_end = fst.as_ptr().wrapping_add(fst.len());
5832 ///     let snd_start = snd.as_ptr();
5833 ///     assert_eq!(fst_end, snd_start, "Slices must be contiguous!");
5834 ///     unsafe {
5835 ///         // The assertion above ensures `fst` and `snd` are contiguous, but they might
5836 ///         // still be contained within _different allocated objects_, in which case
5837 ///         // creating this slice is undefined behavior.
5838 ///         slice::from_raw_parts(fst.as_ptr(), fst.len() + snd.len())
5839 ///     }
5840 /// }
5841 ///
5842 /// fn main() {
5843 ///     // `a` and `b` are different allocated objects...
5844 ///     let a = 42;
5845 ///     let b = 27;
5846 ///     // ... which may nevertheless be laid out contiguously in memory: | a | b |
5847 ///     let _ = join_slices(slice::from_ref(&a), slice::from_ref(&b)); // UB
5848 /// }
5849 /// ```
5850 ///
5851 /// [valid]: ../../std/ptr/index.html#safety
5852 /// [`NonNull::dangling()`]: ../../std/ptr/struct.NonNull.html#method.dangling
5853 /// [`pointer::offset`]: ../../std/primitive.pointer.html#method.offset
5854 #[inline]
5855 #[stable(feature = "rust1", since = "1.0.0")]
5856 pub unsafe fn from_raw_parts<'a, T>(data: *const T, len: usize) -> &'a [T] {
5857     debug_assert!(is_aligned_and_not_null(data), "attempt to create unaligned or null slice");
5858     debug_assert!(
5859         mem::size_of::<T>().saturating_mul(len) <= isize::MAX as usize,
5860         "attempt to create slice covering at least half the address space"
5861     );
5862     &*ptr::slice_from_raw_parts(data, len)
5863 }
5864
5865 /// Performs the same functionality as [`from_raw_parts`], except that a
5866 /// mutable slice is returned.
5867 ///
5868 /// # Safety
5869 ///
5870 /// Behavior is undefined if any of the following conditions are violated:
5871 ///
5872 /// * `data` must be [valid] for writes for `len * mem::size_of::<T>()` many bytes,
5873 ///   and it must be properly aligned. This means in particular:
5874 ///
5875 ///     * The entire memory range of this slice must be contained within a single allocated object!
5876 ///       Slices can never span across multiple allocated objects.
5877 ///     * `data` must be non-null and aligned even for zero-length slices. One
5878 ///       reason for this is that enum layout optimizations may rely on references
5879 ///       (including slices of any length) being aligned and non-null to distinguish
5880 ///       them from other data. You can obtain a pointer that is usable as `data`
5881 ///       for zero-length slices using [`NonNull::dangling()`].
5882 ///
5883 /// * The memory referenced by the returned slice must not be accessed through any other pointer
5884 ///   (not derived from the return value) for the duration of lifetime `'a`.
5885 ///   Both read and write accesses are forbidden.
5886 ///
5887 /// * The total size `len * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`.
5888 ///   See the safety documentation of [`pointer::offset`].
5889 ///
5890 /// [valid]: ../../std/ptr/index.html#safety
5891 /// [`NonNull::dangling()`]: ../../std/ptr/struct.NonNull.html#method.dangling
5892 /// [`pointer::offset`]: ../../std/primitive.pointer.html#method.offset
5893 /// [`from_raw_parts`]: ../../std/slice/fn.from_raw_parts.html
5894 #[inline]
5895 #[stable(feature = "rust1", since = "1.0.0")]
5896 pub unsafe fn from_raw_parts_mut<'a, T>(data: *mut T, len: usize) -> &'a mut [T] {
5897     debug_assert!(is_aligned_and_not_null(data), "attempt to create unaligned or null slice");
5898     debug_assert!(
5899         mem::size_of::<T>().saturating_mul(len) <= isize::MAX as usize,
5900         "attempt to create slice covering at least half the address space"
5901     );
5902     &mut *ptr::slice_from_raw_parts_mut(data, len)
5903 }
5904
5905 /// Converts a reference to T into a slice of length 1 (without copying).
5906 #[stable(feature = "from_ref", since = "1.28.0")]
5907 pub fn from_ref<T>(s: &T) -> &[T] {
5908     unsafe { from_raw_parts(s, 1) }
5909 }
5910
5911 /// Converts a reference to T into a slice of length 1 (without copying).
5912 #[stable(feature = "from_ref", since = "1.28.0")]
5913 pub fn from_mut<T>(s: &mut T) -> &mut [T] {
5914     unsafe { from_raw_parts_mut(s, 1) }
5915 }
5916
5917 // This function is public only because there is no other way to unit test heapsort.
5918 #[unstable(feature = "sort_internals", reason = "internal to sort module", issue = "none")]
5919 #[doc(hidden)]
5920 pub fn heapsort<T, F>(v: &mut [T], mut is_less: F)
5921 where
5922     F: FnMut(&T, &T) -> bool,
5923 {
5924     sort::heapsort(v, &mut is_less);
5925 }
5926
5927 //
5928 // Comparison traits
5929 //
5930
5931 extern "C" {
5932     /// Calls implementation provided memcmp.
5933     ///
5934     /// Interprets the data as u8.
5935     ///
5936     /// Returns 0 for equal, < 0 for less than and > 0 for greater
5937     /// than.
5938     // FIXME(#32610): Return type should be c_int
5939     fn memcmp(s1: *const u8, s2: *const u8, n: usize) -> i32;
5940 }
5941
5942 #[stable(feature = "rust1", since = "1.0.0")]
5943 impl<A, B> PartialEq<[B]> for [A]
5944 where
5945     A: PartialEq<B>,
5946 {
5947     fn eq(&self, other: &[B]) -> bool {
5948         SlicePartialEq::equal(self, other)
5949     }
5950
5951     fn ne(&self, other: &[B]) -> bool {
5952         SlicePartialEq::not_equal(self, other)
5953     }
5954 }
5955
5956 #[stable(feature = "rust1", since = "1.0.0")]
5957 impl<T: Eq> Eq for [T] {}
5958
5959 /// Implements comparison of vectors lexicographically.
5960 #[stable(feature = "rust1", since = "1.0.0")]
5961 impl<T: Ord> Ord for [T] {
5962     fn cmp(&self, other: &[T]) -> Ordering {
5963         SliceOrd::compare(self, other)
5964     }
5965 }
5966
5967 /// Implements comparison of vectors lexicographically.
5968 #[stable(feature = "rust1", since = "1.0.0")]
5969 impl<T: PartialOrd> PartialOrd for [T] {
5970     fn partial_cmp(&self, other: &[T]) -> Option<Ordering> {
5971         SlicePartialOrd::partial_compare(self, other)
5972     }
5973 }
5974
5975 #[doc(hidden)]
5976 // intermediate trait for specialization of slice's PartialEq
5977 trait SlicePartialEq<B> {
5978     fn equal(&self, other: &[B]) -> bool;
5979
5980     fn not_equal(&self, other: &[B]) -> bool {
5981         !self.equal(other)
5982     }
5983 }
5984
5985 // Generic slice equality
5986 impl<A, B> SlicePartialEq<B> for [A]
5987 where
5988     A: PartialEq<B>,
5989 {
5990     default fn equal(&self, other: &[B]) -> bool {
5991         if self.len() != other.len() {
5992             return false;
5993         }
5994
5995         self.iter().zip(other.iter()).all(|(x, y)| x == y)
5996     }
5997 }
5998
5999 // Use an equal-pointer optimization when types are `Eq`
6000 impl<A> SlicePartialEq<A> for [A]
6001 where
6002     A: PartialEq<A> + Eq,
6003 {
6004     default fn equal(&self, other: &[A]) -> bool {
6005         if self.len() != other.len() {
6006             return false;
6007         }
6008
6009         if self.as_ptr() == other.as_ptr() {
6010             return true;
6011         }
6012
6013         self.iter().zip(other.iter()).all(|(x, y)| x == y)
6014     }
6015 }
6016
6017 // Use memcmp for bytewise equality when the types allow
6018 impl<A> SlicePartialEq<A> for [A]
6019 where
6020     A: PartialEq<A> + BytewiseEquality,
6021 {
6022     fn equal(&self, other: &[A]) -> bool {
6023         if self.len() != other.len() {
6024             return false;
6025         }
6026         if self.as_ptr() == other.as_ptr() {
6027             return true;
6028         }
6029         unsafe {
6030             let size = mem::size_of_val(self);
6031             memcmp(self.as_ptr() as *const u8, other.as_ptr() as *const u8, size) == 0
6032         }
6033     }
6034 }
6035
6036 #[doc(hidden)]
6037 // intermediate trait for specialization of slice's PartialOrd
6038 trait SlicePartialOrd: Sized {
6039     fn partial_compare(left: &[Self], right: &[Self]) -> Option<Ordering>;
6040 }
6041
6042 impl<A: PartialOrd> SlicePartialOrd for A {
6043     default fn partial_compare(left: &[A], right: &[A]) -> Option<Ordering> {
6044         let l = cmp::min(left.len(), right.len());
6045
6046         // Slice to the loop iteration range to enable bound check
6047         // elimination in the compiler
6048         let lhs = &left[..l];
6049         let rhs = &right[..l];
6050
6051         for i in 0..l {
6052             match lhs[i].partial_cmp(&rhs[i]) {
6053                 Some(Ordering::Equal) => (),
6054                 non_eq => return non_eq,
6055             }
6056         }
6057
6058         left.len().partial_cmp(&right.len())
6059     }
6060 }
6061
6062 // This is the impl that we would like to have. Unfortunately it's not sound.
6063 // See `partial_ord_slice.rs`.
6064 /*
6065 impl<A> SlicePartialOrd for A
6066 where
6067     A: Ord,
6068 {
6069     default fn partial_compare(left: &[A], right: &[A]) -> Option<Ordering> {
6070         Some(SliceOrd::compare(left, right))
6071     }
6072 }
6073 */
6074
6075 impl<A: AlwaysApplicableOrd> SlicePartialOrd for A {
6076     fn partial_compare(left: &[A], right: &[A]) -> Option<Ordering> {
6077         Some(SliceOrd::compare(left, right))
6078     }
6079 }
6080
6081 trait AlwaysApplicableOrd: SliceOrd + Ord {}
6082
6083 macro_rules! always_applicable_ord {
6084     ($([$($p:tt)*] $t:ty,)*) => {
6085         $(impl<$($p)*> AlwaysApplicableOrd for $t {})*
6086     }
6087 }
6088
6089 always_applicable_ord! {
6090     [] u8, [] u16, [] u32, [] u64, [] u128, [] usize,
6091     [] i8, [] i16, [] i32, [] i64, [] i128, [] isize,
6092     [] bool, [] char,
6093     [T: ?Sized] *const T, [T: ?Sized] *mut T,
6094     [T: AlwaysApplicableOrd] &T,
6095     [T: AlwaysApplicableOrd] &mut T,
6096     [T: AlwaysApplicableOrd] Option<T>,
6097 }
6098
6099 #[doc(hidden)]
6100 // intermediate trait for specialization of slice's Ord
6101 trait SliceOrd: Sized {
6102     fn compare(left: &[Self], right: &[Self]) -> Ordering;
6103 }
6104
6105 impl<A: Ord> SliceOrd for A {
6106     default fn compare(left: &[Self], right: &[Self]) -> Ordering {
6107         let l = cmp::min(left.len(), right.len());
6108
6109         // Slice to the loop iteration range to enable bound check
6110         // elimination in the compiler
6111         let lhs = &left[..l];
6112         let rhs = &right[..l];
6113
6114         for i in 0..l {
6115             match lhs[i].cmp(&rhs[i]) {
6116                 Ordering::Equal => (),
6117                 non_eq => return non_eq,
6118             }
6119         }
6120
6121         left.len().cmp(&right.len())
6122     }
6123 }
6124
6125 // memcmp compares a sequence of unsigned bytes lexicographically.
6126 // this matches the order we want for [u8], but no others (not even [i8]).
6127 impl SliceOrd for u8 {
6128     #[inline]
6129     fn compare(left: &[Self], right: &[Self]) -> Ordering {
6130         let order =
6131             unsafe { memcmp(left.as_ptr(), right.as_ptr(), cmp::min(left.len(), right.len())) };
6132         if order == 0 {
6133             left.len().cmp(&right.len())
6134         } else if order < 0 {
6135             Less
6136         } else {
6137             Greater
6138         }
6139     }
6140 }
6141
6142 #[doc(hidden)]
6143 /// Trait implemented for types that can be compared for equality using
6144 /// their bytewise representation
6145 trait BytewiseEquality: Eq + Copy {}
6146
6147 macro_rules! impl_marker_for {
6148     ($traitname:ident, $($ty:ty)*) => {
6149         $(
6150             impl $traitname for $ty { }
6151         )*
6152     }
6153 }
6154
6155 impl_marker_for!(BytewiseEquality,
6156                  u8 i8 u16 i16 u32 i32 u64 i64 u128 i128 usize isize char bool);
6157
6158 #[doc(hidden)]
6159 unsafe impl<'a, T> TrustedRandomAccess for Iter<'a, T> {
6160     unsafe fn get_unchecked(&mut self, i: usize) -> &'a T {
6161         &*self.ptr.as_ptr().add(i)
6162     }
6163     fn may_have_side_effect() -> bool {
6164         false
6165     }
6166 }
6167
6168 #[doc(hidden)]
6169 unsafe impl<'a, T> TrustedRandomAccess for IterMut<'a, T> {
6170     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut T {
6171         &mut *self.ptr.as_ptr().add(i)
6172     }
6173     fn may_have_side_effect() -> bool {
6174         false
6175     }
6176 }
6177
6178 trait SliceContains: Sized {
6179     fn slice_contains(&self, x: &[Self]) -> bool;
6180 }
6181
6182 impl<T> SliceContains for T
6183 where
6184     T: PartialEq,
6185 {
6186     default fn slice_contains(&self, x: &[Self]) -> bool {
6187         x.iter().any(|y| *y == *self)
6188     }
6189 }
6190
6191 impl SliceContains for u8 {
6192     fn slice_contains(&self, x: &[Self]) -> bool {
6193         memchr::memchr(*self, x).is_some()
6194     }
6195 }
6196
6197 impl SliceContains for i8 {
6198     fn slice_contains(&self, x: &[Self]) -> bool {
6199         let byte = *self as u8;
6200         let bytes: &[u8] = unsafe { from_raw_parts(x.as_ptr() as *const u8, x.len()) };
6201         memchr::memchr(byte, bytes).is_some()
6202     }
6203 }