ordinal-map 0.1.10

Ordinal trait to map values to integers and efficient maps and sets for such types
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
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

use std::fmt;
use std::fmt::Debug;
use std::fmt::Formatter;
use std::marker::PhantomData;
use std::ops::Range;

use crate::Ordinal;

/// Iterator over [`Ordinal`] values.
///
/// This iterator is created by [`Ordinal::all_values`](Ordinal::all_values).
///
/// # Example
///
/// ```
/// use ordinal_map::Ordinal;
///
/// assert_eq!(vec![false, true], bool::all_values().collect::<Vec<_>>());
/// ```
pub struct OrdinalValues<T> {
    range: Range<usize>,
    _phantom: PhantomData<T>,
}

impl<T: Ordinal> OrdinalValues<T> {
    /// Create a new iterator.
    #[inline]
    pub(crate) fn new() -> Self {
        OrdinalValues {
            range: 0..T::ORDINAL_SIZE,
            _phantom: PhantomData,
        }
    }
}

impl<T: Ordinal> Iterator for OrdinalValues<T> {
    type Item = T;

    #[inline]
    fn next(&mut self) -> Option<Self::Item> {
        let next = self.range.next()?;
        Some(T::from_ordinal(next).unwrap())
    }

    #[inline]
    fn size_hint(&self) -> (usize, Option<usize>) {
        self.range.size_hint()
    }

    #[inline]
    fn count(self) -> usize
    where
        Self: Sized,
    {
        self.range.count()
    }

    #[inline]
    fn last(mut self) -> Option<Self::Item>
    where
        Self: Sized,
    {
        self.next_back()
    }
}

impl<T: Ordinal> ExactSizeIterator for OrdinalValues<T> {
    #[inline]
    fn len(&self) -> usize {
        self.range.len()
    }
}

impl<T: Ordinal> DoubleEndedIterator for OrdinalValues<T> {
    #[inline]
    fn next_back(&mut self) -> Option<Self::Item> {
        let next = self.range.next_back()?;
        Some(T::from_ordinal(next).unwrap())
    }
}

impl<T> Clone for OrdinalValues<T> {
    #[inline]
    fn clone(&self) -> Self {
        OrdinalValues {
            range: self.range.clone(),
            _phantom: PhantomData,
        }
    }
}

impl<T: Ordinal + Debug> Debug for OrdinalValues<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let mut iter = self.clone();
        let Some(first) = iter.next() else {
            return write!(f, "[]");
        };
        if self.range.end == T::ORDINAL_SIZE {
            write!(f, "[{:?}..]", first)
        } else {
            let Some(last) = iter.next_back() else {
                return write!(f, "[{:?}]", first);
            };
            write!(f, "[{:?}..={:?}]", first, last)
        }
    }
}

#[cfg(test)]
mod tests {
    use crate::Ordinal;

    #[test]
    fn test_iter_debug() {
        let mut iter = u8::all_values();
        assert_eq!("[0..]", format!("{:?}", iter));
        iter.next().unwrap();
        assert_eq!("[1..]", format!("{:?}", iter));
        iter.next_back().unwrap();
        assert_eq!("[1..=254]", format!("{:?}", iter));
        assert_eq!(254, iter.len());
        iter.nth(252).unwrap();
        assert_eq!("[254]", format!("{:?}", iter));
    }

    #[test]
    fn test_last() {
        let iter = u8::all_values();
        assert_eq!(Some(255), iter.last());
    }
}