non-empty-iter 0.2.0

Non-empty iterators.
Documentation 
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

//! Iterating over only the first provided number of items in non-empty iterators.

use core::iter;

use non_zero_size::Size;

use crate::non_empty::NonEmptyIterator;

/// Represents non-empty iterators that only iterate over the first given number of items
/// of the underlying iterator.
#[derive(Debug, Clone)]
#[must_use = "non-empty iterators are lazy and do nothing unless consumed"]
pub struct Take<I: NonEmptyIterator> {
    non_empty: I,
    count: Size,
}

impl<I: NonEmptyIterator> Take<I> {
    /// Constructs [`Self`].
    pub const fn new(non_empty: I, count: Size) -> Self {
        Self { non_empty, count }
    }
}

impl<I: NonEmptyIterator> IntoIterator for Take<I> {
    type Item = I::Item;

    type IntoIter = iter::Take<I::IntoIter>;

    fn into_iter(self) -> Self::IntoIter {
        self.non_empty.into_iter().take(self.count.get())
    }
}

unsafe impl<I: NonEmptyIterator> NonEmptyIterator for Take<I> {}