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