finit 0.4.0

Finit is a library for defining sets of data, and then performing set operations on them. It is designed to be used for permission systems, but can be used for any kind of data that can be represented as a set.
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

use std::collections::{BTreeMap, HashMap};
pub use std::hash::Hash;

use crate::{
    Set, impl_map, impl_map_comparisons, impl_map_owned_operations, impl_map_ref_operations,
};

impl_map!(HashMap, Key: Hash + Eq);
impl_map_ref_operations!(HashMap, HashMap, Key: Hash + Eq + Clone);
impl_map_ref_operations!(HashMap, BTreeMap, Key: Hash + Ord + Eq + Clone);
impl_map_owned_operations!(HashMap, HashMap, Key: Hash + Eq);
impl_map_owned_operations!(HashMap, BTreeMap, Key: Hash + Ord + Eq);
impl_map_comparisons!(HashMap, HashMap, Key: Hash + Eq);
impl_map_comparisons!(HashMap, BTreeMap, Key: Hash + Ord + Eq);

#[cfg(feature = "phf")]
mod phf_impl {
    use super::*;
    use phf::{Map as PhfMap, OrderedMap as PhfOrderedMap, PhfHash};
    use phf_shared::PhfBorrow;
    impl_map_ref_operations!(HashMap, PhfMap, Key: (Hash + PhfHash + PhfBorrow<Key> + Eq + Clone), entries);
    impl_map_ref_operations!(HashMap, PhfOrderedMap, Key: (Hash + PhfHash + PhfBorrow<Key> + Eq + Clone), entries);
    impl_map_comparisons!(HashMap, PhfMap, Key: (Hash + PhfHash + PhfBorrow<Key> + Eq + Clone));
    impl_map_comparisons!(HashMap, PhfOrderedMap, Key: (Hash + PhfHash + PhfBorrow<Key> + Eq + Clone));
}

#[cfg(test)]
mod tests {
    use core::fmt::Debug;

    use crate::operations::{DifferenceAssign, UnionAssign};
    use maplit::hashmap;
    use rstest::*;

    #[allow(unused_imports)]
    use super::*;

    #[rstest]
    #[case(hashmap! {
        0 => true,
        1 => true,
    }, hashmap! {
        0 => true,
        1 => true,
    }, hashmap! {
        0 => true,
        1 => true,
    })]
    #[case(hashmap! {
        0 => true,
        1 => true,
    }, hashmap! {
        1 => true,
    }, hashmap! {
        0 => true,
        1 => true,
    })]
    #[case(hashmap! {
        1 => true,
    }, hashmap! {
        0 => true,
    }, hashmap! {
        0 => true,
        1 => true,
    })]
    #[case(hashmap! {
        1 => true,
    }, hashmap! {
        1 => true,
    }, hashmap! {
        1 => true,
    })]
    fn union_list_tests<K, V>(
        #[case] mut list1: HashMap<K, V>,
        #[case] list2: HashMap<K, V>,
        #[case] result: HashMap<K, V>,
    ) where
        K: Hash + Eq + Clone + Debug,
        V: Set + PartialEq + Clone + Debug,
        for<'a> V: UnionAssign<&'a V>,
    {
        list1.union_assign(&list2);

        assert_eq!(list1, result);
    }

    #[rstest]
    #[case(hashmap! {
        0 => true,
        1 => true,
    }, hashmap! {
        0 => true,
        1 => true,
    }, hashmap! {})]
    #[case(hashmap! {
        0 => true,
        1 => true,
    }, hashmap! {
        1 => true,
    }, hashmap! {
        0 => true,
    })]
    #[case(hashmap! {
        1 => true,
    }, hashmap! {
        0 => true,
    }, hashmap! {
        1 => true,
    })]
    #[case(hashmap! {
        1 => true,
    }, hashmap! {
        1 => true,
    }, hashmap! {})]
    fn difference_list_tests<K, V>(
        #[case] mut list1: HashMap<K, V>,
        #[case] list2: HashMap<K, V>,
        #[case] result: HashMap<K, V>,
    ) where
        K: Hash + Eq + Clone + Debug,
        V: Set + PartialEq + Clone + Debug,
        for<'a> V: DifferenceAssign<&'a V>,
    {
        list1.difference_assign(&list2);

        assert_eq!(list1, result);
    }
}