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
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
use core::{fmt, iter::FusedIterator, mem::MaybeUninit, ops::Range};

use crate::{Array, ArrayShorthand, MaybeUninitSlice};

/// Iterator that moves values out of an array.
///
/// The implementation is very similar to [`std::vec::IntoIter`], however
/// `ArrayIterMove` stores elements on stack and uses indexes instead of
/// pointers.
///
/// ## Examples
/// ```
/// # use arraylib::iter::IterMove;
/// let arr = [1, 2, 3];
/// let mut iter = IterMove::new(arr);
/// assert_eq!(iter.next(), Some(1));
/// assert_eq!(iter.next(), Some(2));
/// assert_eq!(iter.next(), Some(3));
/// assert_eq!(iter.next(), None);
/// ```
/// It's also possible to constract iter using [`ArrayExt::iter_move`]:
/// ```
/// use arraylib::ArrayExt;
///
/// let mut expected = 1;
/// for i in [1, 2, 4, 8, 16, 32, 64, 128].iter_move() {
///     assert_eq!(i, expected);
///     expected *= 2;
/// }
/// ```
/// This iterator **moves** values out of an array, so it works with `!Copy`
/// types:
/// ```
/// use arraylib::iter::IterMove;
///
/// let array = [String::from("hello"), String::from("Tere")];
/// let mut iter = IterMove::new(array);
///
/// let string: String = iter.next().unwrap();
/// assert_eq!(string, "hello");
///
/// let string: String = iter.next().unwrap();
/// assert_eq!(string, "Tere");
/// ```
///
/// ## Implementation details
///
/// Internally `IterMove` represented by `Range<usize>` and
/// `[MaybeUninit<T>; N]` (`MaybeUninit` is needed to take out elements from an
/// array without copying and `UB`).
///
/// The range represents "alive" part of the array, so all elements of
/// `inner[alive]` are initialized.
///
/// Diagram of `IterMove<[u32; 8]>` after consuming 3 elements with [`next`] and
/// 2 with [`next_back`]:
/// ```text
///                    _____.*------ `alive`
///                   /     \
/// inner: [ ~, ~, ~, 1, 2, 3, ~, ~ ]
///          \_____/  \_____/  \__/
///          |              |     `---- elements consumed with `next_back`
///          |              |           (in uninitialized state)
///          |              `---- valid elements in initialized state
///          `---- elements consumed with `next` (in uninitialized state)
/// ```
///
/// [`std::vec::IntoIter`]: https://doc.rust-lang.org/std/vec/struct.IntoIter.html
/// [`ArrayExt::iter_move`]: crate::ArrayExt::iter_move
/// [`next`]: core::iter::Iterator::next
/// [`next_back`]: core::iter::DoubleEndedIterator::next_back
pub struct IterMove<A: Array> {
    // Alive part of the inner array.
    // `inner[alive]` must be initialized.
    alive: Range<usize>,
    inner: A::Maybe,
}

impl<A> IterMove<A>
where
    A: Array,
{
    /// Crate new moving iterator from an array
    #[inline]
    pub fn new(array: A) -> Self {
        Self {
            alive: 0..A::SIZE,
            inner: array.into_uninit(),
        }
    }

    /// Returns the remaining items of this iterator as a slice.
    ///
    /// # Examples
    ///
    /// ```
    /// # use arraylib::ArrayExt;
    /// let arr = ['a', 'b', 'c'];
    ///
    /// let mut iter_move = arr.iter_move();
    /// assert_eq!(iter_move.as_slice(), &['a', 'b', 'c']);
    ///
    /// let _ = iter_move.next().unwrap();
    /// assert_eq!(iter_move.as_slice(), &['b', 'c']);
    /// ```
    #[inline]
    pub fn as_slice(&self) -> &[A::Item] {
        unsafe {
            let slice: &[MaybeUninit<A::Item>] = self.inner.index(self.alive.clone());
            // ## Safety
            //
            // All elements of inner[alive] are guaranteed to be initialized
            slice.assume_init()
        }
    }

    /// Returns the remaining items of this iterator as a mutable slice.
    ///
    /// # Examples
    ///
    /// ```
    /// # use arraylib::ArrayExt;
    /// let arr = ['a', 'b', 'c'];
    ///
    /// let mut iter_move = arr.iter_move();
    /// let _ = iter_move.next().unwrap();
    ///
    /// assert_eq!(iter_move.as_mut_slice(), &mut ['b', 'c']);
    /// iter_move.as_mut_slice()[0] = 'x';
    ///
    /// assert_eq!(iter_move.next().unwrap(), 'x');
    /// assert_eq!(iter_move.next().unwrap(), 'c');
    /// ```
    #[inline]
    pub fn as_mut_slice(&mut self) -> &mut [A::Item] {
        unsafe {
            let slice: &mut [MaybeUninit<A::Item>] = self.inner.index_mut(self.alive.clone());
            // ## Safety
            //
            // All elements of inner[alive] are guaranteed to be initialized
            slice.assume_init_mut()
        }
    }
}

