1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181
use core::iter::FusedIterator;
use arrays::IntoIter;
/// An extension trait that provides the [`array_chunks`] method for iterators.
///
/// Note: the method provided here has a nightly API:
/// [`Iterator::array_chunks`]. The nightly API handles remainders better and
/// will likely have better performance, so it should be preferred if possible.
///
/// [`array_chunks`]: IterArrayChunks::array_chunks
#[cfg_attr(docsrs, doc(cfg(feature = "array_chunks")))]
pub trait IterArrayChunks: Iterator {
/// Returns an iterator over `N` elements of the iterator at a time.
///
/// The chunks do not overlap. If `N` does not divide the length of the
/// iterator, then the last up to `N-1` elements will be omitted.
///
/// # Panics
///
/// If called with `N = 0`.
///
/// # Examples
///
/// Basic usage:
///
/// ```
/// use itermore::IterArrayChunks;
///
/// let mut iter = "lorem".chars().array_chunks();
/// assert_eq!(iter.next(), Some(['l', 'o']));
/// assert_eq!(iter.next(), Some(['r', 'e']));
/// assert_eq!(iter.next(), None);
/// ```
///
/// ```
/// use itermore::IterArrayChunks;
///
/// let data = [1, 1, 2, -2, 6, 0, 3, 1];
/// // ^-----^ ^------^
/// for [x, y, z] in data.iter().array_chunks() {
/// assert_eq!(x + y + z, 4);
/// }
/// ```
#[inline]
fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>
where
Self: Sized,
{
ArrayChunks::new(self)
}
/// Identical to [`array_chunks`][IterArrayChunks::array_chunks] but doesn't
/// collide with the standard library name.
#[inline]
fn arrays<const N: usize>(self) -> ArrayChunks<Self, N>
where
Self: Sized,
{
ArrayChunks::new(self)
}
}
impl<I: ?Sized> IterArrayChunks for I where I: Iterator {}
/// An iterator over `N` elements of the iterator at a time.
///
/// This struct is created by the [`array_chunks`] method on iterators. See its
/// documentation for more.
///
/// [`array_chunks`]: IterArrayChunks::array_chunks
#[cfg_attr(docsrs, doc(cfg(feature = "array_chunks")))]
#[derive(Debug, Clone)]
#[must_use = "iterators are lazy and do nothing unless consumed"]
pub struct ArrayChunks<I, const N: usize>
where
I: Iterator,
{
iter: I,
remainder: Option<IntoIter<I::Item, N>>,
}
impl<I, const N: usize> ArrayChunks<I, N>
where
I: Iterator,
{
#[track_caller]
fn new(iter: I) -> Self {
assert!(N != 0, "chunk size must be non-zero");
Self {
iter,
remainder: None,
}
}
/// Returns an iterator over the remaining elements of the original iterator
/// that are not going to be yielded. The returned iterator will yield at
/// most `N-1` elements. Returns `None` if the remainder is not yet known.
#[inline]
pub fn into_remainder(self) -> Option<IntoIter<I::Item, N>> {
self.remainder
}
}
impl<I: Iterator, const N: usize> Iterator for ArrayChunks<I, N>
where
I: Iterator,
{
type Item = [I::Item; N];
#[inline]
fn next(&mut self) -> Option<Self::Item> {
let Self { iter, remainder } = self;
match arrays::from_iter(iter) {
Ok(chunk) => Some(chunk),
Err(rem) => {
remainder.get_or_insert(rem);
None
}
}
}
#[inline]
fn size_hint(&self) -> (usize, Option<usize>) {
let (lower, upper) = self.iter.size_hint();
(lower / N, upper.map(|n| n / N))
}
#[inline]
fn count(self) -> usize {
self.iter.count() / N
}
}
impl<I, const N: usize> DoubleEndedIterator for ArrayChunks<I, N>
where
I: DoubleEndedIterator + ExactSizeIterator,
{
#[inline]
fn next_back(&mut self) -> Option<Self::Item> {
self.next_back_remainder();
let mut rev = self.iter.by_ref().rev();
let mut chunk = arrays::from_iter(&mut rev).ok()?;
chunk.reverse();
Some(chunk)
}
}
impl<I, const N: usize> ExactSizeIterator for ArrayChunks<I, N>
where
I: ExactSizeIterator,
{
#[inline]
fn len(&self) -> usize {
self.iter.len() / N
}
}
impl<I, const N: usize> ArrayChunks<I, N>
where
I: DoubleEndedIterator + ExactSizeIterator,
{
/// Updates `self.remainder` such that `self.iter.len` is divisible by `N`.
#[inline]
fn next_back_remainder(&mut self) {
if self.remainder.is_some() {
return;
}
let rem = self.iter.len() % N;
let mut rev = self.iter.by_ref().rev().take(rem);
// SAFETY: `unwrap_err` always succeeds because x % N < N for all x.
let mut remainder = unsafe { arrays::from_iter(&mut rev).unwrap_err_unchecked() };
// We used `.rev()` above, so we need to re-reverse the remainder.
remainder.as_mut_slice().reverse();
self.remainder = Some(remainder);
}
}
impl<I, const N: usize> FusedIterator for ArrayChunks<I, N> where I: FusedIterator {}