Skip to main content

core/slice/
mod.rs

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