impl<A> Iterator for IterMove<A>
where
    A: Array,
{
    type Item = A::Item;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        unsafe {
            // return if there are no more elements
            let idx = self.alive.next()?;

            // ## Safety
            //
            // `IterMove` guarantees that `inner[alive]`, `idx` is taken from `alive` so
            // `inner[idx]` is initialized at the moment, but shouldn't in the future.
            let result: A::Item = self.inner.replace(idx, MaybeUninit::uninit()).assume_init();

            Some(result)
        }
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        let exact = self.alive.len();
        (exact, Some(exact))
    }

    #[inline]
    fn count(self) -> usize {
        self.alive.len()
    }
}

impl<A> DoubleEndedIterator for IterMove<A>
where
    A: Array,
{
    #[inline]
    fn next_back(&mut self) -> Option<Self::Item> {
        unsafe {
            // return if there are no more elements
            let idx = self.alive.next_back()?;

            // ## Safety
            //
            // `IterMove` guarantees that `inner[alive]`, `idx` is taken from `alive` so
            // `inner[idx]` is initialized at the moment, but shouldn't in the future.
            let result: A::Item = self.inner.replace(idx, MaybeUninit::uninit()).assume_init();

            Some(result)
        }
    }
}

impl<A> ExactSizeIterator for IterMove<A>
where
    A: Array,
{
    #[inline]
    fn len(&self) -> usize {
        self.alive.len()
    }

    #[inline]
    #[cfg(feature = "nightly")]
    fn is_empty(&self) -> bool {
        ExactSizeIterator::is_empty(&self.alive)
    }
}

impl<A> FusedIterator for IterMove<A> where A: Array {}

#[cfg(feature = "nightly")]
unsafe impl<A> core::iter::TrustedLen for IterMove<A> where A: Array {}

impl<A> Clone for IterMove<A>
where
    A: Array,
    A::Item: Clone,
{
    #[inline]
    fn clone(&self) -> Self {
        let inner = {
            // Create an uninitialized array of `MaybeUninit`. The `assume_init` is
            // safe because the type we are claiming to have initialized here is a
            // bunch of `MaybeUninit`s, which do not require initialization.
            let mut array: A::Maybe = A::uninit();

            for i in self.alive.clone() {
                let cloned = unsafe {
                    // ## Safety
                    //
                    // This deref is safe because we know that elements
                    // of `inner[alive]` are initialized
                    (&*self.inner.index(i).as_ptr()).clone()
                };
                *array.index_mut(i) = MaybeUninit::new(cloned);
            }

            array
        };

        Self {
            alive: self.alive.clone(),
            inner,
        }
    }
}

impl<A> fmt::Debug for IterMove<A>
where
    A: Array,
    A::Item: fmt::Debug,
{
    #[inline]
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.debug_tuple("IterMove").field(&self.as_slice()).finish()
    }
}

impl<A> Drop for IterMove<A>
where
    A: Array,
{
    #[inline]
    fn drop(&mut self) {
        for _ in self { /* drop all remaining elements */ }
    }
}

#[cfg(test)]
mod tests {
    use core::{convert::identity, iter};

    use crate::{iter::IterMove, Array};

    #[test]
    fn empty() {
        let arr: [String; 0] = [];
        let mut iter = IterMove::new(arr);

        assert_eq!(iter.next(), None);
    }

    #[test]
    fn test() {
        let arr = <[usize; 5]>::from_fn(identity);
        let iter = IterMove::new(arr);

        assert!(iter.eq(vec![0, 1, 2, 3, 4]));
    }

    #[test]
    fn len() {
        let arr = <[usize; 5]>::from_fn(identity);
        let mut iter = IterMove::new(arr);

        assert_eq!(iter.len(), 5);

        iter.next();
        assert_eq!(iter.len(), 4);

        for _ in iter.by_ref() {}
        assert_eq!(iter.len(), 0);
    }

    #[test]
    fn clone() {
        let arr = <[usize; 5]>::from_fn(identity);
        let mut iter = IterMove::new(arr);

        assert!(iter.clone().eq(vec![0, 1, 2, 3, 4]));

        iter.next();
        iter.next_back();
        assert!(iter.clone().eq(vec![1, 2, 3]));

        for _ in iter.by_ref() {}
        assert!(iter.eq(iter::empty()));
    }

    #[test]
    fn as_slice() {
        let arr = <[usize; 5]>::from_fn(identity);
        let mut iter = IterMove::new(arr);

        assert_eq!(iter.as_slice(), &[0, 1, 2, 3, 4]);
        assert_eq!(iter.as_mut_slice(), &mut [0, 1, 2, 3, 4]);

        iter.next();
        assert_eq!(iter.as_slice(), &[1, 2, 3, 4]);
        assert_eq!(iter.as_mut_slice(), &mut [1, 2, 3, 4]);

        iter.next_back();
        assert_eq!(iter.as_slice(), &[1, 2, 3]);
        assert_eq!(iter.as_mut_slice(), &mut [1, 2, 3]);

        for _ in iter.by_ref() {}
        assert_eq!(iter.as_slice(), &[]);
        assert_eq!(iter.as_mut_slice(), &mut []);
    }

    #[test]
    fn back() {
        let arr = <[usize; 5]>::from_fn(identity);
        let iter = IterMove::new(arr).rev();

        assert!(iter.eq(vec![4, 3, 2, 1, 0]));
    }
}