]> git.lizzy.rs Git - rust.git/blob - src/libcore/slice/mod.rs
Rollup merge of #73070 - ayazhafiz:i/72819, r=nikomatsakis
[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
2668 #[lang = "slice_u8"]
2669 #[cfg(not(test))]
2670 impl [u8] {
2671     /// Checks if all bytes in this slice are within the ASCII range.
2672     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2673     #[inline]
2674     pub fn is_ascii(&self) -> bool {
2675         self.iter().all(|b| b.is_ascii())
2676     }
2677
2678     /// Checks that two slices are an ASCII case-insensitive match.
2679     ///
2680     /// Same as `to_ascii_lowercase(a) == to_ascii_lowercase(b)`,
2681     /// but without allocating and copying temporaries.
2682     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2683     #[inline]
2684     pub fn eq_ignore_ascii_case(&self, other: &[u8]) -> bool {
2685         self.len() == other.len() && self.iter().zip(other).all(|(a, b)| a.eq_ignore_ascii_case(b))
2686     }
2687
2688     /// Converts this slice to its ASCII upper case equivalent in-place.
2689     ///
2690     /// ASCII letters 'a' to 'z' are mapped to 'A' to 'Z',
2691     /// but non-ASCII letters are unchanged.
2692     ///
2693     /// To return a new uppercased value without modifying the existing one, use
2694     /// [`to_ascii_uppercase`].
2695     ///
2696     /// [`to_ascii_uppercase`]: #method.to_ascii_uppercase
2697     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2698     #[inline]
2699     pub fn make_ascii_uppercase(&mut self) {
2700         for byte in self {
2701             byte.make_ascii_uppercase();
2702         }
2703     }
2704
2705     /// Converts this slice to its ASCII lower case equivalent in-place.
2706     ///
2707     /// ASCII letters 'A' to 'Z' are mapped to 'a' to 'z',
2708     /// but non-ASCII letters are unchanged.
2709     ///
2710     /// To return a new lowercased value without modifying the existing one, use
2711     /// [`to_ascii_lowercase`].
2712     ///
2713     /// [`to_ascii_lowercase`]: #method.to_ascii_lowercase
2714     #[stable(feature = "ascii_methods_on_intrinsics", since = "1.23.0")]
2715     #[inline]
2716     pub fn make_ascii_lowercase(&mut self) {
2717         for byte in self {
2718             byte.make_ascii_lowercase();
2719         }
2720     }
2721 }
2722
2723 #[stable(feature = "rust1", since = "1.0.0")]
2724 impl<T, I> ops::Index<I> for [T]
2725 where
2726     I: SliceIndex<[T]>,
2727 {
2728     type Output = I::Output;
2729
2730     #[inline]
2731     fn index(&self, index: I) -> &I::Output {
2732         index.index(self)
2733     }
2734 }
2735
2736 #[stable(feature = "rust1", since = "1.0.0")]
2737 impl<T, I> ops::IndexMut<I> for [T]
2738 where
2739     I: SliceIndex<[T]>,
2740 {
2741     #[inline]
2742     fn index_mut(&mut self, index: I) -> &mut I::Output {
2743         index.index_mut(self)
2744     }
2745 }
2746
2747 #[inline(never)]
2748 #[cold]
2749 #[track_caller]
2750 fn slice_index_len_fail(index: usize, len: usize) -> ! {
2751     panic!("index {} out of range for slice of length {}", index, len);
2752 }
2753
2754 #[inline(never)]
2755 #[cold]
2756 #[track_caller]
2757 fn slice_index_order_fail(index: usize, end: usize) -> ! {
2758     panic!("slice index starts at {} but ends at {}", index, end);
2759 }
2760
2761 #[inline(never)]
2762 #[cold]
2763 #[track_caller]
2764 fn slice_index_overflow_fail() -> ! {
2765     panic!("attempted to index slice up to maximum usize");
2766 }
2767
2768 mod private_slice_index {
2769     use super::ops;
2770     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2771     pub trait Sealed {}
2772
2773     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2774     impl Sealed for usize {}
2775     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2776     impl Sealed for ops::Range<usize> {}
2777     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2778     impl Sealed for ops::RangeTo<usize> {}
2779     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2780     impl Sealed for ops::RangeFrom<usize> {}
2781     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2782     impl Sealed for ops::RangeFull {}
2783     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2784     impl Sealed for ops::RangeInclusive<usize> {}
2785     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2786     impl Sealed for ops::RangeToInclusive<usize> {}
2787 }
2788
2789 /// A helper trait used for indexing operations.
2790 #[stable(feature = "slice_get_slice", since = "1.28.0")]
2791 #[rustc_on_unimplemented(
2792     on(T = "str", label = "string indices are ranges of `usize`",),
2793     on(
2794         all(any(T = "str", T = "&str", T = "std::string::String"), _Self = "{integer}"),
2795         note = "you can use `.chars().nth()` or `.bytes().nth()`
2796 see chapter in The Book <https://doc.rust-lang.org/book/ch08-02-strings.html#indexing-into-strings>"
2797     ),
2798     message = "the type `{T}` cannot be indexed by `{Self}`",
2799     label = "slice indices are of type `usize` or ranges of `usize`"
2800 )]
2801 pub trait SliceIndex<T: ?Sized>: private_slice_index::Sealed {
2802     /// The output type returned by methods.
2803     #[stable(feature = "slice_get_slice", since = "1.28.0")]
2804     type Output: ?Sized;
2805
2806     /// Returns a shared reference to the output at this location, if in
2807     /// bounds.
2808     #[unstable(feature = "slice_index_methods", issue = "none")]
2809     fn get(self, slice: &T) -> Option<&Self::Output>;
2810
2811     /// Returns a mutable reference to the output at this location, if in
2812     /// bounds.
2813     #[unstable(feature = "slice_index_methods", issue = "none")]
2814     fn get_mut(self, slice: &mut T) -> Option<&mut Self::Output>;
2815
2816     /// Returns a shared reference to the output at this location, without
2817     /// performing any bounds checking.
2818     /// Calling this method with an out-of-bounds index is *[undefined behavior]*
2819     /// even if the resulting reference is not used.
2820     /// [undefined behavior]: ../../reference/behavior-considered-undefined.html
2821     #[unstable(feature = "slice_index_methods", issue = "none")]
2822     unsafe fn get_unchecked(self, slice: &T) -> &Self::Output;
2823
2824     /// Returns a mutable reference to the output at this location, without
2825     /// performing any bounds checking.
2826     /// Calling this method with an out-of-bounds index is *[undefined behavior]*
2827     /// even if the resulting reference is not used.
2828     /// [undefined behavior]: ../../reference/behavior-considered-undefined.html
2829     #[unstable(feature = "slice_index_methods", issue = "none")]
2830     unsafe fn get_unchecked_mut(self, slice: &mut T) -> &mut Self::Output;
2831
2832     /// Returns a shared reference to the output at this location, panicking
2833     /// if out of bounds.
2834     #[unstable(feature = "slice_index_methods", issue = "none")]
2835     #[track_caller]
2836     fn index(self, slice: &T) -> &Self::Output;
2837
2838     /// Returns a mutable reference to the output at this location, panicking
2839     /// if out of bounds.
2840     #[unstable(feature = "slice_index_methods", issue = "none")]
2841     #[track_caller]
2842     fn index_mut(self, slice: &mut T) -> &mut Self::Output;
2843 }
2844
2845 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2846 impl<T> SliceIndex<[T]> for usize {
2847     type Output = T;
2848
2849     #[inline]
2850     fn get(self, slice: &[T]) -> Option<&T> {
2851         if self < slice.len() { unsafe { Some(self.get_unchecked(slice)) } } else { None }
2852     }
2853
2854     #[inline]
2855     fn get_mut(self, slice: &mut [T]) -> Option<&mut T> {
2856         if self < slice.len() { unsafe { Some(self.get_unchecked_mut(slice)) } } else { None }
2857     }
2858
2859     #[inline]
2860     unsafe fn get_unchecked(self, slice: &[T]) -> &T {
2861         &*slice.as_ptr().add(self)
2862     }
2863
2864     #[inline]
2865     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut T {
2866         &mut *slice.as_mut_ptr().add(self)
2867     }
2868
2869     #[inline]
2870     fn index(self, slice: &[T]) -> &T {
2871         // N.B., use intrinsic indexing
2872         &(*slice)[self]
2873     }
2874
2875     #[inline]
2876     fn index_mut(self, slice: &mut [T]) -> &mut T {
2877         // N.B., use intrinsic indexing
2878         &mut (*slice)[self]
2879     }
2880 }
2881
2882 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2883 impl<T> SliceIndex<[T]> for ops::Range<usize> {
2884     type Output = [T];
2885
2886     #[inline]
2887     fn get(self, slice: &[T]) -> Option<&[T]> {
2888         if self.start > self.end || self.end > slice.len() {
2889             None
2890         } else {
2891             unsafe { Some(self.get_unchecked(slice)) }
2892         }
2893     }
2894
2895     #[inline]
2896     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2897         if self.start > self.end || self.end > slice.len() {
2898             None
2899         } else {
2900             unsafe { Some(self.get_unchecked_mut(slice)) }
2901         }
2902     }
2903
2904     #[inline]
2905     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2906         from_raw_parts(slice.as_ptr().add(self.start), self.end - self.start)
2907     }
2908
2909     #[inline]
2910     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2911         from_raw_parts_mut(slice.as_mut_ptr().add(self.start), self.end - self.start)
2912     }
2913
2914     #[inline]
2915     fn index(self, slice: &[T]) -> &[T] {
2916         if self.start > self.end {
2917             slice_index_order_fail(self.start, self.end);
2918         } else if self.end > slice.len() {
2919             slice_index_len_fail(self.end, slice.len());
2920         }
2921         unsafe { self.get_unchecked(slice) }
2922     }
2923
2924     #[inline]
2925     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2926         if self.start > self.end {
2927             slice_index_order_fail(self.start, self.end);
2928         } else if self.end > slice.len() {
2929             slice_index_len_fail(self.end, slice.len());
2930         }
2931         unsafe { self.get_unchecked_mut(slice) }
2932     }
2933 }
2934
2935 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2936 impl<T> SliceIndex<[T]> for ops::RangeTo<usize> {
2937     type Output = [T];
2938
2939     #[inline]
2940     fn get(self, slice: &[T]) -> Option<&[T]> {
2941         (0..self.end).get(slice)
2942     }
2943
2944     #[inline]
2945     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2946         (0..self.end).get_mut(slice)
2947     }
2948
2949     #[inline]
2950     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2951         (0..self.end).get_unchecked(slice)
2952     }
2953
2954     #[inline]
2955     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2956         (0..self.end).get_unchecked_mut(slice)
2957     }
2958
2959     #[inline]
2960     fn index(self, slice: &[T]) -> &[T] {
2961         (0..self.end).index(slice)
2962     }
2963
2964     #[inline]
2965     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
2966         (0..self.end).index_mut(slice)
2967     }
2968 }
2969
2970 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
2971 impl<T> SliceIndex<[T]> for ops::RangeFrom<usize> {
2972     type Output = [T];
2973
2974     #[inline]
2975     fn get(self, slice: &[T]) -> Option<&[T]> {
2976         (self.start..slice.len()).get(slice)
2977     }
2978
2979     #[inline]
2980     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
2981         (self.start..slice.len()).get_mut(slice)
2982     }
2983
2984     #[inline]
2985     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
2986         (self.start..slice.len()).get_unchecked(slice)
2987     }
2988
2989     #[inline]
2990     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
2991         (self.start..slice.len()).get_unchecked_mut(slice)
2992     }
2993
2994     #[inline]
2995     fn index(self, slice: &[T]) -> &[T] {
2996         (self.start..slice.len()).index(slice)
2997     }
2998
2999     #[inline]
3000     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3001         (self.start..slice.len()).index_mut(slice)
3002     }
3003 }
3004
3005 #[stable(feature = "slice_get_slice_impls", since = "1.15.0")]
3006 impl<T> SliceIndex<[T]> for ops::RangeFull {
3007     type Output = [T];
3008
3009     #[inline]
3010     fn get(self, slice: &[T]) -> Option<&[T]> {
3011         Some(slice)
3012     }
3013
3014     #[inline]
3015     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
3016         Some(slice)
3017     }
3018
3019     #[inline]
3020     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3021         slice
3022     }
3023
3024     #[inline]
3025     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3026         slice
3027     }
3028
3029     #[inline]
3030     fn index(self, slice: &[T]) -> &[T] {
3031         slice
3032     }
3033
3034     #[inline]
3035     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3036         slice
3037     }
3038 }
3039
3040 #[stable(feature = "inclusive_range", since = "1.26.0")]
3041 impl<T> SliceIndex<[T]> for ops::RangeInclusive<usize> {
3042     type Output = [T];
3043
3044     #[inline]
3045     fn get(self, slice: &[T]) -> Option<&[T]> {
3046         if *self.end() == usize::max_value() {
3047             None
3048         } else {
3049             (*self.start()..self.end() + 1).get(slice)
3050         }
3051     }
3052
3053     #[inline]
3054     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
3055         if *self.end() == usize::max_value() {
3056             None
3057         } else {
3058             (*self.start()..self.end() + 1).get_mut(slice)
3059         }
3060     }
3061
3062     #[inline]
3063     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3064         (*self.start()..self.end() + 1).get_unchecked(slice)
3065     }
3066
3067     #[inline]
3068     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3069         (*self.start()..self.end() + 1).get_unchecked_mut(slice)
3070     }
3071
3072     #[inline]
3073     fn index(self, slice: &[T]) -> &[T] {
3074         if *self.end() == usize::max_value() {
3075             slice_index_overflow_fail();
3076         }
3077         (*self.start()..self.end() + 1).index(slice)
3078     }
3079
3080     #[inline]
3081     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3082         if *self.end() == usize::max_value() {
3083             slice_index_overflow_fail();
3084         }
3085         (*self.start()..self.end() + 1).index_mut(slice)
3086     }
3087 }
3088
3089 #[stable(feature = "inclusive_range", since = "1.26.0")]
3090 impl<T> SliceIndex<[T]> for ops::RangeToInclusive<usize> {
3091     type Output = [T];
3092
3093     #[inline]
3094     fn get(self, slice: &[T]) -> Option<&[T]> {
3095         (0..=self.end).get(slice)
3096     }
3097
3098     #[inline]
3099     fn get_mut(self, slice: &mut [T]) -> Option<&mut [T]> {
3100         (0..=self.end).get_mut(slice)
3101     }
3102
3103     #[inline]
3104     unsafe fn get_unchecked(self, slice: &[T]) -> &[T] {
3105         (0..=self.end).get_unchecked(slice)
3106     }
3107
3108     #[inline]
3109     unsafe fn get_unchecked_mut(self, slice: &mut [T]) -> &mut [T] {
3110         (0..=self.end).get_unchecked_mut(slice)
3111     }
3112
3113     #[inline]
3114     fn index(self, slice: &[T]) -> &[T] {
3115         (0..=self.end).index(slice)
3116     }
3117
3118     #[inline]
3119     fn index_mut(self, slice: &mut [T]) -> &mut [T] {
3120         (0..=self.end).index_mut(slice)
3121     }
3122 }
3123
3124 ////////////////////////////////////////////////////////////////////////////////
3125 // Common traits
3126 ////////////////////////////////////////////////////////////////////////////////
3127
3128 #[stable(feature = "rust1", since = "1.0.0")]
3129 impl<T> Default for &[T] {
3130     /// Creates an empty slice.
3131     fn default() -> Self {
3132         &[]
3133     }
3134 }
3135
3136 #[stable(feature = "mut_slice_default", since = "1.5.0")]
3137 impl<T> Default for &mut [T] {
3138     /// Creates a mutable empty slice.
3139     fn default() -> Self {
3140         &mut []
3141     }
3142 }
3143
3144 //
3145 // Iterators
3146 //
3147
3148 #[stable(feature = "rust1", since = "1.0.0")]
3149 impl<'a, T> IntoIterator for &'a [T] {
3150     type Item = &'a T;
3151     type IntoIter = Iter<'a, T>;
3152
3153     fn into_iter(self) -> Iter<'a, T> {
3154         self.iter()
3155     }
3156 }
3157
3158 #[stable(feature = "rust1", since = "1.0.0")]
3159 impl<'a, T> IntoIterator for &'a mut [T] {
3160     type Item = &'a mut T;
3161     type IntoIter = IterMut<'a, T>;
3162
3163     fn into_iter(self) -> IterMut<'a, T> {
3164         self.iter_mut()
3165     }
3166 }
3167
3168 // Macro helper functions
3169 #[inline(always)]
3170 fn size_from_ptr<T>(_: *const T) -> usize {
3171     mem::size_of::<T>()
3172 }
3173
3174 // Inlining is_empty and len makes a huge performance difference
3175 macro_rules! is_empty {
3176     // The way we encode the length of a ZST iterator, this works both for ZST
3177     // and non-ZST.
3178     ($self: ident) => {
3179         $self.ptr.as_ptr() as *const T == $self.end
3180     };
3181 }
3182
3183 // To get rid of some bounds checks (see `position`), we compute the length in a somewhat
3184 // unexpected way. (Tested by `codegen/slice-position-bounds-check`.)
3185 macro_rules! len {
3186     ($self: ident) => {{
3187         #![allow(unused_unsafe)] // we're sometimes used within an unsafe block
3188
3189         let start = $self.ptr;
3190         let size = size_from_ptr(start.as_ptr());
3191         if size == 0 {
3192             // This _cannot_ use `unchecked_sub` because we depend on wrapping
3193             // to represent the length of long ZST slice iterators.
3194             ($self.end as usize).wrapping_sub(start.as_ptr() as usize)
3195         } else {
3196             // We know that `start <= end`, so can do better than `offset_from`,
3197             // which needs to deal in signed.  By setting appropriate flags here
3198             // we can tell LLVM this, which helps it remove bounds checks.
3199             // SAFETY: By the type invariant, `start <= end`
3200             let diff = unsafe { unchecked_sub($self.end as usize, start.as_ptr() as usize) };
3201             // By also telling LLVM that the pointers are apart by an exact
3202             // multiple of the type size, it can optimize `len() == 0` down to
3203             // `start == end` instead of `(end - start) < size`.
3204             // SAFETY: By the type invariant, the pointers are aligned so the
3205             //         distance between them must be a multiple of pointee size
3206             unsafe { exact_div(diff, size) }
3207         }
3208     }};
3209 }
3210
3211 // The shared definition of the `Iter` and `IterMut` iterators
3212 macro_rules! iterator {
3213     (
3214         struct $name:ident -> $ptr:ty,
3215         $elem:ty,
3216         $raw_mut:tt,
3217         {$( $mut_:tt )*},
3218         {$($extra:tt)*}
3219     ) => {
3220         // Returns the first element and moves the start of the iterator forwards by 1.
3221         // Greatly improves performance compared to an inlined function. The iterator
3222         // must not be empty.
3223         macro_rules! next_unchecked {
3224             ($self: ident) => {& $( $mut_ )* *$self.post_inc_start(1)}
3225         }
3226
3227         // Returns the last element and moves the end of the iterator backwards by 1.
3228         // Greatly improves performance compared to an inlined function. The iterator
3229         // must not be empty.
3230         macro_rules! next_back_unchecked {
3231             ($self: ident) => {& $( $mut_ )* *$self.pre_dec_end(1)}
3232         }
3233
3234         // Shrinks the iterator when T is a ZST, by moving the end of the iterator
3235         // backwards by `n`. `n` must not exceed `self.len()`.
3236         macro_rules! zst_shrink {
3237             ($self: ident, $n: ident) => {
3238                 $self.end = ($self.end as * $raw_mut u8).wrapping_offset(-$n) as * $raw_mut T;
3239             }
3240         }
3241
3242         impl<'a, T> $name<'a, T> {
3243             // Helper function for creating a slice from the iterator.
3244             #[inline(always)]
3245             fn make_slice(&self) -> &'a [T] {
3246                 unsafe { from_raw_parts(self.ptr.as_ptr(), len!(self)) }
3247             }
3248
3249             // Helper function for moving the start of the iterator forwards by `offset` elements,
3250             // returning the old start.
3251             // Unsafe because the offset must not exceed `self.len()`.
3252             #[inline(always)]
3253             unsafe fn post_inc_start(&mut self, offset: isize) -> * $raw_mut T {
3254                 if mem::size_of::<T>() == 0 {
3255                     zst_shrink!(self, offset);
3256                     self.ptr.as_ptr()
3257                 } else {
3258                     let old = self.ptr.as_ptr();
3259                     self.ptr = NonNull::new_unchecked(self.ptr.as_ptr().offset(offset));
3260                     old
3261                 }
3262             }
3263
3264             // Helper function for moving the end of the iterator backwards by `offset` elements,
3265             // returning the new end.
3266             // Unsafe because the offset must not exceed `self.len()`.
3267             #[inline(always)]
3268             unsafe fn pre_dec_end(&mut self, offset: isize) -> * $raw_mut T {
3269                 if mem::size_of::<T>() == 0 {
3270                     zst_shrink!(self, offset);
3271                     self.ptr.as_ptr()
3272                 } else {
3273                     self.end = self.end.offset(-offset);
3274                     self.end
3275                 }
3276             }
3277         }
3278
3279         #[stable(feature = "rust1", since = "1.0.0")]
3280         impl<T> ExactSizeIterator for $name<'_, T> {
3281             #[inline(always)]
3282             fn len(&self) -> usize {
3283                 len!(self)
3284             }
3285
3286             #[inline(always)]
3287             fn is_empty(&self) -> bool {
3288                 is_empty!(self)
3289             }
3290         }
3291
3292         #[stable(feature = "rust1", since = "1.0.0")]
3293         impl<'a, T> Iterator for $name<'a, T> {
3294             type Item = $elem;
3295
3296             #[inline]
3297             fn next(&mut self) -> Option<$elem> {
3298                 // could be implemented with slices, but this avoids bounds checks
3299                 unsafe {
3300                     assume(!self.ptr.as_ptr().is_null());
3301                     if mem::size_of::<T>() != 0 {
3302                         assume(!self.end.is_null());
3303                     }
3304                     if is_empty!(self) {
3305                         None
3306                     } else {
3307                         Some(next_unchecked!(self))
3308                     }
3309                 }
3310             }
3311
3312             #[inline]
3313             fn size_hint(&self) -> (usize, Option<usize>) {
3314                 let exact = len!(self);
3315                 (exact, Some(exact))
3316             }
3317
3318             #[inline]
3319             fn count(self) -> usize {
3320                 len!(self)
3321             }
3322
3323             #[inline]
3324             fn nth(&mut self, n: usize) -> Option<$elem> {
3325                 if n >= len!(self) {
3326                     // This iterator is now empty.
3327                     if mem::size_of::<T>() == 0 {
3328                         // We have to do it this way as `ptr` may never be 0, but `end`
3329                         // could be (due to wrapping).
3330                         self.end = self.ptr.as_ptr();
3331                     } else {
3332                         unsafe {
3333                             // End can't be 0 if T isn't ZST because ptr isn't 0 and end >= ptr
3334                             self.ptr = NonNull::new_unchecked(self.end as *mut T);
3335                         }
3336                     }
3337                     return None;
3338                 }
3339                 // We are in bounds. `post_inc_start` does the right thing even for ZSTs.
3340                 unsafe {
3341                     self.post_inc_start(n as isize);
3342                     Some(next_unchecked!(self))
3343                 }
3344             }
3345
3346             #[inline]
3347             fn last(mut self) -> Option<$elem> {
3348                 self.next_back()
3349             }
3350
3351             // We override the default implementation, which uses `try_fold`,
3352             // because this simple implementation generates less LLVM IR and is
3353             // faster to compile.
3354             #[inline]
3355             fn for_each<F>(mut self, mut f: F)
3356             where
3357                 Self: Sized,
3358                 F: FnMut(Self::Item),
3359             {
3360                 while let Some(x) = self.next() {
3361                     f(x);
3362                 }
3363             }
3364
3365             // We override the default implementation, which uses `try_fold`,
3366             // because this simple implementation generates less LLVM IR and is
3367             // faster to compile.
3368             #[inline]
3369             fn all<F>(&mut self, mut f: F) -> bool
3370             where
3371                 Self: Sized,
3372                 F: FnMut(Self::Item) -> bool,
3373             {
3374                 while let Some(x) = self.next() {
3375                     if !f(x) {
3376                         return false;
3377                     }
3378                 }
3379                 true
3380             }
3381
3382             // We override the default implementation, which uses `try_fold`,
3383             // because this simple implementation generates less LLVM IR and is
3384             // faster to compile.
3385             #[inline]
3386             fn any<F>(&mut self, mut f: F) -> bool
3387             where
3388                 Self: Sized,
3389                 F: FnMut(Self::Item) -> bool,
3390             {
3391                 while let Some(x) = self.next() {
3392                     if f(x) {
3393                         return true;
3394                     }
3395                 }
3396                 false
3397             }
3398
3399             // We override the default implementation, which uses `try_fold`,
3400             // because this simple implementation generates less LLVM IR and is
3401             // faster to compile.
3402             #[inline]
3403             fn find<P>(&mut self, mut predicate: P) -> Option<Self::Item>
3404             where
3405                 Self: Sized,
3406                 P: FnMut(&Self::Item) -> bool,
3407             {
3408                 while let Some(x) = self.next() {
3409                     if predicate(&x) {
3410                         return Some(x);
3411                     }
3412                 }
3413                 None
3414             }
3415
3416             // We override the default implementation, which uses `try_fold`,
3417             // because this simple implementation generates less LLVM IR and is
3418             // faster to compile.
3419             #[inline]
3420             fn find_map<B, F>(&mut self, mut f: F) -> Option<B>
3421             where
3422                 Self: Sized,
3423                 F: FnMut(Self::Item) -> Option<B>,
3424             {
3425                 while let Some(x) = self.next() {
3426                     if let Some(y) = f(x) {
3427                         return Some(y);
3428                     }
3429                 }
3430                 None
3431             }
3432
3433             // We override the default implementation, which uses `try_fold`,
3434             // because this simple implementation generates less LLVM IR and is
3435             // faster to compile. Also, the `assume` avoids a bounds check.
3436             #[inline]
3437             #[rustc_inherit_overflow_checks]
3438             fn position<P>(&mut self, mut predicate: P) -> Option<usize> where
3439                 Self: Sized,
3440                 P: FnMut(Self::Item) -> bool,
3441             {
3442                 let n = len!(self);
3443                 let mut i = 0;
3444                 while let Some(x) = self.next() {
3445                     if predicate(x) {
3446                         unsafe { assume(i < n) };
3447                         return Some(i);
3448                     }
3449                     i += 1;
3450                 }
3451                 None
3452             }
3453
3454             // We override the default implementation, which uses `try_fold`,
3455             // because this simple implementation generates less LLVM IR and is
3456             // faster to compile. Also, the `assume` avoids a bounds check.
3457             #[inline]
3458             fn rposition<P>(&mut self, mut predicate: P) -> Option<usize> where
3459                 P: FnMut(Self::Item) -> bool,
3460                 Self: Sized + ExactSizeIterator + DoubleEndedIterator
3461             {
3462                 let n = len!(self);
3463                 let mut i = n;
3464                 while let Some(x) = self.next_back() {
3465                     i -= 1;
3466                     if predicate(x) {
3467                         unsafe { assume(i < n) };
3468                         return Some(i);
3469                     }
3470                 }
3471                 None
3472             }
3473
3474             $($extra)*
3475         }
3476
3477         #[stable(feature = "rust1", since = "1.0.0")]
3478         impl<'a, T> DoubleEndedIterator for $name<'a, T> {
3479             #[inline]
3480             fn next_back(&mut self) -> Option<$elem> {
3481                 // could be implemented with slices, but this avoids bounds checks
3482                 unsafe {
3483                     assume(!self.ptr.as_ptr().is_null());
3484                     if mem::size_of::<T>() != 0 {
3485                         assume(!self.end.is_null());
3486                     }
3487                     if is_empty!(self) {
3488                         None
3489                     } else {
3490                         Some(next_back_unchecked!(self))
3491                     }
3492                 }
3493             }
3494
3495             #[inline]
3496             fn nth_back(&mut self, n: usize) -> Option<$elem> {
3497                 if n >= len!(self) {
3498                     // This iterator is now empty.
3499                     self.end = self.ptr.as_ptr();
3500                     return None;
3501                 }
3502                 // We are in bounds. `pre_dec_end` does the right thing even for ZSTs.
3503                 unsafe {
3504                     self.pre_dec_end(n as isize);
3505                     Some(next_back_unchecked!(self))
3506                 }
3507             }
3508         }
3509
3510         #[stable(feature = "fused", since = "1.26.0")]
3511         impl<T> FusedIterator for $name<'_, T> {}
3512
3513         #[unstable(feature = "trusted_len", issue = "37572")]
3514         unsafe impl<T> TrustedLen for $name<'_, T> {}
3515     }
3516 }
3517
3518 /// Immutable slice iterator
3519 ///
3520 /// This struct is created by the [`iter`] method on [slices].
3521 ///
3522 /// # Examples
3523 ///
3524 /// Basic usage:
3525 ///
3526 /// ```
3527 /// // First, we declare a type which has `iter` method to get the `Iter` struct (&[usize here]):
3528 /// let slice = &[1, 2, 3];
3529 ///
3530 /// // Then, we iterate over it:
3531 /// for element in slice.iter() {
3532 ///     println!("{}", element);
3533 /// }
3534 /// ```
3535 ///
3536 /// [`iter`]: ../../std/primitive.slice.html#method.iter
3537 /// [slices]: ../../std/primitive.slice.html
3538 #[stable(feature = "rust1", since = "1.0.0")]
3539 pub struct Iter<'a, T: 'a> {
3540     ptr: NonNull<T>,
3541     end: *const T, // If T is a ZST, this is actually ptr+len.  This encoding is picked so that
3542     // ptr == end is a quick test for the Iterator being empty, that works
3543     // for both ZST and non-ZST.
3544     _marker: marker::PhantomData<&'a T>,
3545 }
3546
3547 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3548 impl<T: fmt::Debug> fmt::Debug for Iter<'_, T> {
3549     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3550         f.debug_tuple("Iter").field(&self.as_slice()).finish()
3551     }
3552 }
3553
3554 #[stable(feature = "rust1", since = "1.0.0")]
3555 unsafe impl<T: Sync> Sync for Iter<'_, T> {}
3556 #[stable(feature = "rust1", since = "1.0.0")]
3557 unsafe impl<T: Sync> Send for Iter<'_, T> {}
3558
3559 impl<'a, T> Iter<'a, T> {
3560     /// Views the underlying data as a subslice of the original data.
3561     ///
3562     /// This has the same lifetime as the original slice, and so the
3563     /// iterator can continue to be used while this exists.
3564     ///
3565     /// # Examples
3566     ///
3567     /// Basic usage:
3568     ///
3569     /// ```
3570     /// // First, we declare a type which has the `iter` method to get the `Iter`
3571     /// // struct (&[usize here]):
3572     /// let slice = &[1, 2, 3];
3573     ///
3574     /// // Then, we get the iterator:
3575     /// let mut iter = slice.iter();
3576     /// // So if we print what `as_slice` method returns here, we have "[1, 2, 3]":
3577     /// println!("{:?}", iter.as_slice());
3578     ///
3579     /// // Next, we move to the second element of the slice:
3580     /// iter.next();
3581     /// // Now `as_slice` returns "[2, 3]":
3582     /// println!("{:?}", iter.as_slice());
3583     /// ```
3584     #[stable(feature = "iter_to_slice", since = "1.4.0")]
3585     pub fn as_slice(&self) -> &'a [T] {
3586         self.make_slice()
3587     }
3588 }
3589
3590 iterator! {struct Iter -> *const T, &'a T, const, {/* no mut */}, {
3591     fn is_sorted_by<F>(self, mut compare: F) -> bool
3592     where
3593         Self: Sized,
3594         F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,
3595     {
3596         self.as_slice().windows(2).all(|w| {
3597             compare(&&w[0], &&w[1]).map(|o| o != Ordering::Greater).unwrap_or(false)
3598         })
3599     }
3600 }}
3601
3602 #[stable(feature = "rust1", since = "1.0.0")]
3603 impl<T> Clone for Iter<'_, T> {
3604     fn clone(&self) -> Self {
3605         Iter { ptr: self.ptr, end: self.end, _marker: self._marker }
3606     }
3607 }
3608
3609 #[stable(feature = "slice_iter_as_ref", since = "1.13.0")]
3610 impl<T> AsRef<[T]> for Iter<'_, T> {
3611     fn as_ref(&self) -> &[T] {
3612         self.as_slice()
3613     }
3614 }
3615
3616 /// Mutable slice iterator.
3617 ///
3618 /// This struct is created by the [`iter_mut`] method on [slices].
3619 ///
3620 /// # Examples
3621 ///
3622 /// Basic usage:
3623 ///
3624 /// ```
3625 /// // First, we declare a type which has `iter_mut` method to get the `IterMut`
3626 /// // struct (&[usize here]):
3627 /// let mut slice = &mut [1, 2, 3];
3628 ///
3629 /// // Then, we iterate over it and increment each element value:
3630 /// for element in slice.iter_mut() {
3631 ///     *element += 1;
3632 /// }
3633 ///
3634 /// // We now have "[2, 3, 4]":
3635 /// println!("{:?}", slice);
3636 /// ```
3637 ///
3638 /// [`iter_mut`]: ../../std/primitive.slice.html#method.iter_mut
3639 /// [slices]: ../../std/primitive.slice.html
3640 #[stable(feature = "rust1", since = "1.0.0")]
3641 pub struct IterMut<'a, T: 'a> {
3642     ptr: NonNull<T>,
3643     end: *mut T, // If T is a ZST, this is actually ptr+len.  This encoding is picked so that
3644     // ptr == end is a quick test for the Iterator being empty, that works
3645     // for both ZST and non-ZST.
3646     _marker: marker::PhantomData<&'a mut T>,
3647 }
3648
3649 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3650 impl<T: fmt::Debug> fmt::Debug for IterMut<'_, T> {
3651     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3652         f.debug_tuple("IterMut").field(&self.make_slice()).finish()
3653     }
3654 }
3655
3656 #[stable(feature = "rust1", since = "1.0.0")]
3657 unsafe impl<T: Sync> Sync for IterMut<'_, T> {}
3658 #[stable(feature = "rust1", since = "1.0.0")]
3659 unsafe impl<T: Send> Send for IterMut<'_, T> {}
3660
3661 impl<'a, T> IterMut<'a, T> {
3662     /// Views the underlying data as a subslice of the original data.
3663     ///
3664     /// To avoid creating `&mut` references that alias, this is forced
3665     /// to consume the iterator.
3666     ///
3667     /// # Examples
3668     ///
3669     /// Basic usage:
3670     ///
3671     /// ```
3672     /// // First, we declare a type which has `iter_mut` method to get the `IterMut`
3673     /// // struct (&[usize here]):
3674     /// let mut slice = &mut [1, 2, 3];
3675     ///
3676     /// {
3677     ///     // Then, we get the iterator:
3678     ///     let mut iter = slice.iter_mut();
3679     ///     // We move to next element:
3680     ///     iter.next();
3681     ///     // So if we print what `into_slice` method returns here, we have "[2, 3]":
3682     ///     println!("{:?}", iter.into_slice());
3683     /// }
3684     ///
3685     /// // Now let's modify a value of the slice:
3686     /// {
3687     ///     // First we get back the iterator:
3688     ///     let mut iter = slice.iter_mut();
3689     ///     // We change the value of the first element of the slice returned by the `next` method:
3690     ///     *iter.next().unwrap() += 1;
3691     /// }
3692     /// // Now slice is "[2, 2, 3]":
3693     /// println!("{:?}", slice);
3694     /// ```
3695     #[stable(feature = "iter_to_slice", since = "1.4.0")]
3696     pub fn into_slice(self) -> &'a mut [T] {
3697         unsafe { from_raw_parts_mut(self.ptr.as_ptr(), len!(self)) }
3698     }
3699
3700     /// Views the underlying data as a subslice of the original data.
3701     ///
3702     /// To avoid creating `&mut [T]` references that alias, the returned slice
3703     /// borrows its lifetime from the iterator the method is applied on.
3704     ///
3705     /// # Examples
3706     ///
3707     /// Basic usage:
3708     ///
3709     /// ```
3710     /// # #![feature(slice_iter_mut_as_slice)]
3711     /// let mut slice: &mut [usize] = &mut [1, 2, 3];
3712     ///
3713     /// // First, we get the iterator:
3714     /// let mut iter = slice.iter_mut();
3715     /// // So if we check what the `as_slice` method returns here, we have "[1, 2, 3]":
3716     /// assert_eq!(iter.as_slice(), &[1, 2, 3]);
3717     ///
3718     /// // Next, we move to the second element of the slice:
3719     /// iter.next();
3720     /// // Now `as_slice` returns "[2, 3]":
3721     /// assert_eq!(iter.as_slice(), &[2, 3]);
3722     /// ```
3723     #[unstable(feature = "slice_iter_mut_as_slice", reason = "recently added", issue = "58957")]
3724     pub fn as_slice(&self) -> &[T] {
3725         self.make_slice()
3726     }
3727 }
3728
3729 iterator! {struct IterMut -> *mut T, &'a mut T, mut, {mut}, {}}
3730
3731 /// An internal abstraction over the splitting iterators, so that
3732 /// splitn, splitn_mut etc can be implemented once.
3733 #[doc(hidden)]
3734 trait SplitIter: DoubleEndedIterator {
3735     /// Marks the underlying iterator as complete, extracting the remaining
3736     /// portion of the slice.
3737     fn finish(&mut self) -> Option<Self::Item>;
3738 }
3739
3740 /// An iterator over subslices separated by elements that match a predicate
3741 /// function.
3742 ///
3743 /// This struct is created by the [`split`] method on [slices].
3744 ///
3745 /// [`split`]: ../../std/primitive.slice.html#method.split
3746 /// [slices]: ../../std/primitive.slice.html
3747 #[stable(feature = "rust1", since = "1.0.0")]
3748 pub struct Split<'a, T: 'a, P>
3749 where
3750     P: FnMut(&T) -> bool,
3751 {
3752     v: &'a [T],
3753     pred: P,
3754     finished: bool,
3755 }
3756
3757 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3758 impl<T: fmt::Debug, P> fmt::Debug for Split<'_, T, P>
3759 where
3760     P: FnMut(&T) -> bool,
3761 {
3762     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3763         f.debug_struct("Split").field("v", &self.v).field("finished", &self.finished).finish()
3764     }
3765 }
3766
3767 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
3768 #[stable(feature = "rust1", since = "1.0.0")]
3769 impl<T, P> Clone for Split<'_, T, P>
3770 where
3771     P: Clone + FnMut(&T) -> bool,
3772 {
3773     fn clone(&self) -> Self {
3774         Split { v: self.v, pred: self.pred.clone(), finished: self.finished }
3775     }
3776 }
3777
3778 #[stable(feature = "rust1", since = "1.0.0")]
3779 impl<'a, T, P> Iterator for Split<'a, T, P>
3780 where
3781     P: FnMut(&T) -> bool,
3782 {
3783     type Item = &'a [T];
3784
3785     #[inline]
3786     fn next(&mut self) -> Option<&'a [T]> {
3787         if self.finished {
3788             return None;
3789         }
3790
3791         match self.v.iter().position(|x| (self.pred)(x)) {
3792             None => self.finish(),
3793             Some(idx) => {
3794                 let ret = Some(&self.v[..idx]);
3795                 self.v = &self.v[idx + 1..];
3796                 ret
3797             }
3798         }
3799     }
3800
3801     #[inline]
3802     fn size_hint(&self) -> (usize, Option<usize>) {
3803         if self.finished { (0, Some(0)) } else { (1, Some(self.v.len() + 1)) }
3804     }
3805 }
3806
3807 #[stable(feature = "rust1", since = "1.0.0")]
3808 impl<'a, T, P> DoubleEndedIterator for Split<'a, T, P>
3809 where
3810     P: FnMut(&T) -> bool,
3811 {
3812     #[inline]
3813     fn next_back(&mut self) -> Option<&'a [T]> {
3814         if self.finished {
3815             return None;
3816         }
3817
3818         match self.v.iter().rposition(|x| (self.pred)(x)) {
3819             None => self.finish(),
3820             Some(idx) => {
3821                 let ret = Some(&self.v[idx + 1..]);
3822                 self.v = &self.v[..idx];
3823                 ret
3824             }
3825         }
3826     }
3827 }
3828
3829 impl<'a, T, P> SplitIter for Split<'a, T, P>
3830 where
3831     P: FnMut(&T) -> bool,
3832 {
3833     #[inline]
3834     fn finish(&mut self) -> Option<&'a [T]> {
3835         if self.finished {
3836             None
3837         } else {
3838             self.finished = true;
3839             Some(self.v)
3840         }
3841     }
3842 }
3843
3844 #[stable(feature = "fused", since = "1.26.0")]
3845 impl<T, P> FusedIterator for Split<'_, T, P> where P: FnMut(&T) -> bool {}
3846
3847 /// An iterator over subslices separated by elements that match a predicate
3848 /// function. Unlike `Split`, it contains the matched part as a terminator
3849 /// of the subslice.
3850 ///
3851 /// This struct is created by the [`split_inclusive`] method on [slices].
3852 ///
3853 /// [`split_inclusive`]: ../../std/primitive.slice.html#method.split_inclusive
3854 /// [slices]: ../../std/primitive.slice.html
3855 #[unstable(feature = "split_inclusive", issue = "72360")]
3856 pub struct SplitInclusive<'a, T: 'a, P>
3857 where
3858     P: FnMut(&T) -> bool,
3859 {
3860     v: &'a [T],
3861     pred: P,
3862     finished: bool,
3863 }
3864
3865 #[unstable(feature = "split_inclusive", issue = "72360")]
3866 impl<T: fmt::Debug, P> fmt::Debug for SplitInclusive<'_, T, P>
3867 where
3868     P: FnMut(&T) -> bool,
3869 {
3870     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3871         f.debug_struct("SplitInclusive")
3872             .field("v", &self.v)
3873             .field("finished", &self.finished)
3874             .finish()
3875     }
3876 }
3877
3878 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
3879 #[unstable(feature = "split_inclusive", issue = "72360")]
3880 impl<T, P> Clone for SplitInclusive<'_, T, P>
3881 where
3882     P: Clone + FnMut(&T) -> bool,
3883 {
3884     fn clone(&self) -> Self {
3885         SplitInclusive { v: self.v, pred: self.pred.clone(), finished: self.finished }
3886     }
3887 }
3888
3889 #[unstable(feature = "split_inclusive", issue = "72360")]
3890 impl<'a, T, P> Iterator for SplitInclusive<'a, T, P>
3891 where
3892     P: FnMut(&T) -> bool,
3893 {
3894     type Item = &'a [T];
3895
3896     #[inline]
3897     fn next(&mut self) -> Option<&'a [T]> {
3898         if self.finished {
3899             return None;
3900         }
3901
3902         let idx =
3903             self.v.iter().position(|x| (self.pred)(x)).map(|idx| idx + 1).unwrap_or(self.v.len());
3904         if idx == self.v.len() {
3905             self.finished = true;
3906         }
3907         let ret = Some(&self.v[..idx]);
3908         self.v = &self.v[idx..];
3909         ret
3910     }
3911
3912     #[inline]
3913     fn size_hint(&self) -> (usize, Option<usize>) {
3914         if self.finished { (0, Some(0)) } else { (1, Some(self.v.len() + 1)) }
3915     }
3916 }
3917
3918 #[unstable(feature = "split_inclusive", issue = "72360")]
3919 impl<'a, T, P> DoubleEndedIterator for SplitInclusive<'a, T, P>
3920 where
3921     P: FnMut(&T) -> bool,
3922 {
3923     #[inline]
3924     fn next_back(&mut self) -> Option<&'a [T]> {
3925         if self.finished {
3926             return None;
3927         }
3928
3929         // The last index of self.v is already checked and found to match
3930         // by the last iteration, so we start searching a new match
3931         // one index to the left.
3932         let remainder = if self.v.is_empty() { &[] } else { &self.v[..(self.v.len() - 1)] };
3933         let idx = remainder.iter().rposition(|x| (self.pred)(x)).map(|idx| idx + 1).unwrap_or(0);
3934         if idx == 0 {
3935             self.finished = true;
3936         }
3937         let ret = Some(&self.v[idx..]);
3938         self.v = &self.v[..idx];
3939         ret
3940     }
3941 }
3942
3943 #[unstable(feature = "split_inclusive", issue = "72360")]
3944 impl<T, P> FusedIterator for SplitInclusive<'_, T, P> where P: FnMut(&T) -> bool {}
3945
3946 /// An iterator over the mutable subslices of the vector which are separated
3947 /// by elements that match `pred`.
3948 ///
3949 /// This struct is created by the [`split_mut`] method on [slices].
3950 ///
3951 /// [`split_mut`]: ../../std/primitive.slice.html#method.split_mut
3952 /// [slices]: ../../std/primitive.slice.html
3953 #[stable(feature = "rust1", since = "1.0.0")]
3954 pub struct SplitMut<'a, T: 'a, P>
3955 where
3956     P: FnMut(&T) -> bool,
3957 {
3958     v: &'a mut [T],
3959     pred: P,
3960     finished: bool,
3961 }
3962
3963 #[stable(feature = "core_impl_debug", since = "1.9.0")]
3964 impl<T: fmt::Debug, P> fmt::Debug for SplitMut<'_, T, P>
3965 where
3966     P: FnMut(&T) -> bool,
3967 {
3968     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
3969         f.debug_struct("SplitMut").field("v", &self.v).field("finished", &self.finished).finish()
3970     }
3971 }
3972
3973 impl<'a, T, P> SplitIter for SplitMut<'a, T, P>
3974 where
3975     P: FnMut(&T) -> bool,
3976 {
3977     #[inline]
3978     fn finish(&mut self) -> Option<&'a mut [T]> {
3979         if self.finished {
3980             None
3981         } else {
3982             self.finished = true;
3983             Some(mem::replace(&mut self.v, &mut []))
3984         }
3985     }
3986 }
3987
3988 #[stable(feature = "rust1", since = "1.0.0")]
3989 impl<'a, T, P> Iterator for SplitMut<'a, T, P>
3990 where
3991     P: FnMut(&T) -> bool,
3992 {
3993     type Item = &'a mut [T];
3994
3995     #[inline]
3996     fn next(&mut self) -> Option<&'a mut [T]> {
3997         if self.finished {
3998             return None;
3999         }
4000
4001         let idx_opt = {
4002             // work around borrowck limitations
4003             let pred = &mut self.pred;
4004             self.v.iter().position(|x| (*pred)(x))
4005         };
4006         match idx_opt {
4007             None => self.finish(),
4008             Some(idx) => {
4009                 let tmp = mem::replace(&mut self.v, &mut []);
4010                 let (head, tail) = tmp.split_at_mut(idx);
4011                 self.v = &mut tail[1..];
4012                 Some(head)
4013             }
4014         }
4015     }
4016
4017     #[inline]
4018     fn size_hint(&self) -> (usize, Option<usize>) {
4019         if self.finished {
4020             (0, Some(0))
4021         } else {
4022             // if the predicate doesn't match anything, we yield one slice
4023             // if it matches every element, we yield len+1 empty slices.
4024             (1, Some(self.v.len() + 1))
4025         }
4026     }
4027 }
4028
4029 #[stable(feature = "rust1", since = "1.0.0")]
4030 impl<'a, T, P> DoubleEndedIterator for SplitMut<'a, T, P>
4031 where
4032     P: FnMut(&T) -> bool,
4033 {
4034     #[inline]
4035     fn next_back(&mut self) -> Option<&'a mut [T]> {
4036         if self.finished {
4037             return None;
4038         }
4039
4040         let idx_opt = {
4041             // work around borrowck limitations
4042             let pred = &mut self.pred;
4043             self.v.iter().rposition(|x| (*pred)(x))
4044         };
4045         match idx_opt {
4046             None => self.finish(),
4047             Some(idx) => {
4048                 let tmp = mem::replace(&mut self.v, &mut []);
4049                 let (head, tail) = tmp.split_at_mut(idx);
4050                 self.v = head;
4051                 Some(&mut tail[1..])
4052             }
4053         }
4054     }
4055 }
4056
4057 #[stable(feature = "fused", since = "1.26.0")]
4058 impl<T, P> FusedIterator for SplitMut<'_, T, P> where P: FnMut(&T) -> bool {}
4059
4060 /// An iterator over the mutable subslices of the vector which are separated
4061 /// by elements that match `pred`. Unlike `SplitMut`, it contains the matched
4062 /// parts in the ends of the subslices.
4063 ///
4064 /// This struct is created by the [`split_inclusive_mut`] method on [slices].
4065 ///
4066 /// [`split_inclusive_mut`]: ../../std/primitive.slice.html#method.split_inclusive_mut
4067 /// [slices]: ../../std/primitive.slice.html
4068 #[unstable(feature = "split_inclusive", issue = "72360")]
4069 pub struct SplitInclusiveMut<'a, T: 'a, P>
4070 where
4071     P: FnMut(&T) -> bool,
4072 {
4073     v: &'a mut [T],
4074     pred: P,
4075     finished: bool,
4076 }
4077
4078 #[unstable(feature = "split_inclusive", issue = "72360")]
4079 impl<T: fmt::Debug, P> fmt::Debug for SplitInclusiveMut<'_, T, P>
4080 where
4081     P: FnMut(&T) -> bool,
4082 {
4083     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4084         f.debug_struct("SplitInclusiveMut")
4085             .field("v", &self.v)
4086             .field("finished", &self.finished)
4087             .finish()
4088     }
4089 }
4090
4091 #[unstable(feature = "split_inclusive", issue = "72360")]
4092 impl<'a, T, P> Iterator for SplitInclusiveMut<'a, T, P>
4093 where
4094     P: FnMut(&T) -> bool,
4095 {
4096     type Item = &'a mut [T];
4097
4098     #[inline]
4099     fn next(&mut self) -> Option<&'a mut [T]> {
4100         if self.finished {
4101             return None;
4102         }
4103
4104         let idx_opt = {
4105             // work around borrowck limitations
4106             let pred = &mut self.pred;
4107             self.v.iter().position(|x| (*pred)(x))
4108         };
4109         let idx = idx_opt.map(|idx| idx + 1).unwrap_or(self.v.len());
4110         if idx == self.v.len() {
4111             self.finished = true;
4112         }
4113         let tmp = mem::replace(&mut self.v, &mut []);
4114         let (head, tail) = tmp.split_at_mut(idx);
4115         self.v = tail;
4116         Some(head)
4117     }
4118
4119     #[inline]
4120     fn size_hint(&self) -> (usize, Option<usize>) {
4121         if self.finished {
4122             (0, Some(0))
4123         } else {
4124             // if the predicate doesn't match anything, we yield one slice
4125             // if it matches every element, we yield len+1 empty slices.
4126             (1, Some(self.v.len() + 1))
4127         }
4128     }
4129 }
4130
4131 #[unstable(feature = "split_inclusive", issue = "72360")]
4132 impl<'a, T, P> DoubleEndedIterator for SplitInclusiveMut<'a, T, P>
4133 where
4134     P: FnMut(&T) -> bool,
4135 {
4136     #[inline]
4137     fn next_back(&mut self) -> Option<&'a mut [T]> {
4138         if self.finished {
4139             return None;
4140         }
4141
4142         let idx_opt = if self.v.is_empty() {
4143             None
4144         } else {
4145             // work around borrowck limitations
4146             let pred = &mut self.pred;
4147
4148             // The last index of self.v is already checked and found to match
4149             // by the last iteration, so we start searching a new match
4150             // one index to the left.
4151             let remainder = &self.v[..(self.v.len() - 1)];
4152             remainder.iter().rposition(|x| (*pred)(x))
4153         };
4154         let idx = idx_opt.map(|idx| idx + 1).unwrap_or(0);
4155         if idx == 0 {
4156             self.finished = true;
4157         }
4158         let tmp = mem::replace(&mut self.v, &mut []);
4159         let (head, tail) = tmp.split_at_mut(idx);
4160         self.v = head;
4161         Some(tail)
4162     }
4163 }
4164
4165 #[unstable(feature = "split_inclusive", issue = "72360")]
4166 impl<T, P> FusedIterator for SplitInclusiveMut<'_, T, P> where P: FnMut(&T) -> bool {}
4167
4168 /// An iterator over subslices separated by elements that match a predicate
4169 /// function, starting from the end of the slice.
4170 ///
4171 /// This struct is created by the [`rsplit`] method on [slices].
4172 ///
4173 /// [`rsplit`]: ../../std/primitive.slice.html#method.rsplit
4174 /// [slices]: ../../std/primitive.slice.html
4175 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4176 #[derive(Clone)] // Is this correct, or does it incorrectly require `T: Clone`?
4177 pub struct RSplit<'a, T: 'a, P>
4178 where
4179     P: FnMut(&T) -> bool,
4180 {
4181     inner: Split<'a, T, P>,
4182 }
4183
4184 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4185 impl<T: fmt::Debug, P> fmt::Debug for RSplit<'_, T, P>
4186 where
4187     P: FnMut(&T) -> bool,
4188 {
4189     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4190         f.debug_struct("RSplit")
4191             .field("v", &self.inner.v)
4192             .field("finished", &self.inner.finished)
4193             .finish()
4194     }
4195 }
4196
4197 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4198 impl<'a, T, P> Iterator for RSplit<'a, T, P>
4199 where
4200     P: FnMut(&T) -> bool,
4201 {
4202     type Item = &'a [T];
4203
4204     #[inline]
4205     fn next(&mut self) -> Option<&'a [T]> {
4206         self.inner.next_back()
4207     }
4208
4209     #[inline]
4210     fn size_hint(&self) -> (usize, Option<usize>) {
4211         self.inner.size_hint()
4212     }
4213 }
4214
4215 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4216 impl<'a, T, P> DoubleEndedIterator for RSplit<'a, T, P>
4217 where
4218     P: FnMut(&T) -> bool,
4219 {
4220     #[inline]
4221     fn next_back(&mut self) -> Option<&'a [T]> {
4222         self.inner.next()
4223     }
4224 }
4225
4226 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4227 impl<'a, T, P> SplitIter for RSplit<'a, T, P>
4228 where
4229     P: FnMut(&T) -> bool,
4230 {
4231     #[inline]
4232     fn finish(&mut self) -> Option<&'a [T]> {
4233         self.inner.finish()
4234     }
4235 }
4236
4237 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4238 impl<T, P> FusedIterator for RSplit<'_, T, P> where P: FnMut(&T) -> bool {}
4239
4240 /// An iterator over the subslices of the vector which are separated
4241 /// by elements that match `pred`, starting from the end of the slice.
4242 ///
4243 /// This struct is created by the [`rsplit_mut`] method on [slices].
4244 ///
4245 /// [`rsplit_mut`]: ../../std/primitive.slice.html#method.rsplit_mut
4246 /// [slices]: ../../std/primitive.slice.html
4247 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4248 pub struct RSplitMut<'a, T: 'a, P>
4249 where
4250     P: FnMut(&T) -> bool,
4251 {
4252     inner: SplitMut<'a, T, P>,
4253 }
4254
4255 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4256 impl<T: fmt::Debug, P> fmt::Debug for RSplitMut<'_, T, P>
4257 where
4258     P: FnMut(&T) -> bool,
4259 {
4260     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4261         f.debug_struct("RSplitMut")
4262             .field("v", &self.inner.v)
4263             .field("finished", &self.inner.finished)
4264             .finish()
4265     }
4266 }
4267
4268 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4269 impl<'a, T, P> SplitIter for RSplitMut<'a, T, P>
4270 where
4271     P: FnMut(&T) -> bool,
4272 {
4273     #[inline]
4274     fn finish(&mut self) -> Option<&'a mut [T]> {
4275         self.inner.finish()
4276     }
4277 }
4278
4279 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4280 impl<'a, T, P> Iterator for RSplitMut<'a, T, P>
4281 where
4282     P: FnMut(&T) -> bool,
4283 {
4284     type Item = &'a mut [T];
4285
4286     #[inline]
4287     fn next(&mut self) -> Option<&'a mut [T]> {
4288         self.inner.next_back()
4289     }
4290
4291     #[inline]
4292     fn size_hint(&self) -> (usize, Option<usize>) {
4293         self.inner.size_hint()
4294     }
4295 }
4296
4297 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4298 impl<'a, T, P> DoubleEndedIterator for RSplitMut<'a, T, P>
4299 where
4300     P: FnMut(&T) -> bool,
4301 {
4302     #[inline]
4303     fn next_back(&mut self) -> Option<&'a mut [T]> {
4304         self.inner.next()
4305     }
4306 }
4307
4308 #[stable(feature = "slice_rsplit", since = "1.27.0")]
4309 impl<T, P> FusedIterator for RSplitMut<'_, T, P> where P: FnMut(&T) -> bool {}
4310
4311 /// An private iterator over subslices separated by elements that
4312 /// match a predicate function, splitting at most a fixed number of
4313 /// times.
4314 #[derive(Debug)]
4315 struct GenericSplitN<I> {
4316     iter: I,
4317     count: usize,
4318 }
4319
4320 impl<T, I: SplitIter<Item = T>> Iterator for GenericSplitN<I> {
4321     type Item = T;
4322
4323     #[inline]
4324     fn next(&mut self) -> Option<T> {
4325         match self.count {
4326             0 => None,
4327             1 => {
4328                 self.count -= 1;
4329                 self.iter.finish()
4330             }
4331             _ => {
4332                 self.count -= 1;
4333                 self.iter.next()
4334             }
4335         }
4336     }
4337
4338     #[inline]
4339     fn size_hint(&self) -> (usize, Option<usize>) {
4340         let (lower, upper_opt) = self.iter.size_hint();
4341         (lower, upper_opt.map(|upper| cmp::min(self.count, upper)))
4342     }
4343 }
4344
4345 /// An iterator over subslices separated by elements that match a predicate
4346 /// function, limited to a given number of splits.
4347 ///
4348 /// This struct is created by the [`splitn`] method on [slices].
4349 ///
4350 /// [`splitn`]: ../../std/primitive.slice.html#method.splitn
4351 /// [slices]: ../../std/primitive.slice.html
4352 #[stable(feature = "rust1", since = "1.0.0")]
4353 pub struct SplitN<'a, T: 'a, P>
4354 where
4355     P: FnMut(&T) -> bool,
4356 {
4357     inner: GenericSplitN<Split<'a, T, P>>,
4358 }
4359
4360 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4361 impl<T: fmt::Debug, P> fmt::Debug for SplitN<'_, T, P>
4362 where
4363     P: FnMut(&T) -> bool,
4364 {
4365     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4366         f.debug_struct("SplitN").field("inner", &self.inner).finish()
4367     }
4368 }
4369
4370 /// An iterator over subslices separated by elements that match a
4371 /// predicate function, limited to a given number of splits, starting
4372 /// from the end of the slice.
4373 ///
4374 /// This struct is created by the [`rsplitn`] method on [slices].
4375 ///
4376 /// [`rsplitn`]: ../../std/primitive.slice.html#method.rsplitn
4377 /// [slices]: ../../std/primitive.slice.html
4378 #[stable(feature = "rust1", since = "1.0.0")]
4379 pub struct RSplitN<'a, T: 'a, P>
4380 where
4381     P: FnMut(&T) -> bool,
4382 {
4383     inner: GenericSplitN<RSplit<'a, T, P>>,
4384 }
4385
4386 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4387 impl<T: fmt::Debug, P> fmt::Debug for RSplitN<'_, T, P>
4388 where
4389     P: FnMut(&T) -> bool,
4390 {
4391     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4392         f.debug_struct("RSplitN").field("inner", &self.inner).finish()
4393     }
4394 }
4395
4396 /// An iterator over subslices separated by elements that match a predicate
4397 /// function, limited to a given number of splits.
4398 ///
4399 /// This struct is created by the [`splitn_mut`] method on [slices].
4400 ///
4401 /// [`splitn_mut`]: ../../std/primitive.slice.html#method.splitn_mut
4402 /// [slices]: ../../std/primitive.slice.html
4403 #[stable(feature = "rust1", since = "1.0.0")]
4404 pub struct SplitNMut<'a, T: 'a, P>
4405 where
4406     P: FnMut(&T) -> bool,
4407 {
4408     inner: GenericSplitN<SplitMut<'a, T, P>>,
4409 }
4410
4411 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4412 impl<T: fmt::Debug, P> fmt::Debug for SplitNMut<'_, T, P>
4413 where
4414     P: FnMut(&T) -> bool,
4415 {
4416     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4417         f.debug_struct("SplitNMut").field("inner", &self.inner).finish()
4418     }
4419 }
4420
4421 /// An iterator over subslices separated by elements that match a
4422 /// predicate function, limited to a given number of splits, starting
4423 /// from the end of the slice.
4424 ///
4425 /// This struct is created by the [`rsplitn_mut`] method on [slices].
4426 ///
4427 /// [`rsplitn_mut`]: ../../std/primitive.slice.html#method.rsplitn_mut
4428 /// [slices]: ../../std/primitive.slice.html
4429 #[stable(feature = "rust1", since = "1.0.0")]
4430 pub struct RSplitNMut<'a, T: 'a, P>
4431 where
4432     P: FnMut(&T) -> bool,
4433 {
4434     inner: GenericSplitN<RSplitMut<'a, T, P>>,
4435 }
4436
4437 #[stable(feature = "core_impl_debug", since = "1.9.0")]
4438 impl<T: fmt::Debug, P> fmt::Debug for RSplitNMut<'_, T, P>
4439 where
4440     P: FnMut(&T) -> bool,
4441 {
4442     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
4443         f.debug_struct("RSplitNMut").field("inner", &self.inner).finish()
4444     }
4445 }
4446
4447 macro_rules! forward_iterator {
4448     ($name:ident: $elem:ident, $iter_of:ty) => {
4449         #[stable(feature = "rust1", since = "1.0.0")]
4450         impl<'a, $elem, P> Iterator for $name<'a, $elem, P>
4451         where
4452             P: FnMut(&T) -> bool,
4453         {
4454             type Item = $iter_of;
4455
4456             #[inline]
4457             fn next(&mut self) -> Option<$iter_of> {
4458                 self.inner.next()
4459             }
4460
4461             #[inline]
4462             fn size_hint(&self) -> (usize, Option<usize>) {
4463                 self.inner.size_hint()
4464             }
4465         }
4466
4467         #[stable(feature = "fused", since = "1.26.0")]
4468         impl<'a, $elem, P> FusedIterator for $name<'a, $elem, P> where P: FnMut(&T) -> bool {}
4469     };
4470 }
4471
4472 forward_iterator! { SplitN: T, &'a [T] }
4473 forward_iterator! { RSplitN: T, &'a [T] }
4474 forward_iterator! { SplitNMut: T, &'a mut [T] }
4475 forward_iterator! { RSplitNMut: T, &'a mut [T] }
4476
4477 /// An iterator over overlapping subslices of length `size`.
4478 ///
4479 /// This struct is created by the [`windows`] method on [slices].
4480 ///
4481 /// [`windows`]: ../../std/primitive.slice.html#method.windows
4482 /// [slices]: ../../std/primitive.slice.html
4483 #[derive(Debug)]
4484 #[stable(feature = "rust1", since = "1.0.0")]
4485 pub struct Windows<'a, T: 'a> {
4486     v: &'a [T],
4487     size: usize,
4488 }
4489
4490 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
4491 #[stable(feature = "rust1", since = "1.0.0")]
4492 impl<T> Clone for Windows<'_, T> {
4493     fn clone(&self) -> Self {
4494         Windows { v: self.v, size: self.size }
4495     }
4496 }
4497
4498 #[stable(feature = "rust1", since = "1.0.0")]
4499 impl<'a, T> Iterator for Windows<'a, T> {
4500     type Item = &'a [T];
4501
4502     #[inline]
4503     fn next(&mut self) -> Option<&'a [T]> {
4504         if self.size > self.v.len() {
4505             None
4506         } else {
4507             let ret = Some(&self.v[..self.size]);
4508             self.v = &self.v[1..];
4509             ret
4510         }
4511     }
4512
4513     #[inline]
4514     fn size_hint(&self) -> (usize, Option<usize>) {
4515         if self.size > self.v.len() {
4516             (0, Some(0))
4517         } else {
4518             let size = self.v.len() - self.size + 1;
4519             (size, Some(size))
4520         }
4521     }
4522
4523     #[inline]
4524     fn count(self) -> usize {
4525         self.len()
4526     }
4527
4528     #[inline]
4529     fn nth(&mut self, n: usize) -> Option<Self::Item> {
4530         let (end, overflow) = self.size.overflowing_add(n);
4531         if end > self.v.len() || overflow {
4532             self.v = &[];
4533             None
4534         } else {
4535             let nth = &self.v[n..end];
4536             self.v = &self.v[n + 1..];
4537             Some(nth)
4538         }
4539     }
4540
4541     #[inline]
4542     fn last(self) -> Option<Self::Item> {
4543         if self.size > self.v.len() {
4544             None
4545         } else {
4546             let start = self.v.len() - self.size;
4547             Some(&self.v[start..])
4548         }
4549     }
4550 }
4551
4552 #[stable(feature = "rust1", since = "1.0.0")]
4553 impl<'a, T> DoubleEndedIterator for Windows<'a, T> {
4554     #[inline]
4555     fn next_back(&mut self) -> Option<&'a [T]> {
4556         if self.size > self.v.len() {
4557             None
4558         } else {
4559             let ret = Some(&self.v[self.v.len() - self.size..]);
4560             self.v = &self.v[..self.v.len() - 1];
4561             ret
4562         }
4563     }
4564
4565     #[inline]
4566     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
4567         let (end, overflow) = self.v.len().overflowing_sub(n);
4568         if end < self.size || overflow {
4569             self.v = &[];
4570             None
4571         } else {
4572             let ret = &self.v[end - self.size..end];
4573             self.v = &self.v[..end - 1];
4574             Some(ret)
4575         }
4576     }
4577 }
4578
4579 #[stable(feature = "rust1", since = "1.0.0")]
4580 impl<T> ExactSizeIterator for Windows<'_, T> {}
4581
4582 #[unstable(feature = "trusted_len", issue = "37572")]
4583 unsafe impl<T> TrustedLen for Windows<'_, T> {}
4584
4585 #[stable(feature = "fused", since = "1.26.0")]
4586 impl<T> FusedIterator for Windows<'_, T> {}
4587
4588 #[doc(hidden)]
4589 unsafe impl<'a, T> TrustedRandomAccess for Windows<'a, T> {
4590     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
4591         from_raw_parts(self.v.as_ptr().add(i), self.size)
4592     }
4593     fn may_have_side_effect() -> bool {
4594         false
4595     }
4596 }
4597
4598 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
4599 /// time), starting at the beginning of the slice.
4600 ///
4601 /// When the slice len is not evenly divided by the chunk size, the last slice
4602 /// of the iteration will be the remainder.
4603 ///
4604 /// This struct is created by the [`chunks`] method on [slices].
4605 ///
4606 /// [`chunks`]: ../../std/primitive.slice.html#method.chunks
4607 /// [slices]: ../../std/primitive.slice.html
4608 #[derive(Debug)]
4609 #[stable(feature = "rust1", since = "1.0.0")]
4610 pub struct Chunks<'a, T: 'a> {
4611     v: &'a [T],
4612     chunk_size: usize,
4613 }
4614
4615 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
4616 #[stable(feature = "rust1", since = "1.0.0")]
4617 impl<T> Clone for Chunks<'_, T> {
4618     fn clone(&self) -> Self {
4619         Chunks { v: self.v, chunk_size: self.chunk_size }
4620     }
4621 }
4622
4623 #[stable(feature = "rust1", since = "1.0.0")]
4624 impl<'a, T> Iterator for Chunks<'a, T> {
4625     type Item = &'a [T];
4626
4627     #[inline]
4628     fn next(&mut self) -> Option<&'a [T]> {
4629         if self.v.is_empty() {
4630             None
4631         } else {
4632             let chunksz = cmp::min(self.v.len(), self.chunk_size);
4633             let (fst, snd) = self.v.split_at(chunksz);
4634             self.v = snd;
4635             Some(fst)
4636         }
4637     }
4638
4639     #[inline]
4640     fn size_hint(&self) -> (usize, Option<usize>) {
4641         if self.v.is_empty() {
4642             (0, Some(0))
4643         } else {
4644             let n = self.v.len() / self.chunk_size;
4645             let rem = self.v.len() % self.chunk_size;
4646             let n = if rem > 0 { n + 1 } else { n };
4647             (n, Some(n))
4648         }
4649     }
4650
4651     #[inline]
4652     fn count(self) -> usize {
4653         self.len()
4654     }
4655
4656     #[inline]
4657     fn nth(&mut self, n: usize) -> Option<Self::Item> {
4658         let (start, overflow) = n.overflowing_mul(self.chunk_size);
4659         if start >= self.v.len() || overflow {
4660             self.v = &[];
4661             None
4662         } else {
4663             let end = match start.checked_add(self.chunk_size) {
4664                 Some(sum) => cmp::min(self.v.len(), sum),
4665                 None => self.v.len(),
4666             };
4667             let nth = &self.v[start..end];
4668             self.v = &self.v[end..];
4669             Some(nth)
4670         }
4671     }
4672
4673     #[inline]
4674     fn last(self) -> Option<Self::Item> {
4675         if self.v.is_empty() {
4676             None
4677         } else {
4678             let start = (self.v.len() - 1) / self.chunk_size * self.chunk_size;
4679             Some(&self.v[start..])
4680         }
4681     }
4682 }
4683
4684 #[stable(feature = "rust1", since = "1.0.0")]
4685 impl<'a, T> DoubleEndedIterator for Chunks<'a, T> {
4686     #[inline]
4687     fn next_back(&mut self) -> Option<&'a [T]> {
4688         if self.v.is_empty() {
4689             None
4690         } else {
4691             let remainder = self.v.len() % self.chunk_size;
4692             let chunksz = if remainder != 0 { remainder } else { self.chunk_size };
4693             let (fst, snd) = self.v.split_at(self.v.len() - chunksz);
4694             self.v = fst;
4695             Some(snd)
4696         }
4697     }
4698
4699     #[inline]
4700     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
4701         let len = self.len();
4702         if n >= len {
4703             self.v = &[];
4704             None
4705         } else {
4706             let start = (len - 1 - n) * self.chunk_size;
4707             let end = match start.checked_add(self.chunk_size) {
4708                 Some(res) => cmp::min(res, self.v.len()),
4709                 None => self.v.len(),
4710             };
4711             let nth_back = &self.v[start..end];
4712             self.v = &self.v[..start];
4713             Some(nth_back)
4714         }
4715     }
4716 }
4717
4718 #[stable(feature = "rust1", since = "1.0.0")]
4719 impl<T> ExactSizeIterator for Chunks<'_, T> {}
4720
4721 #[unstable(feature = "trusted_len", issue = "37572")]
4722 unsafe impl<T> TrustedLen for Chunks<'_, T> {}
4723
4724 #[stable(feature = "fused", since = "1.26.0")]
4725 impl<T> FusedIterator for Chunks<'_, T> {}
4726
4727 #[doc(hidden)]
4728 unsafe impl<'a, T> TrustedRandomAccess for Chunks<'a, T> {
4729     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
4730         let start = i * self.chunk_size;
4731         let end = match start.checked_add(self.chunk_size) {
4732             None => self.v.len(),
4733             Some(end) => cmp::min(end, self.v.len()),
4734         };
4735         from_raw_parts(self.v.as_ptr().add(start), end - start)
4736     }
4737     fn may_have_side_effect() -> bool {
4738         false
4739     }
4740 }
4741
4742 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
4743 /// elements at a time), starting at the beginning of the slice.
4744 ///
4745 /// When the slice len is not evenly divided by the chunk size, the last slice
4746 /// of the iteration will be the remainder.
4747 ///
4748 /// This struct is created by the [`chunks_mut`] method on [slices].
4749 ///
4750 /// [`chunks_mut`]: ../../std/primitive.slice.html#method.chunks_mut
4751 /// [slices]: ../../std/primitive.slice.html
4752 #[derive(Debug)]
4753 #[stable(feature = "rust1", since = "1.0.0")]
4754 pub struct ChunksMut<'a, T: 'a> {
4755     v: &'a mut [T],
4756     chunk_size: usize,
4757 }
4758
4759 #[stable(feature = "rust1", since = "1.0.0")]
4760 impl<'a, T> Iterator for ChunksMut<'a, T> {
4761     type Item = &'a mut [T];
4762
4763     #[inline]
4764     fn next(&mut self) -> Option<&'a mut [T]> {
4765         if self.v.is_empty() {
4766             None
4767         } else {
4768             let sz = cmp::min(self.v.len(), self.chunk_size);
4769             let tmp = mem::replace(&mut self.v, &mut []);
4770             let (head, tail) = tmp.split_at_mut(sz);
4771             self.v = tail;
4772             Some(head)
4773         }
4774     }
4775
4776     #[inline]
4777     fn size_hint(&self) -> (usize, Option<usize>) {
4778         if self.v.is_empty() {
4779             (0, Some(0))
4780         } else {
4781             let n = self.v.len() / self.chunk_size;
4782             let rem = self.v.len() % self.chunk_size;
4783             let n = if rem > 0 { n + 1 } else { n };
4784             (n, Some(n))
4785         }
4786     }
4787
4788     #[inline]
4789     fn count(self) -> usize {
4790         self.len()
4791     }
4792
4793     #[inline]
4794     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
4795         let (start, overflow) = n.overflowing_mul(self.chunk_size);
4796         if start >= self.v.len() || overflow {
4797             self.v = &mut [];
4798             None
4799         } else {
4800             let end = match start.checked_add(self.chunk_size) {
4801                 Some(sum) => cmp::min(self.v.len(), sum),
4802                 None => self.v.len(),
4803             };
4804             let tmp = mem::replace(&mut self.v, &mut []);
4805             let (head, tail) = tmp.split_at_mut(end);
4806             let (_, nth) = head.split_at_mut(start);
4807             self.v = tail;
4808             Some(nth)
4809         }
4810     }
4811
4812     #[inline]
4813     fn last(self) -> Option<Self::Item> {
4814         if self.v.is_empty() {
4815             None
4816         } else {
4817             let start = (self.v.len() - 1) / self.chunk_size * self.chunk_size;
4818             Some(&mut self.v[start..])
4819         }
4820     }
4821 }
4822
4823 #[stable(feature = "rust1", since = "1.0.0")]
4824 impl<'a, T> DoubleEndedIterator for ChunksMut<'a, T> {
4825     #[inline]
4826     fn next_back(&mut self) -> Option<&'a mut [T]> {
4827         if self.v.is_empty() {
4828             None
4829         } else {
4830             let remainder = self.v.len() % self.chunk_size;
4831             let sz = if remainder != 0 { remainder } else { self.chunk_size };
4832             let tmp = mem::replace(&mut self.v, &mut []);
4833             let tmp_len = tmp.len();
4834             let (head, tail) = tmp.split_at_mut(tmp_len - sz);
4835             self.v = head;
4836             Some(tail)
4837         }
4838     }
4839
4840     #[inline]
4841     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
4842         let len = self.len();
4843         if n >= len {
4844             self.v = &mut [];
4845             None
4846         } else {
4847             let start = (len - 1 - n) * self.chunk_size;
4848             let end = match start.checked_add(self.chunk_size) {
4849                 Some(res) => cmp::min(res, self.v.len()),
4850                 None => self.v.len(),
4851             };
4852             let (temp, _tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
4853             let (head, nth_back) = temp.split_at_mut(start);
4854             self.v = head;
4855             Some(nth_back)
4856         }
4857     }
4858 }
4859
4860 #[stable(feature = "rust1", since = "1.0.0")]
4861 impl<T> ExactSizeIterator for ChunksMut<'_, T> {}
4862
4863 #[unstable(feature = "trusted_len", issue = "37572")]
4864 unsafe impl<T> TrustedLen for ChunksMut<'_, T> {}
4865
4866 #[stable(feature = "fused", since = "1.26.0")]
4867 impl<T> FusedIterator for ChunksMut<'_, T> {}
4868
4869 #[doc(hidden)]
4870 unsafe impl<'a, T> TrustedRandomAccess for ChunksMut<'a, T> {
4871     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
4872         let start = i * self.chunk_size;
4873         let end = match start.checked_add(self.chunk_size) {
4874             None => self.v.len(),
4875             Some(end) => cmp::min(end, self.v.len()),
4876         };
4877         from_raw_parts_mut(self.v.as_mut_ptr().add(start), end - start)
4878     }
4879     fn may_have_side_effect() -> bool {
4880         false
4881     }
4882 }
4883
4884 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
4885 /// time), starting at the beginning of the slice.
4886 ///
4887 /// When the slice len is not evenly divided by the chunk size, the last
4888 /// up to `chunk_size-1` elements will be omitted but can be retrieved from
4889 /// the [`remainder`] function from the iterator.
4890 ///
4891 /// This struct is created by the [`chunks_exact`] method on [slices].
4892 ///
4893 /// [`chunks_exact`]: ../../std/primitive.slice.html#method.chunks_exact
4894 /// [`remainder`]: ../../std/slice/struct.ChunksExact.html#method.remainder
4895 /// [slices]: ../../std/primitive.slice.html
4896 #[derive(Debug)]
4897 #[stable(feature = "chunks_exact", since = "1.31.0")]
4898 pub struct ChunksExact<'a, T: 'a> {
4899     v: &'a [T],
4900     rem: &'a [T],
4901     chunk_size: usize,
4902 }
4903
4904 impl<'a, T> ChunksExact<'a, T> {
4905     /// Returns the remainder of the original slice that is not going to be
4906     /// returned by the iterator. The returned slice has at most `chunk_size-1`
4907     /// elements.
4908     #[stable(feature = "chunks_exact", since = "1.31.0")]
4909     pub fn remainder(&self) -> &'a [T] {
4910         self.rem
4911     }
4912 }
4913
4914 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
4915 #[stable(feature = "chunks_exact", since = "1.31.0")]
4916 impl<T> Clone for ChunksExact<'_, T> {
4917     fn clone(&self) -> Self {
4918         ChunksExact { v: self.v, rem: self.rem, chunk_size: self.chunk_size }
4919     }
4920 }
4921
4922 #[stable(feature = "chunks_exact", since = "1.31.0")]
4923 impl<'a, T> Iterator for ChunksExact<'a, T> {
4924     type Item = &'a [T];
4925
4926     #[inline]
4927     fn next(&mut self) -> Option<&'a [T]> {
4928         if self.v.len() < self.chunk_size {
4929             None
4930         } else {
4931             let (fst, snd) = self.v.split_at(self.chunk_size);
4932             self.v = snd;
4933             Some(fst)
4934         }
4935     }
4936
4937     #[inline]
4938     fn size_hint(&self) -> (usize, Option<usize>) {
4939         let n = self.v.len() / self.chunk_size;
4940         (n, Some(n))
4941     }
4942
4943     #[inline]
4944     fn count(self) -> usize {
4945         self.len()
4946     }
4947
4948     #[inline]
4949     fn nth(&mut self, n: usize) -> Option<Self::Item> {
4950         let (start, overflow) = n.overflowing_mul(self.chunk_size);
4951         if start >= self.v.len() || overflow {
4952             self.v = &[];
4953             None
4954         } else {
4955             let (_, snd) = self.v.split_at(start);
4956             self.v = snd;
4957             self.next()
4958         }
4959     }
4960
4961     #[inline]
4962     fn last(mut self) -> Option<Self::Item> {
4963         self.next_back()
4964     }
4965 }
4966
4967 #[stable(feature = "chunks_exact", since = "1.31.0")]
4968 impl<'a, T> DoubleEndedIterator for ChunksExact<'a, T> {
4969     #[inline]
4970     fn next_back(&mut self) -> Option<&'a [T]> {
4971         if self.v.len() < self.chunk_size {
4972             None
4973         } else {
4974             let (fst, snd) = self.v.split_at(self.v.len() - self.chunk_size);
4975             self.v = fst;
4976             Some(snd)
4977         }
4978     }
4979
4980     #[inline]
4981     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
4982         let len = self.len();
4983         if n >= len {
4984             self.v = &[];
4985             None
4986         } else {
4987             let start = (len - 1 - n) * self.chunk_size;
4988             let end = start + self.chunk_size;
4989             let nth_back = &self.v[start..end];
4990             self.v = &self.v[..start];
4991             Some(nth_back)
4992         }
4993     }
4994 }
4995
4996 #[stable(feature = "chunks_exact", since = "1.31.0")]
4997 impl<T> ExactSizeIterator for ChunksExact<'_, T> {
4998     fn is_empty(&self) -> bool {
4999         self.v.is_empty()
5000     }
5001 }
5002
5003 #[unstable(feature = "trusted_len", issue = "37572")]
5004 unsafe impl<T> TrustedLen for ChunksExact<'_, T> {}
5005
5006 #[stable(feature = "chunks_exact", since = "1.31.0")]
5007 impl<T> FusedIterator for ChunksExact<'_, T> {}
5008
5009 #[doc(hidden)]
5010 #[stable(feature = "chunks_exact", since = "1.31.0")]
5011 unsafe impl<'a, T> TrustedRandomAccess for ChunksExact<'a, T> {
5012     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
5013         let start = i * self.chunk_size;
5014         from_raw_parts(self.v.as_ptr().add(start), self.chunk_size)
5015     }
5016     fn may_have_side_effect() -> bool {
5017         false
5018     }
5019 }
5020
5021 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
5022 /// elements at a time), starting at the beginning of the slice.
5023 ///
5024 /// When the slice len is not evenly divided by the chunk size, the last up to
5025 /// `chunk_size-1` elements will be omitted but can be retrieved from the
5026 /// [`into_remainder`] function from the iterator.
5027 ///
5028 /// This struct is created by the [`chunks_exact_mut`] method on [slices].
5029 ///
5030 /// [`chunks_exact_mut`]: ../../std/primitive.slice.html#method.chunks_exact_mut
5031 /// [`into_remainder`]: ../../std/slice/struct.ChunksExactMut.html#method.into_remainder
5032 /// [slices]: ../../std/primitive.slice.html
5033 #[derive(Debug)]
5034 #[stable(feature = "chunks_exact", since = "1.31.0")]
5035 pub struct ChunksExactMut<'a, T: 'a> {
5036     v: &'a mut [T],
5037     rem: &'a mut [T],
5038     chunk_size: usize,
5039 }
5040
5041 impl<'a, T> ChunksExactMut<'a, T> {
5042     /// Returns the remainder of the original slice that is not going to be
5043     /// returned by the iterator. The returned slice has at most `chunk_size-1`
5044     /// elements.
5045     #[stable(feature = "chunks_exact", since = "1.31.0")]
5046     pub fn into_remainder(self) -> &'a mut [T] {
5047         self.rem
5048     }
5049 }
5050
5051 #[stable(feature = "chunks_exact", since = "1.31.0")]
5052 impl<'a, T> Iterator for ChunksExactMut<'a, T> {
5053     type Item = &'a mut [T];
5054
5055     #[inline]
5056     fn next(&mut self) -> Option<&'a mut [T]> {
5057         if self.v.len() < self.chunk_size {
5058             None
5059         } else {
5060             let tmp = mem::replace(&mut self.v, &mut []);
5061             let (head, tail) = tmp.split_at_mut(self.chunk_size);
5062             self.v = tail;
5063             Some(head)
5064         }
5065     }
5066
5067     #[inline]
5068     fn size_hint(&self) -> (usize, Option<usize>) {
5069         let n = self.v.len() / self.chunk_size;
5070         (n, Some(n))
5071     }
5072
5073     #[inline]
5074     fn count(self) -> usize {
5075         self.len()
5076     }
5077
5078     #[inline]
5079     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
5080         let (start, overflow) = n.overflowing_mul(self.chunk_size);
5081         if start >= self.v.len() || overflow {
5082             self.v = &mut [];
5083             None
5084         } else {
5085             let tmp = mem::replace(&mut self.v, &mut []);
5086             let (_, snd) = tmp.split_at_mut(start);
5087             self.v = snd;
5088             self.next()
5089         }
5090     }
5091
5092     #[inline]
5093     fn last(mut self) -> Option<Self::Item> {
5094         self.next_back()
5095     }
5096 }
5097
5098 #[stable(feature = "chunks_exact", since = "1.31.0")]
5099 impl<'a, T> DoubleEndedIterator for ChunksExactMut<'a, T> {
5100     #[inline]
5101     fn next_back(&mut self) -> Option<&'a mut [T]> {
5102         if self.v.len() < self.chunk_size {
5103             None
5104         } else {
5105             let tmp = mem::replace(&mut self.v, &mut []);
5106             let tmp_len = tmp.len();
5107             let (head, tail) = tmp.split_at_mut(tmp_len - self.chunk_size);
5108             self.v = head;
5109             Some(tail)
5110         }
5111     }
5112
5113     #[inline]
5114     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5115         let len = self.len();
5116         if n >= len {
5117             self.v = &mut [];
5118             None
5119         } else {
5120             let start = (len - 1 - n) * self.chunk_size;
5121             let end = start + self.chunk_size;
5122             let (temp, _tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
5123             let (head, nth_back) = temp.split_at_mut(start);
5124             self.v = head;
5125             Some(nth_back)
5126         }
5127     }
5128 }
5129
5130 #[stable(feature = "chunks_exact", since = "1.31.0")]
5131 impl<T> ExactSizeIterator for ChunksExactMut<'_, T> {
5132     fn is_empty(&self) -> bool {
5133         self.v.is_empty()
5134     }
5135 }
5136
5137 #[unstable(feature = "trusted_len", issue = "37572")]
5138 unsafe impl<T> TrustedLen for ChunksExactMut<'_, T> {}
5139
5140 #[stable(feature = "chunks_exact", since = "1.31.0")]
5141 impl<T> FusedIterator for ChunksExactMut<'_, T> {}
5142
5143 #[doc(hidden)]
5144 #[stable(feature = "chunks_exact", since = "1.31.0")]
5145 unsafe impl<'a, T> TrustedRandomAccess for ChunksExactMut<'a, T> {
5146     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
5147         let start = i * self.chunk_size;
5148         from_raw_parts_mut(self.v.as_mut_ptr().add(start), self.chunk_size)
5149     }
5150     fn may_have_side_effect() -> bool {
5151         false
5152     }
5153 }
5154
5155 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
5156 /// time), starting at the end of the slice.
5157 ///
5158 /// When the slice len is not evenly divided by the chunk size, the last slice
5159 /// of the iteration will be the remainder.
5160 ///
5161 /// This struct is created by the [`rchunks`] method on [slices].
5162 ///
5163 /// [`rchunks`]: ../../std/primitive.slice.html#method.rchunks
5164 /// [slices]: ../../std/primitive.slice.html
5165 #[derive(Debug)]
5166 #[stable(feature = "rchunks", since = "1.31.0")]
5167 pub struct RChunks<'a, T: 'a> {
5168     v: &'a [T],
5169     chunk_size: usize,
5170 }
5171
5172 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
5173 #[stable(feature = "rchunks", since = "1.31.0")]
5174 impl<T> Clone for RChunks<'_, T> {
5175     fn clone(&self) -> Self {
5176         RChunks { v: self.v, chunk_size: self.chunk_size }
5177     }
5178 }
5179
5180 #[stable(feature = "rchunks", since = "1.31.0")]
5181 impl<'a, T> Iterator for RChunks<'a, T> {
5182     type Item = &'a [T];
5183
5184     #[inline]
5185     fn next(&mut self) -> Option<&'a [T]> {
5186         if self.v.is_empty() {
5187             None
5188         } else {
5189             let chunksz = cmp::min(self.v.len(), self.chunk_size);
5190             let (fst, snd) = self.v.split_at(self.v.len() - chunksz);
5191             self.v = fst;
5192             Some(snd)
5193         }
5194     }
5195
5196     #[inline]
5197     fn size_hint(&self) -> (usize, Option<usize>) {
5198         if self.v.is_empty() {
5199             (0, Some(0))
5200         } else {
5201             let n = self.v.len() / self.chunk_size;
5202             let rem = self.v.len() % self.chunk_size;
5203             let n = if rem > 0 { n + 1 } else { n };
5204             (n, Some(n))
5205         }
5206     }
5207
5208     #[inline]
5209     fn count(self) -> usize {
5210         self.len()
5211     }
5212
5213     #[inline]
5214     fn nth(&mut self, n: usize) -> Option<Self::Item> {
5215         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5216         if end >= self.v.len() || overflow {
5217             self.v = &[];
5218             None
5219         } else {
5220             // Can't underflow because of the check above
5221             let end = self.v.len() - end;
5222             let start = match end.checked_sub(self.chunk_size) {
5223                 Some(sum) => sum,
5224                 None => 0,
5225             };
5226             let nth = &self.v[start..end];
5227             self.v = &self.v[0..start];
5228             Some(nth)
5229         }
5230     }
5231
5232     #[inline]
5233     fn last(self) -> Option<Self::Item> {
5234         if self.v.is_empty() {
5235             None
5236         } else {
5237             let rem = self.v.len() % self.chunk_size;
5238             let end = if rem == 0 { self.chunk_size } else { rem };
5239             Some(&self.v[0..end])
5240         }
5241     }
5242 }
5243
5244 #[stable(feature = "rchunks", since = "1.31.0")]
5245 impl<'a, T> DoubleEndedIterator for RChunks<'a, T> {
5246     #[inline]
5247     fn next_back(&mut self) -> Option<&'a [T]> {
5248         if self.v.is_empty() {
5249             None
5250         } else {
5251             let remainder = self.v.len() % self.chunk_size;
5252             let chunksz = if remainder != 0 { remainder } else { self.chunk_size };
5253             let (fst, snd) = self.v.split_at(chunksz);
5254             self.v = snd;
5255             Some(fst)
5256         }
5257     }
5258
5259     #[inline]
5260     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5261         let len = self.len();
5262         if n >= len {
5263             self.v = &[];
5264             None
5265         } else {
5266             // can't underflow because `n < len`
5267             let offset_from_end = (len - 1 - n) * self.chunk_size;
5268             let end = self.v.len() - offset_from_end;
5269             let start = end.saturating_sub(self.chunk_size);
5270             let nth_back = &self.v[start..end];
5271             self.v = &self.v[end..];
5272             Some(nth_back)
5273         }
5274     }
5275 }
5276
5277 #[stable(feature = "rchunks", since = "1.31.0")]
5278 impl<T> ExactSizeIterator for RChunks<'_, T> {}
5279
5280 #[unstable(feature = "trusted_len", issue = "37572")]
5281 unsafe impl<T> TrustedLen for RChunks<'_, T> {}
5282
5283 #[stable(feature = "rchunks", since = "1.31.0")]
5284 impl<T> FusedIterator for RChunks<'_, T> {}
5285
5286 #[doc(hidden)]
5287 #[stable(feature = "rchunks", since = "1.31.0")]
5288 unsafe impl<'a, T> TrustedRandomAccess for RChunks<'a, T> {
5289     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
5290         let end = self.v.len() - i * self.chunk_size;
5291         let start = match end.checked_sub(self.chunk_size) {
5292             None => 0,
5293             Some(start) => start,
5294         };
5295         from_raw_parts(self.v.as_ptr().add(start), end - start)
5296     }
5297     fn may_have_side_effect() -> bool {
5298         false
5299     }
5300 }
5301
5302 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
5303 /// elements at a time), starting at the end of the slice.
5304 ///
5305 /// When the slice len is not evenly divided by the chunk size, the last slice
5306 /// of the iteration will be the remainder.
5307 ///
5308 /// This struct is created by the [`rchunks_mut`] method on [slices].
5309 ///
5310 /// [`rchunks_mut`]: ../../std/primitive.slice.html#method.rchunks_mut
5311 /// [slices]: ../../std/primitive.slice.html
5312 #[derive(Debug)]
5313 #[stable(feature = "rchunks", since = "1.31.0")]
5314 pub struct RChunksMut<'a, T: 'a> {
5315     v: &'a mut [T],
5316     chunk_size: usize,
5317 }
5318
5319 #[stable(feature = "rchunks", since = "1.31.0")]
5320 impl<'a, T> Iterator for RChunksMut<'a, T> {
5321     type Item = &'a mut [T];
5322
5323     #[inline]
5324     fn next(&mut self) -> Option<&'a mut [T]> {
5325         if self.v.is_empty() {
5326             None
5327         } else {
5328             let sz = cmp::min(self.v.len(), self.chunk_size);
5329             let tmp = mem::replace(&mut self.v, &mut []);
5330             let tmp_len = tmp.len();
5331             let (head, tail) = tmp.split_at_mut(tmp_len - sz);
5332             self.v = head;
5333             Some(tail)
5334         }
5335     }
5336
5337     #[inline]
5338     fn size_hint(&self) -> (usize, Option<usize>) {
5339         if self.v.is_empty() {
5340             (0, Some(0))
5341         } else {
5342             let n = self.v.len() / self.chunk_size;
5343             let rem = self.v.len() % self.chunk_size;
5344             let n = if rem > 0 { n + 1 } else { n };
5345             (n, Some(n))
5346         }
5347     }
5348
5349     #[inline]
5350     fn count(self) -> usize {
5351         self.len()
5352     }
5353
5354     #[inline]
5355     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
5356         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5357         if end >= self.v.len() || overflow {
5358             self.v = &mut [];
5359             None
5360         } else {
5361             // Can't underflow because of the check above
5362             let end = self.v.len() - end;
5363             let start = match end.checked_sub(self.chunk_size) {
5364                 Some(sum) => sum,
5365                 None => 0,
5366             };
5367             let tmp = mem::replace(&mut self.v, &mut []);
5368             let (head, tail) = tmp.split_at_mut(start);
5369             let (nth, _) = tail.split_at_mut(end - start);
5370             self.v = head;
5371             Some(nth)
5372         }
5373     }
5374
5375     #[inline]
5376     fn last(self) -> Option<Self::Item> {
5377         if self.v.is_empty() {
5378             None
5379         } else {
5380             let rem = self.v.len() % self.chunk_size;
5381             let end = if rem == 0 { self.chunk_size } else { rem };
5382             Some(&mut self.v[0..end])
5383         }
5384     }
5385 }
5386
5387 #[stable(feature = "rchunks", since = "1.31.0")]
5388 impl<'a, T> DoubleEndedIterator for RChunksMut<'a, T> {
5389     #[inline]
5390     fn next_back(&mut self) -> Option<&'a mut [T]> {
5391         if self.v.is_empty() {
5392             None
5393         } else {
5394             let remainder = self.v.len() % self.chunk_size;
5395             let sz = if remainder != 0 { remainder } else { self.chunk_size };
5396             let tmp = mem::replace(&mut self.v, &mut []);
5397             let (head, tail) = tmp.split_at_mut(sz);
5398             self.v = tail;
5399             Some(head)
5400         }
5401     }
5402
5403     #[inline]
5404     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5405         let len = self.len();
5406         if n >= len {
5407             self.v = &mut [];
5408             None
5409         } else {
5410             // can't underflow because `n < len`
5411             let offset_from_end = (len - 1 - n) * self.chunk_size;
5412             let end = self.v.len() - offset_from_end;
5413             let start = end.saturating_sub(self.chunk_size);
5414             let (tmp, tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
5415             let (_, nth_back) = tmp.split_at_mut(start);
5416             self.v = tail;
5417             Some(nth_back)
5418         }
5419     }
5420 }
5421
5422 #[stable(feature = "rchunks", since = "1.31.0")]
5423 impl<T> ExactSizeIterator for RChunksMut<'_, T> {}
5424
5425 #[unstable(feature = "trusted_len", issue = "37572")]
5426 unsafe impl<T> TrustedLen for RChunksMut<'_, T> {}
5427
5428 #[stable(feature = "rchunks", since = "1.31.0")]
5429 impl<T> FusedIterator for RChunksMut<'_, T> {}
5430
5431 #[doc(hidden)]
5432 #[stable(feature = "rchunks", since = "1.31.0")]
5433 unsafe impl<'a, T> TrustedRandomAccess for RChunksMut<'a, T> {
5434     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
5435         let end = self.v.len() - i * self.chunk_size;
5436         let start = match end.checked_sub(self.chunk_size) {
5437             None => 0,
5438             Some(start) => start,
5439         };
5440         from_raw_parts_mut(self.v.as_mut_ptr().add(start), end - start)
5441     }
5442     fn may_have_side_effect() -> bool {
5443         false
5444     }
5445 }
5446
5447 /// An iterator over a slice in (non-overlapping) chunks (`chunk_size` elements at a
5448 /// time), starting at the end of the slice.
5449 ///
5450 /// When the slice len is not evenly divided by the chunk size, the last
5451 /// up to `chunk_size-1` elements will be omitted but can be retrieved from
5452 /// the [`remainder`] function from the iterator.
5453 ///
5454 /// This struct is created by the [`rchunks_exact`] method on [slices].
5455 ///
5456 /// [`rchunks_exact`]: ../../std/primitive.slice.html#method.rchunks_exact
5457 /// [`remainder`]: ../../std/slice/struct.ChunksExact.html#method.remainder
5458 /// [slices]: ../../std/primitive.slice.html
5459 #[derive(Debug)]
5460 #[stable(feature = "rchunks", since = "1.31.0")]
5461 pub struct RChunksExact<'a, T: 'a> {
5462     v: &'a [T],
5463     rem: &'a [T],
5464     chunk_size: usize,
5465 }
5466
5467 impl<'a, T> RChunksExact<'a, T> {
5468     /// Returns the remainder of the original slice that is not going to be
5469     /// returned by the iterator. The returned slice has at most `chunk_size-1`
5470     /// elements.
5471     #[stable(feature = "rchunks", since = "1.31.0")]
5472     pub fn remainder(&self) -> &'a [T] {
5473         self.rem
5474     }
5475 }
5476
5477 // FIXME(#26925) Remove in favor of `#[derive(Clone)]`
5478 #[stable(feature = "rchunks", since = "1.31.0")]
5479 impl<'a, T> Clone for RChunksExact<'a, T> {
5480     fn clone(&self) -> RChunksExact<'a, T> {
5481         RChunksExact { v: self.v, rem: self.rem, chunk_size: self.chunk_size }
5482     }
5483 }
5484
5485 #[stable(feature = "rchunks", since = "1.31.0")]
5486 impl<'a, T> Iterator for RChunksExact<'a, T> {
5487     type Item = &'a [T];
5488
5489     #[inline]
5490     fn next(&mut self) -> Option<&'a [T]> {
5491         if self.v.len() < self.chunk_size {
5492             None
5493         } else {
5494             let (fst, snd) = self.v.split_at(self.v.len() - self.chunk_size);
5495             self.v = fst;
5496             Some(snd)
5497         }
5498     }
5499
5500     #[inline]
5501     fn size_hint(&self) -> (usize, Option<usize>) {
5502         let n = self.v.len() / self.chunk_size;
5503         (n, Some(n))
5504     }
5505
5506     #[inline]
5507     fn count(self) -> usize {
5508         self.len()
5509     }
5510
5511     #[inline]
5512     fn nth(&mut self, n: usize) -> Option<Self::Item> {
5513         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5514         if end >= self.v.len() || overflow {
5515             self.v = &[];
5516             None
5517         } else {
5518             let (fst, _) = self.v.split_at(self.v.len() - end);
5519             self.v = fst;
5520             self.next()
5521         }
5522     }
5523
5524     #[inline]
5525     fn last(mut self) -> Option<Self::Item> {
5526         self.next_back()
5527     }
5528 }
5529
5530 #[stable(feature = "rchunks", since = "1.31.0")]
5531 impl<'a, T> DoubleEndedIterator for RChunksExact<'a, T> {
5532     #[inline]
5533     fn next_back(&mut self) -> Option<&'a [T]> {
5534         if self.v.len() < self.chunk_size {
5535             None
5536         } else {
5537             let (fst, snd) = self.v.split_at(self.chunk_size);
5538             self.v = snd;
5539             Some(fst)
5540         }
5541     }
5542
5543     #[inline]
5544     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5545         let len = self.len();
5546         if n >= len {
5547             self.v = &[];
5548             None
5549         } else {
5550             // now that we know that `n` corresponds to a chunk,
5551             // none of these operations can underflow/overflow
5552             let offset = (len - n) * self.chunk_size;
5553             let start = self.v.len() - offset;
5554             let end = start + self.chunk_size;
5555             let nth_back = &self.v[start..end];
5556             self.v = &self.v[end..];
5557             Some(nth_back)
5558         }
5559     }
5560 }
5561
5562 #[stable(feature = "rchunks", since = "1.31.0")]
5563 impl<'a, T> ExactSizeIterator for RChunksExact<'a, T> {
5564     fn is_empty(&self) -> bool {
5565         self.v.is_empty()
5566     }
5567 }
5568
5569 #[unstable(feature = "trusted_len", issue = "37572")]
5570 unsafe impl<T> TrustedLen for RChunksExact<'_, T> {}
5571
5572 #[stable(feature = "rchunks", since = "1.31.0")]
5573 impl<T> FusedIterator for RChunksExact<'_, T> {}
5574
5575 #[doc(hidden)]
5576 #[stable(feature = "rchunks", since = "1.31.0")]
5577 unsafe impl<'a, T> TrustedRandomAccess for RChunksExact<'a, T> {
5578     unsafe fn get_unchecked(&mut self, i: usize) -> &'a [T] {
5579         let end = self.v.len() - i * self.chunk_size;
5580         let start = end - self.chunk_size;
5581         from_raw_parts(self.v.as_ptr().add(start), self.chunk_size)
5582     }
5583     fn may_have_side_effect() -> bool {
5584         false
5585     }
5586 }
5587
5588 /// An iterator over a slice in (non-overlapping) mutable chunks (`chunk_size`
5589 /// elements at a time), starting at the end of the slice.
5590 ///
5591 /// When the slice len is not evenly divided by the chunk size, the last up to
5592 /// `chunk_size-1` elements will be omitted but can be retrieved from the
5593 /// [`into_remainder`] function from the iterator.
5594 ///
5595 /// This struct is created by the [`rchunks_exact_mut`] method on [slices].
5596 ///
5597 /// [`rchunks_exact_mut`]: ../../std/primitive.slice.html#method.rchunks_exact_mut
5598 /// [`into_remainder`]: ../../std/slice/struct.ChunksExactMut.html#method.into_remainder
5599 /// [slices]: ../../std/primitive.slice.html
5600 #[derive(Debug)]
5601 #[stable(feature = "rchunks", since = "1.31.0")]
5602 pub struct RChunksExactMut<'a, T: 'a> {
5603     v: &'a mut [T],
5604     rem: &'a mut [T],
5605     chunk_size: usize,
5606 }
5607
5608 impl<'a, T> RChunksExactMut<'a, T> {
5609     /// Returns the remainder of the original slice that is not going to be
5610     /// returned by the iterator. The returned slice has at most `chunk_size-1`
5611     /// elements.
5612     #[stable(feature = "rchunks", since = "1.31.0")]
5613     pub fn into_remainder(self) -> &'a mut [T] {
5614         self.rem
5615     }
5616 }
5617
5618 #[stable(feature = "rchunks", since = "1.31.0")]
5619 impl<'a, T> Iterator for RChunksExactMut<'a, T> {
5620     type Item = &'a mut [T];
5621
5622     #[inline]
5623     fn next(&mut self) -> Option<&'a mut [T]> {
5624         if self.v.len() < self.chunk_size {
5625             None
5626         } else {
5627             let tmp = mem::replace(&mut self.v, &mut []);
5628             let tmp_len = tmp.len();
5629             let (head, tail) = tmp.split_at_mut(tmp_len - self.chunk_size);
5630             self.v = head;
5631             Some(tail)
5632         }
5633     }
5634
5635     #[inline]
5636     fn size_hint(&self) -> (usize, Option<usize>) {
5637         let n = self.v.len() / self.chunk_size;
5638         (n, Some(n))
5639     }
5640
5641     #[inline]
5642     fn count(self) -> usize {
5643         self.len()
5644     }
5645
5646     #[inline]
5647     fn nth(&mut self, n: usize) -> Option<&'a mut [T]> {
5648         let (end, overflow) = n.overflowing_mul(self.chunk_size);
5649         if end >= self.v.len() || overflow {
5650             self.v = &mut [];
5651             None
5652         } else {
5653             let tmp = mem::replace(&mut self.v, &mut []);
5654             let tmp_len = tmp.len();
5655             let (fst, _) = tmp.split_at_mut(tmp_len - end);
5656             self.v = fst;
5657             self.next()
5658         }
5659     }
5660
5661     #[inline]
5662     fn last(mut self) -> Option<Self::Item> {
5663         self.next_back()
5664     }
5665 }
5666
5667 #[stable(feature = "rchunks", since = "1.31.0")]
5668 impl<'a, T> DoubleEndedIterator for RChunksExactMut<'a, T> {
5669     #[inline]
5670     fn next_back(&mut self) -> Option<&'a mut [T]> {
5671         if self.v.len() < self.chunk_size {
5672             None
5673         } else {
5674             let tmp = mem::replace(&mut self.v, &mut []);
5675             let (head, tail) = tmp.split_at_mut(self.chunk_size);
5676             self.v = tail;
5677             Some(head)
5678         }
5679     }
5680
5681     #[inline]
5682     fn nth_back(&mut self, n: usize) -> Option<Self::Item> {
5683         let len = self.len();
5684         if n >= len {
5685             self.v = &mut [];
5686             None
5687         } else {
5688             // now that we know that `n` corresponds to a chunk,
5689             // none of these operations can underflow/overflow
5690             let offset = (len - n) * self.chunk_size;
5691             let start = self.v.len() - offset;
5692             let end = start + self.chunk_size;
5693             let (tmp, tail) = mem::replace(&mut self.v, &mut []).split_at_mut(end);
5694             let (_, nth_back) = tmp.split_at_mut(start);
5695             self.v = tail;
5696             Some(nth_back)
5697         }
5698     }
5699 }
5700
5701 #[stable(feature = "rchunks", since = "1.31.0")]
5702 impl<T> ExactSizeIterator for RChunksExactMut<'_, T> {
5703     fn is_empty(&self) -> bool {
5704         self.v.is_empty()
5705     }
5706 }
5707
5708 #[unstable(feature = "trusted_len", issue = "37572")]
5709 unsafe impl<T> TrustedLen for RChunksExactMut<'_, T> {}
5710
5711 #[stable(feature = "rchunks", since = "1.31.0")]
5712 impl<T> FusedIterator for RChunksExactMut<'_, T> {}
5713
5714 #[doc(hidden)]
5715 #[stable(feature = "rchunks", since = "1.31.0")]
5716 unsafe impl<'a, T> TrustedRandomAccess for RChunksExactMut<'a, T> {
5717     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut [T] {
5718         let end = self.v.len() - i * self.chunk_size;
5719         let start = end - self.chunk_size;
5720         from_raw_parts_mut(self.v.as_mut_ptr().add(start), self.chunk_size)
5721     }
5722     fn may_have_side_effect() -> bool {
5723         false
5724     }
5725 }
5726
5727 //
5728 // Free functions
5729 //
5730
5731 /// Forms a slice from a pointer and a length.
5732 ///
5733 /// The `len` argument is the number of **elements**, not the number of bytes.
5734 ///
5735 /// # Safety
5736 ///
5737 /// Behavior is undefined if any of the following conditions are violated:
5738 ///
5739 /// * `data` must be [valid] for reads for `len * mem::size_of::<T>()` many bytes,
5740 ///   and it must be properly aligned. This means in particular:
5741 ///
5742 ///     * The entire memory range of this slice must be contained within a single allocated object!
5743 ///       Slices can never span across multiple allocated objects. See [below](#incorrect-usage)
5744 ///       for an example incorrectly not taking this into account.
5745 ///     * `data` must be non-null and aligned even for zero-length slices. One
5746 ///       reason for this is that enum layout optimizations may rely on references
5747 ///       (including slices of any length) being aligned and non-null to distinguish
5748 ///       them from other data. You can obtain a pointer that is usable as `data`
5749 ///       for zero-length slices using [`NonNull::dangling()`].
5750 ///
5751 /// * The memory referenced by the returned slice must not be mutated for the duration
5752 ///   of lifetime `'a`, except inside an `UnsafeCell`.
5753 ///
5754 /// * The total size `len * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`.
5755 ///   See the safety documentation of [`pointer::offset`].
5756 ///
5757 /// # Caveat
5758 ///
5759 /// The lifetime for the returned slice is inferred from its usage. To
5760 /// prevent accidental misuse, it's suggested to tie the lifetime to whichever
5761 /// source lifetime is safe in the context, such as by providing a helper
5762 /// function taking the lifetime of a host value for the slice, or by explicit
5763 /// annotation.
5764 ///
5765 /// # Examples
5766 ///
5767 /// ```
5768 /// use std::slice;
5769 ///
5770 /// // manifest a slice for a single element
5771 /// let x = 42;
5772 /// let ptr = &x as *const _;
5773 /// let slice = unsafe { slice::from_raw_parts(ptr, 1) };
5774 /// assert_eq!(slice[0], 42);
5775 /// ```
5776 ///
5777 /// ### Incorrect usage
5778 ///
5779 /// The following `join_slices` function is **unsound** ⚠️
5780 ///
5781 /// ```rust,no_run
5782 /// use std::slice;
5783 ///
5784 /// fn join_slices<'a, T>(fst: &'a [T], snd: &'a [T]) -> &'a [T] {
5785 ///     let fst_end = fst.as_ptr().wrapping_add(fst.len());
5786 ///     let snd_start = snd.as_ptr();
5787 ///     assert_eq!(fst_end, snd_start, "Slices must be contiguous!");
5788 ///     unsafe {
5789 ///         // The assertion above ensures `fst` and `snd` are contiguous, but they might
5790 ///         // still be contained within _different allocated objects_, in which case
5791 ///         // creating this slice is undefined behavior.
5792 ///         slice::from_raw_parts(fst.as_ptr(), fst.len() + snd.len())
5793 ///     }
5794 /// }
5795 ///
5796 /// fn main() {
5797 ///     // `a` and `b` are different allocated objects...
5798 ///     let a = 42;
5799 ///     let b = 27;
5800 ///     // ... which may nevertheless be laid out contiguously in memory: | a | b |
5801 ///     let _ = join_slices(slice::from_ref(&a), slice::from_ref(&b)); // UB
5802 /// }
5803 /// ```
5804 ///
5805 /// [valid]: ../../std/ptr/index.html#safety
5806 /// [`NonNull::dangling()`]: ../../std/ptr/struct.NonNull.html#method.dangling
5807 /// [`pointer::offset`]: ../../std/primitive.pointer.html#method.offset
5808 #[inline]
5809 #[stable(feature = "rust1", since = "1.0.0")]
5810 pub unsafe fn from_raw_parts<'a, T>(data: *const T, len: usize) -> &'a [T] {
5811     debug_assert!(is_aligned_and_not_null(data), "attempt to create unaligned or null slice");
5812     debug_assert!(
5813         mem::size_of::<T>().saturating_mul(len) <= isize::MAX as usize,
5814         "attempt to create slice covering at least half the address space"
5815     );
5816     &*ptr::slice_from_raw_parts(data, len)
5817 }
5818
5819 /// Performs the same functionality as [`from_raw_parts`], except that a
5820 /// mutable slice is returned.
5821 ///
5822 /// # Safety
5823 ///
5824 /// Behavior is undefined if any of the following conditions are violated:
5825 ///
5826 /// * `data` must be [valid] for writes for `len * mem::size_of::<T>()` many bytes,
5827 ///   and it must be properly aligned. This means in particular:
5828 ///
5829 ///     * The entire memory range of this slice must be contained within a single allocated object!
5830 ///       Slices can never span across multiple allocated objects.
5831 ///     * `data` must be non-null and aligned even for zero-length slices. One
5832 ///       reason for this is that enum layout optimizations may rely on references
5833 ///       (including slices of any length) being aligned and non-null to distinguish
5834 ///       them from other data. You can obtain a pointer that is usable as `data`
5835 ///       for zero-length slices using [`NonNull::dangling()`].
5836 ///
5837 /// * The memory referenced by the returned slice must not be accessed through any other pointer
5838 ///   (not derived from the return value) for the duration of lifetime `'a`.
5839 ///   Both read and write accesses are forbidden.
5840 ///
5841 /// * The total size `len * mem::size_of::<T>()` of the slice must be no larger than `isize::MAX`.
5842 ///   See the safety documentation of [`pointer::offset`].
5843 ///
5844 /// [valid]: ../../std/ptr/index.html#safety
5845 /// [`NonNull::dangling()`]: ../../std/ptr/struct.NonNull.html#method.dangling
5846 /// [`pointer::offset`]: ../../std/primitive.pointer.html#method.offset
5847 /// [`from_raw_parts`]: ../../std/slice/fn.from_raw_parts.html
5848 #[inline]
5849 #[stable(feature = "rust1", since = "1.0.0")]
5850 pub unsafe fn from_raw_parts_mut<'a, T>(data: *mut T, len: usize) -> &'a mut [T] {
5851     debug_assert!(is_aligned_and_not_null(data), "attempt to create unaligned or null slice");
5852     debug_assert!(
5853         mem::size_of::<T>().saturating_mul(len) <= isize::MAX as usize,
5854         "attempt to create slice covering at least half the address space"
5855     );
5856     &mut *ptr::slice_from_raw_parts_mut(data, len)
5857 }
5858
5859 /// Converts a reference to T into a slice of length 1 (without copying).
5860 #[stable(feature = "from_ref", since = "1.28.0")]
5861 pub fn from_ref<T>(s: &T) -> &[T] {
5862     unsafe { from_raw_parts(s, 1) }
5863 }
5864
5865 /// Converts a reference to T into a slice of length 1 (without copying).
5866 #[stable(feature = "from_ref", since = "1.28.0")]
5867 pub fn from_mut<T>(s: &mut T) -> &mut [T] {
5868     unsafe { from_raw_parts_mut(s, 1) }
5869 }
5870
5871 // This function is public only because there is no other way to unit test heapsort.
5872 #[unstable(feature = "sort_internals", reason = "internal to sort module", issue = "none")]
5873 #[doc(hidden)]
5874 pub fn heapsort<T, F>(v: &mut [T], mut is_less: F)
5875 where
5876     F: FnMut(&T, &T) -> bool,
5877 {
5878     sort::heapsort(v, &mut is_less);
5879 }
5880
5881 //
5882 // Comparison traits
5883 //
5884
5885 extern "C" {
5886     /// Calls implementation provided memcmp.
5887     ///
5888     /// Interprets the data as u8.
5889     ///
5890     /// Returns 0 for equal, < 0 for less than and > 0 for greater
5891     /// than.
5892     // FIXME(#32610): Return type should be c_int
5893     fn memcmp(s1: *const u8, s2: *const u8, n: usize) -> i32;
5894 }
5895
5896 #[stable(feature = "rust1", since = "1.0.0")]
5897 impl<A, B> PartialEq<[B]> for [A]
5898 where
5899     A: PartialEq<B>,
5900 {
5901     fn eq(&self, other: &[B]) -> bool {
5902         SlicePartialEq::equal(self, other)
5903     }
5904
5905     fn ne(&self, other: &[B]) -> bool {
5906         SlicePartialEq::not_equal(self, other)
5907     }
5908 }
5909
5910 #[stable(feature = "rust1", since = "1.0.0")]
5911 impl<T: Eq> Eq for [T] {}
5912
5913 /// Implements comparison of vectors lexicographically.
5914 #[stable(feature = "rust1", since = "1.0.0")]
5915 impl<T: Ord> Ord for [T] {
5916     fn cmp(&self, other: &[T]) -> Ordering {
5917         SliceOrd::compare(self, other)
5918     }
5919 }
5920
5921 /// Implements comparison of vectors lexicographically.
5922 #[stable(feature = "rust1", since = "1.0.0")]
5923 impl<T: PartialOrd> PartialOrd for [T] {
5924     fn partial_cmp(&self, other: &[T]) -> Option<Ordering> {
5925         SlicePartialOrd::partial_compare(self, other)
5926     }
5927 }
5928
5929 #[doc(hidden)]
5930 // intermediate trait for specialization of slice's PartialEq
5931 trait SlicePartialEq<B> {
5932     fn equal(&self, other: &[B]) -> bool;
5933
5934     fn not_equal(&self, other: &[B]) -> bool {
5935         !self.equal(other)
5936     }
5937 }
5938
5939 // Generic slice equality
5940 impl<A, B> SlicePartialEq<B> for [A]
5941 where
5942     A: PartialEq<B>,
5943 {
5944     default fn equal(&self, other: &[B]) -> bool {
5945         if self.len() != other.len() {
5946             return false;
5947         }
5948
5949         self.iter().zip(other.iter()).all(|(x, y)| x == y)
5950     }
5951 }
5952
5953 // Use an equal-pointer optimization when types are `Eq`
5954 impl<A> SlicePartialEq<A> for [A]
5955 where
5956     A: PartialEq<A> + Eq,
5957 {
5958     default fn equal(&self, other: &[A]) -> bool {
5959         if self.len() != other.len() {
5960             return false;
5961         }
5962
5963         if self.as_ptr() == other.as_ptr() {
5964             return true;
5965         }
5966
5967         self.iter().zip(other.iter()).all(|(x, y)| x == y)
5968     }
5969 }
5970
5971 // Use memcmp for bytewise equality when the types allow
5972 impl<A> SlicePartialEq<A> for [A]
5973 where
5974     A: PartialEq<A> + BytewiseEquality,
5975 {
5976     fn equal(&self, other: &[A]) -> bool {
5977         if self.len() != other.len() {
5978             return false;
5979         }
5980         if self.as_ptr() == other.as_ptr() {
5981             return true;
5982         }
5983         unsafe {
5984             let size = mem::size_of_val(self);
5985             memcmp(self.as_ptr() as *const u8, other.as_ptr() as *const u8, size) == 0
5986         }
5987     }
5988 }
5989
5990 #[doc(hidden)]
5991 // intermediate trait for specialization of slice's PartialOrd
5992 trait SlicePartialOrd: Sized {
5993     fn partial_compare(left: &[Self], right: &[Self]) -> Option<Ordering>;
5994 }
5995
5996 impl<A: PartialOrd> SlicePartialOrd for A {
5997     default fn partial_compare(left: &[A], right: &[A]) -> Option<Ordering> {
5998         let l = cmp::min(left.len(), right.len());
5999
6000         // Slice to the loop iteration range to enable bound check
6001         // elimination in the compiler
6002         let lhs = &left[..l];
6003         let rhs = &right[..l];
6004
6005         for i in 0..l {
6006             match lhs[i].partial_cmp(&rhs[i]) {
6007                 Some(Ordering::Equal) => (),
6008                 non_eq => return non_eq,
6009             }
6010         }
6011
6012         left.len().partial_cmp(&right.len())
6013     }
6014 }
6015
6016 // This is the impl that we would like to have. Unfortunately it's not sound.
6017 // See `partial_ord_slice.rs`.
6018 /*
6019 impl<A> SlicePartialOrd for A
6020 where
6021     A: Ord,
6022 {
6023     default fn partial_compare(left: &[A], right: &[A]) -> Option<Ordering> {
6024         Some(SliceOrd::compare(left, right))
6025     }
6026 }
6027 */
6028
6029 impl<A: AlwaysApplicableOrd> SlicePartialOrd for A {
6030     fn partial_compare(left: &[A], right: &[A]) -> Option<Ordering> {
6031         Some(SliceOrd::compare(left, right))
6032     }
6033 }
6034
6035 trait AlwaysApplicableOrd: SliceOrd + Ord {}
6036
6037 macro_rules! always_applicable_ord {
6038     ($([$($p:tt)*] $t:ty,)*) => {
6039         $(impl<$($p)*> AlwaysApplicableOrd for $t {})*
6040     }
6041 }
6042
6043 always_applicable_ord! {
6044     [] u8, [] u16, [] u32, [] u64, [] u128, [] usize,
6045     [] i8, [] i16, [] i32, [] i64, [] i128, [] isize,
6046     [] bool, [] char,
6047     [T: ?Sized] *const T, [T: ?Sized] *mut T,
6048     [T: AlwaysApplicableOrd] &T,
6049     [T: AlwaysApplicableOrd] &mut T,
6050     [T: AlwaysApplicableOrd] Option<T>,
6051 }
6052
6053 #[doc(hidden)]
6054 // intermediate trait for specialization of slice's Ord
6055 trait SliceOrd: Sized {
6056     fn compare(left: &[Self], right: &[Self]) -> Ordering;
6057 }
6058
6059 impl<A: Ord> SliceOrd for A {
6060     default fn compare(left: &[Self], right: &[Self]) -> Ordering {
6061         let l = cmp::min(left.len(), right.len());
6062
6063         // Slice to the loop iteration range to enable bound check
6064         // elimination in the compiler
6065         let lhs = &left[..l];
6066         let rhs = &right[..l];
6067
6068         for i in 0..l {
6069             match lhs[i].cmp(&rhs[i]) {
6070                 Ordering::Equal => (),
6071                 non_eq => return non_eq,
6072             }
6073         }
6074
6075         left.len().cmp(&right.len())
6076     }
6077 }
6078
6079 // memcmp compares a sequence of unsigned bytes lexicographically.
6080 // this matches the order we want for [u8], but no others (not even [i8]).
6081 impl SliceOrd for u8 {
6082     #[inline]
6083     fn compare(left: &[Self], right: &[Self]) -> Ordering {
6084         let order =
6085             unsafe { memcmp(left.as_ptr(), right.as_ptr(), cmp::min(left.len(), right.len())) };
6086         if order == 0 {
6087             left.len().cmp(&right.len())
6088         } else if order < 0 {
6089             Less
6090         } else {
6091             Greater
6092         }
6093     }
6094 }
6095
6096 #[doc(hidden)]
6097 /// Trait implemented for types that can be compared for equality using
6098 /// their bytewise representation
6099 trait BytewiseEquality: Eq + Copy {}
6100
6101 macro_rules! impl_marker_for {
6102     ($traitname:ident, $($ty:ty)*) => {
6103         $(
6104             impl $traitname for $ty { }
6105         )*
6106     }
6107 }
6108
6109 impl_marker_for!(BytewiseEquality,
6110                  u8 i8 u16 i16 u32 i32 u64 i64 u128 i128 usize isize char bool);
6111
6112 #[doc(hidden)]
6113 unsafe impl<'a, T> TrustedRandomAccess for Iter<'a, T> {
6114     unsafe fn get_unchecked(&mut self, i: usize) -> &'a T {
6115         &*self.ptr.as_ptr().add(i)
6116     }
6117     fn may_have_side_effect() -> bool {
6118         false
6119     }
6120 }
6121
6122 #[doc(hidden)]
6123 unsafe impl<'a, T> TrustedRandomAccess for IterMut<'a, T> {
6124     unsafe fn get_unchecked(&mut self, i: usize) -> &'a mut T {
6125         &mut *self.ptr.as_ptr().add(i)
6126     }
6127     fn may_have_side_effect() -> bool {
6128         false
6129     }
6130 }
6131
6132 trait SliceContains: Sized {
6133     fn slice_contains(&self, x: &[Self]) -> bool;
6134 }
6135
6136 impl<T> SliceContains for T
6137 where
6138     T: PartialEq,
6139 {
6140     default fn slice_contains(&self, x: &[Self]) -> bool {
6141         x.iter().any(|y| *y == *self)
6142     }
6143 }
6144
6145 impl SliceContains for u8 {
6146     fn slice_contains(&self, x: &[Self]) -> bool {
6147         memchr::memchr(*self, x).is_some()
6148     }
6149 }
6150
6151 impl SliceContains for i8 {
6152     fn slice_contains(&self, x: &[Self]) -> bool {
6153         let byte = *self as u8;
6154         let bytes: &[u8] = unsafe { from_raw_parts(x.as_ptr() as *const u8, x.len()) };
6155         memchr::memchr(byte, bytes).is_some()
6156     }
6157 }