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