mirror of
https://github.com/rust-lang/rust.git
synced 2024-11-22 14:55:26 +00:00
Rollup merge of #88502 - ibraheemdev:slice-take, r=dtolnay
Add slice take methods Revival of #62282 This PR adds the following slice methods: - `take` - `take_mut` - `take_first` - `take_first_mut` - `take_last` - `take_last_mut` r? `@LukasKalbertodt`
This commit is contained in:
Matthias Krüger
GitHub
commit
9f1f42897d
@ -181,6 +181,9 @@ pub use self::range::{Range, RangeFrom, RangeFull, RangeTo};
|
||||
#[stable(feature = "inclusive_range", since = "1.26.0")]
|
||||
pub use self::range::{Bound, RangeBounds, RangeInclusive, RangeToInclusive};
|
||||
|
||||
#[unstable(feature = "one_sided_range", issue = "69780")]
|
||||
pub use self::range::OneSidedRange;
|
||||
|
||||
#[unstable(feature = "try_trait_v2", issue = "84277")]
|
||||
pub use self::try_trait::{FromResidual, Try};
|
||||
|
||||
|
||||
@ -971,3 +971,21 @@ impl<T> RangeBounds<T> for RangeToInclusive<&T> {
|
||||
Included(self.end)
|
||||
}
|
||||
}
|
||||
|
||||
/// `OneSidedRange` is implemented for built-in range types that are unbounded
|
||||
/// on one side. For example, `a..`, `..b` and `..=c` implement `OneSidedRange`,
|
||||
/// but `..`, `d..e`, and `f..=g` do not.
|
||||
///
|
||||
/// Types that implement `OneSidedRange<T>` must return `Bound::Unbounded`
|
||||
/// from one of `RangeBounds::start_bound` or `RangeBounds::end_bound`.
|
||||
#[unstable(feature = "one_sided_range", issue = "69780")]
|
||||
pub trait OneSidedRange<T: ?Sized>: RangeBounds<T> {}
|
||||
|
||||
#[unstable(feature = "one_sided_range", issue = "69780")]
|
||||
impl<T> OneSidedRange<T> for RangeTo<T> where Self: RangeBounds<T> {}
|
||||
|
||||
#[unstable(feature = "one_sided_range", issue = "69780")]
|
||||
impl<T> OneSidedRange<T> for RangeFrom<T> where Self: RangeBounds<T> {}
|
||||
|
||||
#[unstable(feature = "one_sided_range", issue = "69780")]
|
||||
impl<T> OneSidedRange<T> for RangeToInclusive<T> where Self: RangeBounds<T> {}
|
||||
|
||||
@ -10,7 +10,7 @@ use crate::cmp::Ordering::{self, Greater, Less};
|
||||
use crate::marker::Copy;
|
||||
use crate::mem;
|
||||
use crate::num::NonZeroUsize;
|
||||
use crate::ops::{FnMut, Range, RangeBounds};
|
||||
use crate::ops::{Bound, FnMut, OneSidedRange, Range, RangeBounds};
|
||||
use crate::option::Option;
|
||||
use crate::option::Option::{None, Some};
|
||||
use crate::ptr;
|
||||
@ -82,6 +82,29 @@ pub use index::range;
|
||||
#[unstable(feature = "inherent_ascii_escape", issue = "77174")]
|
||||
pub use ascii::EscapeAscii;
|
||||
|
||||
/// Calculates the direction and split point of a one-sided range.
|
||||
///
|
||||
/// This is a helper function for `take` and `take_mut` that returns
|
||||
/// the direction of the split (front or back) as well as the index at
|
||||
/// which to split. Returns `None` if the split index would overflow.
|
||||
#[inline]
|
||||
fn split_point_of(range: impl OneSidedRange<usize>) -> Option<(Direction, usize)> {
|
||||
use Bound::*;
|
||||
|
||||
Some(match (range.start_bound(), range.end_bound()) {
|
||||
(Unbounded, Excluded(i)) => (Direction::Front, *i),
|
||||
(Unbounded, Included(i)) => (Direction::Front, i.checked_add(1)?),
|
||||
(Excluded(i), Unbounded) => (Direction::Back, i.checked_add(1)?),
|
||||
(Included(i), Unbounded) => (Direction::Back, *i),
|
||||
_ => unreachable!(),
|
||||
})
|
||||
}
|
||||
|
||||
enum Direction {
|
||||
Front,
|
||||
Back,
|
||||
}
|
||||
|
||||
#[lang = "slice"]
|
||||
#[cfg(not(test))]
|
||||
impl<T> [T] {
|
||||
@ -3517,6 +3540,245 @@ impl<T> [T] {
|
||||
{
|
||||
self.binary_search_by(|x| if pred(x) { Less } else { Greater }).unwrap_or_else(|i| i)
|
||||
}
|
||||
|
||||
/// Removes the subslice corresponding to the given range
|
||||
/// and returns a reference to it.
|
||||
///
|
||||
/// Returns `None` and does not modify the slice if the given
|
||||
/// range is out of bounds.
|
||||
///
|
||||
/// Note that this method only accepts one-sided ranges such as
|
||||
/// `2..` or `..6`, but not `2..6`.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Taking the first three elements of a slice:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &[_] = &['a', 'b', 'c', 'd'];
|
||||
/// let mut first_three = slice.take(..3).unwrap();
|
||||
///
|
||||
/// assert_eq!(slice, &['d']);
|
||||
/// assert_eq!(first_three, &['a', 'b', 'c']);
|
||||
/// ```
|
||||
///
|
||||
/// Taking the last two elements of a slice:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &[_] = &['a', 'b', 'c', 'd'];
|
||||
/// let mut tail = slice.take(2..).unwrap();
|
||||
///
|
||||
/// assert_eq!(slice, &['a', 'b']);
|
||||
/// assert_eq!(tail, &['c', 'd']);
|
||||
/// ```
|
||||
///
|
||||
/// Getting `None` when `range` is out of bounds:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &[_] = &['a', 'b', 'c', 'd'];
|
||||
///
|
||||
/// assert_eq!(None, slice.take(5..));
|
||||
/// assert_eq!(None, slice.take(..5));
|
||||
/// assert_eq!(None, slice.take(..=4));
|
||||
/// let expected: &[char] = &['a', 'b', 'c', 'd'];
|
||||
/// assert_eq!(Some(expected), slice.take(..4));
|
||||
/// ```
|
||||
#[inline]
|
||||
#[must_use = "method does not modify the slice if the range is out of bounds"]
|
||||
#[unstable(feature = "slice_take", issue = "62280")]
|
||||
pub fn take<'a, R: OneSidedRange<usize>>(self: &mut &'a Self, range: R) -> Option<&'a Self> {
|
||||
let (direction, split_index) = split_point_of(range)?;
|
||||
if split_index > self.len() {
|
||||
return None;
|
||||
}
|
||||
let (front, back) = self.split_at(split_index);
|
||||
match direction {
|
||||
Direction::Front => {
|
||||
*self = back;
|
||||
Some(front)
|
||||
}
|
||||
Direction::Back => {
|
||||
*self = front;
|
||||
Some(back)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Removes the subslice corresponding to the given range
|
||||
/// and returns a mutable reference to it.
|
||||
///
|
||||
/// Returns `None` and does not modify the slice if the given
|
||||
/// range is out of bounds.
|
||||
///
|
||||
/// Note that this method only accepts one-sided ranges such as
|
||||
/// `2..` or `..6`, but not `2..6`.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// Taking the first three elements of a slice:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &mut [_] = &mut ['a', 'b', 'c', 'd'];
|
||||
/// let mut first_three = slice.take_mut(..3).unwrap();
|
||||
///
|
||||
/// assert_eq!(slice, &mut ['d']);
|
||||
/// assert_eq!(first_three, &mut ['a', 'b', 'c']);
|
||||
/// ```
|
||||
///
|
||||
/// Taking the last two elements of a slice:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &mut [_] = &mut ['a', 'b', 'c', 'd'];
|
||||
/// let mut tail = slice.take_mut(2..).unwrap();
|
||||
///
|
||||
/// assert_eq!(slice, &mut ['a', 'b']);
|
||||
/// assert_eq!(tail, &mut ['c', 'd']);
|
||||
/// ```
|
||||
///
|
||||
/// Getting `None` when `range` is out of bounds:
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &mut [_] = &mut ['a', 'b', 'c', 'd'];
|
||||
///
|
||||
/// assert_eq!(None, slice.take_mut(5..));
|
||||
/// assert_eq!(None, slice.take_mut(..5));
|
||||
/// assert_eq!(None, slice.take_mut(..=4));
|
||||
/// let expected: &mut [_] = &mut ['a', 'b', 'c', 'd'];
|
||||
/// assert_eq!(Some(expected), slice.take_mut(..4));
|
||||
/// ```
|
||||
#[inline]
|
||||
#[must_use = "method does not modify the slice if the range is out of bounds"]
|
||||
#[unstable(feature = "slice_take", issue = "62280")]
|
||||
pub fn take_mut<'a, R: OneSidedRange<usize>>(
|
||||
self: &mut &'a mut Self,
|
||||
range: R,
|
||||
) -> Option<&'a mut Self> {
|
||||
let (direction, split_index) = split_point_of(range)?;
|
||||
if split_index > self.len() {
|
||||
return None;
|
||||
}
|
||||
let (front, back) = mem::take(self).split_at_mut(split_index);
|
||||
match direction {
|
||||
Direction::Front => {
|
||||
*self = back;
|
||||
Some(front)
|
||||
}
|
||||
Direction::Back => {
|
||||
*self = front;
|
||||
Some(back)
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/// Removes the first element of the slice and returns a reference
|
||||
/// to it.
|
||||
///
|
||||
/// Returns `None` if the slice is empty.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &[_] = &['a', 'b', 'c'];
|
||||
/// let first = slice.take_first().unwrap();
|
||||
///
|
||||
/// assert_eq!(slice, &['b', 'c']);
|
||||
/// assert_eq!(first, &'a');
|
||||
/// ```
|
||||
#[inline]
|
||||
#[unstable(feature = "slice_take", issue = "62280")]
|
||||
pub fn take_first<'a>(self: &mut &'a Self) -> Option<&'a T> {
|
||||
let (first, rem) = self.split_first()?;
|
||||
*self = rem;
|
||||
Some(first)
|
||||
}
|
||||
|
||||
/// Removes the first element of the slice and returns a mutable
|
||||
/// reference to it.
|
||||
///
|
||||
/// Returns `None` if the slice is empty.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &mut [_] = &mut ['a', 'b', 'c'];
|
||||
/// let first = slice.take_first_mut().unwrap();
|
||||
/// *first = 'd';
|
||||
///
|
||||
/// assert_eq!(slice, &['b', 'c']);
|
||||
/// assert_eq!(first, &'d');
|
||||
/// ```
|
||||
#[inline]
|
||||
#[unstable(feature = "slice_take", issue = "62280")]
|
||||
pub fn take_first_mut<'a>(self: &mut &'a mut Self) -> Option<&'a mut T> {
|
||||
let (first, rem) = mem::take(self).split_first_mut()?;
|
||||
*self = rem;
|
||||
Some(first)
|
||||
}
|
||||
|
||||
/// Removes the last element of the slice and returns a reference
|
||||
/// to it.
|
||||
///
|
||||
/// Returns `None` if the slice is empty.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &[_] = &['a', 'b', 'c'];
|
||||
/// let last = slice.take_last().unwrap();
|
||||
///
|
||||
/// assert_eq!(slice, &['a', 'b']);
|
||||
/// assert_eq!(last, &'c');
|
||||
/// ```
|
||||
#[inline]
|
||||
#[unstable(feature = "slice_take", issue = "62280")]
|
||||
pub fn take_last<'a>(self: &mut &'a Self) -> Option<&'a T> {
|
||||
let (last, rem) = self.split_last()?;
|
||||
*self = rem;
|
||||
Some(last)
|
||||
}
|
||||
|
||||
/// Removes the last element of the slice and returns a mutable
|
||||
/// reference to it.
|
||||
///
|
||||
/// Returns `None` if the slice is empty.
|
||||
///
|
||||
/// # Examples
|
||||
///
|
||||
/// ```
|
||||
/// #![feature(slice_take)]
|
||||
///
|
||||
/// let mut slice: &mut [_] = &mut ['a', 'b', 'c'];
|
||||
/// let last = slice.take_last_mut().unwrap();
|
||||
/// *last = 'd';
|
||||
///
|
||||
/// assert_eq!(slice, &['a', 'b']);
|
||||
/// assert_eq!(last, &'d');
|
||||
/// ```
|
||||
#[inline]
|
||||
#[unstable(feature = "slice_take", issue = "62280")]
|
||||
pub fn take_last_mut<'a>(self: &mut &'a mut Self) -> Option<&'a mut T> {
|
||||
let (last, rem) = mem::take(self).split_last_mut()?;
|
||||
*self = rem;
|
||||
Some(last)
|
||||
}
|
||||
}
|
||||
|
||||
trait CloneFromSpec<T> {
|
||||
|
||||
@ -36,6 +36,7 @@
|
||||
#![feature(pattern)]
|
||||
#![feature(sort_internals)]
|
||||
#![feature(slice_partition_at_index)]
|
||||
#![feature(slice_take)]
|
||||
#![feature(maybe_uninit_uninit_array)]
|
||||
#![feature(maybe_uninit_array_assume_init)]
|
||||
#![feature(maybe_uninit_extra)]
|
||||
|
||||
@ -2234,3 +2234,112 @@ fn slice_split_array_mut_out_of_bounds() {
|
||||
|
||||
v.split_array_mut::<7>();
|
||||
}
|
||||
|
||||
macro_rules! take_tests {
|
||||
(slice: &[], $($tts:tt)*) => {
|
||||
take_tests!(ty: &[()], slice: &[], $($tts)*);
|
||||
};
|
||||
(slice: &mut [], $($tts:tt)*) => {
|
||||
take_tests!(ty: &mut [()], slice: &mut [], $($tts)*);
|
||||
};
|
||||
(slice: &$slice:expr, $($tts:tt)*) => {
|
||||
take_tests!(ty: &[_], slice: &$slice, $($tts)*);
|
||||
};
|
||||
(slice: &mut $slice:expr, $($tts:tt)*) => {
|
||||
take_tests!(ty: &mut [_], slice: &mut $slice, $($tts)*);
|
||||
};
|
||||
(ty: $ty:ty, slice: $slice:expr, method: $method:ident, $(($test_name:ident, ($($args:expr),*), $output:expr, $remaining:expr),)*) => {
|
||||
$(
|
||||
#[test]
|
||||
fn $test_name() {
|
||||
let mut slice: $ty = $slice;
|
||||
assert_eq!($output, slice.$method($($args)*));
|
||||
let remaining: $ty = $remaining;
|
||||
assert_eq!(remaining, slice);
|
||||
}
|
||||
)*
|
||||
};
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &[0, 1, 2, 3], method: take,
|
||||
(take_in_bounds_range_to, (..1), Some(&[0] as _), &[1, 2, 3]),
|
||||
(take_in_bounds_range_to_inclusive, (..=0), Some(&[0] as _), &[1, 2, 3]),
|
||||
(take_in_bounds_range_from, (2..), Some(&[2, 3] as _), &[0, 1]),
|
||||
(take_oob_range_to, (..5), None, &[0, 1, 2, 3]),
|
||||
(take_oob_range_to_inclusive, (..=4), None, &[0, 1, 2, 3]),
|
||||
(take_oob_range_from, (5..), None, &[0, 1, 2, 3]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &mut [0, 1, 2, 3], method: take_mut,
|
||||
(take_mut_in_bounds_range_to, (..1), Some(&mut [0] as _), &mut [1, 2, 3]),
|
||||
(take_mut_in_bounds_range_to_inclusive, (..=0), Some(&mut [0] as _), &mut [1, 2, 3]),
|
||||
(take_mut_in_bounds_range_from, (2..), Some(&mut [2, 3] as _), &mut [0, 1]),
|
||||
(take_mut_oob_range_to, (..5), None, &mut [0, 1, 2, 3]),
|
||||
(take_mut_oob_range_to_inclusive, (..=4), None, &mut [0, 1, 2, 3]),
|
||||
(take_mut_oob_range_from, (5..), None, &mut [0, 1, 2, 3]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &[1, 2], method: take_first,
|
||||
(take_first_nonempty, (), Some(&1), &[2]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &mut [1, 2], method: take_first_mut,
|
||||
(take_first_mut_nonempty, (), Some(&mut 1), &mut [2]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &[1, 2], method: take_last,
|
||||
(take_last_nonempty, (), Some(&2), &[1]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &mut [1, 2], method: take_last_mut,
|
||||
(take_last_mut_nonempty, (), Some(&mut 2), &mut [1]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &[], method: take_first,
|
||||
(take_first_empty, (), None, &[]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &mut [], method: take_first_mut,
|
||||
(take_first_mut_empty, (), None, &mut []),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &[], method: take_last,
|
||||
(take_last_empty, (), None, &[]),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &mut [], method: take_last_mut,
|
||||
(take_last_mut_empty, (), None, &mut []),
|
||||
}
|
||||
|
||||
const EMPTY_MAX: &'static [()] = &[(); usize::MAX];
|
||||
|
||||
// can't be a constant due to const mutability rules
|
||||
macro_rules! empty_max_mut {
|
||||
() => {
|
||||
&mut [(); usize::MAX] as _
|
||||
};
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &[(); usize::MAX], method: take,
|
||||
(take_in_bounds_max_range_to, (..usize::MAX), Some(EMPTY_MAX), &[(); 0]),
|
||||
(take_oob_max_range_to_inclusive, (..=usize::MAX), None, EMPTY_MAX),
|
||||
(take_in_bounds_max_range_from, (usize::MAX..), Some(&[] as _), EMPTY_MAX),
|
||||
}
|
||||
|
||||
take_tests! {
|
||||
slice: &mut [(); usize::MAX], method: take_mut,
|
||||
(take_mut_in_bounds_max_range_to, (..usize::MAX), Some(empty_max_mut!()), &mut [(); 0]),
|
||||
(take_mut_oob_max_range_to_inclusive, (..=usize::MAX), None, empty_max_mut!()),
|
||||
(take_mut_in_bounds_max_range_from, (usize::MAX..), Some(&mut [] as _), empty_max_mut!()),
|
||||
}
|
||||
|
||||
Loading…
Reference in New Issue
Block a user