enumeration 3.3.2

An extension to rust enum
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

#![cfg_attr(feature = "map", allow(incomplete_features))]
#![cfg_attr(feature = "map", feature(generic_const_exprs))]

//! This modules provides utilities to the crate

use crate::prelude::*;

/// Iterator helper
pub trait IteratorHelper
where
    Self: Sized,
{
    #[inline(always)]
    /// Convert index into variant
    fn variants<E: Enumeration>(self) -> impl Iterator<Item = Result<E, E::Error>>
    where
        Self: IntoIterator<Item = E::Index>,
    {
        self.into_iter().map(E::variant)
    }

    #[inline(always)]
    /// Convert index into variant, panic upon error
    fn variants_unwrap<E: Enumeration>(self) -> impl Iterator<Item = E>
    where
        Self: IntoIterator<Item = E::Index>,
    {
        self.variants().map(Result::unwrap)
    }

    #[inline(always)]
    /// Convert index into variant without checking
    unsafe fn variants_unchecked<E: Enumeration>(self) -> impl Iterator<Item = E>
    where
        Self: IntoIterator<Item = E::Index>,
    {
        self.into_iter().map(|i| unsafe { E::variant_unchecked(i) })
    }

    #[inline(always)]
    /// Convert index into variant without checking
    fn values<E: Enumeration>(self) -> impl Iterator<Item = (E, &'static E::AssociatedValueType)>
    where
        Self: IntoIterator<Item = E>,
    {
        self.into_iter().map(|e| (e, e.value()))
    }

    #[inline(always)]
    /// Convert index into variant without checking
    fn index_values<E: Enumeration>(
        self,
    ) -> impl Iterator<Item = (E::Index, &'static E::AssociatedValueType)>
    where
        Self: IntoIterator<Item = E>,
    {
        self.into_iter().map(|e| (e.to_index(), e.value()))
    }

    #[inline(always)]
    /// Convert index into variant without checking
    fn usize_values<E: Enumeration>(
        self,
    ) -> impl Iterator<Item = (usize, &'static E::AssociatedValueType)>
    where
        Self: IntoIterator<Item = E>,
        E::Index: Into<usize>,
    {
        self.into_iter().map(|e| (e.to_index().into(), e.value()))
    }
}

impl<T: Iterator> IteratorHelper for T {}