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