prefix-trie 0.10.1

Prefix trie (tree) datastructure (both a set and a map) that provides exact and longest-prefix matches.
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
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

#[generic_tests::define]
mod t {
    use super::super::*;

    /// Helper: expected address count for a prefix of given length in a `P::num_bits()`-bit space.
    fn expected_count<P: Prefix>(prefix_len: u8) -> P::R {
        let host_bits = P::num_bits() - prefix_len as u32;
        P::R::one() << host_bits as usize
    }

    // ── PrefixMap ──────────────────────────────────────────────────────────

    #[test]
    fn map_address_count_single_prefix<P: Prefix>() {
        let mut pm = Map::<P>::new();
        pm.insert(ip("10.0.0.0/24"), 1);
        assert!(pm.address_count() == Some(expected_count::<P>(24)));
    }

    #[test]
    fn map_address_count_non_overlapping<P: Prefix>() {
        let mut pm = Map::<P>::new();
        pm.insert(ip("10.0.0.0/24"), 1);
        pm.insert(ip("10.0.1.0/24"), 2);
        assert!(pm.address_count() == Some(expected_count::<P>(24) + expected_count::<P>(24)));
    }

    #[test]
    fn map_address_count_overlapping<P: Prefix>() {
        // /24 covers /25; the /25 should not add extra addresses after aggregation
        let mut pm = Map::<P>::new();
        pm.insert(ip("10.0.0.0/24"), 1);
        pm.insert(ip("10.0.0.128/25"), 2);
        assert!(pm.address_count() == Some(expected_count::<P>(24)));
    }

    #[test]
    fn map_address_count_duplicate_prefix<P: Prefix>() {
        let mut pm = Map::<P>::new();
        pm.insert(ip("10.0.0.0/24"), 1);
        pm.insert(ip("10.0.0.0/24"), 2);
        assert!(pm.address_count() == Some(expected_count::<P>(24)));
    }

    #[test]
    fn map_address_count_empty<P: Prefix>() {
        let pm = Map::<P>::new();
        assert!(pm.address_count() == Some(P::R::zero()));
    }

    #[test]
    fn map_address_count_full_space<P: Prefix>() {
        // /0 covers the entire address space, which does not fit in P::R.
        let mut pm = Map::<P>::new();
        pm.insert(ip("0.0.0.0/0"), 1);
        assert!(pm.address_count().is_none());
    }

    #[test]
    fn map_address_count_two_halves<P: Prefix>() {
        // Two /1 prefixes cover the full space, which does not fit in P::R.
        let mut pm = Map::<P>::new();
        pm.insert(ip("0.0.0.0/1"), 1);
        pm.insert(ip("128.0.0.0/1"), 2);
        assert!(pm.address_count().is_none());
    }

    #[test]
    fn map_address_count_subprefix_inside_supernet<P: Prefix>() {
        // /16 + two /24s inside the /16 → aggregated to just /16
        // 10.0.0.0/16 covers 10.0.0.0 – 10.0.255.255
        let mut pm = Map::<P>::new();
        pm.insert(ip("10.0.0.0/16"), 1);
        pm.insert(ip("10.0.0.0/24"), 2);
        pm.insert(ip("10.0.1.0/24"), 3);
        assert!(pm.address_count() == Some(expected_count::<P>(16)));
    }

    #[test]
    fn map_address_count_mixed_overlapping_and_distinct<P: Prefix>() {
        // /16 (covers 10.0.0.0/24) + a distinct /24
        let mut pm = Map::<P>::new();
        pm.insert(ip("10.0.0.0/16"), 1);
        pm.insert(ip("10.0.0.0/24"), 2); // inside /16
        pm.insert(ip("11.0.0.0/24"), 3); // outside /16
        assert!(pm.address_count() == Some(expected_count::<P>(16) + expected_count::<P>(24)));
    }

    // ── PrefixSet ──────────────────────────────────────────────────────────

    #[test]
    fn set_address_count_single_prefix<P: Prefix + Copy + PartialEq>() {
        let set = PrefixSet::<P>::from_iter([ip("10.0.0.0/24")]);
        assert!(set.address_count() == Some(expected_count::<P>(24)));
    }

    #[test]
    fn set_address_count_overlapping<P: Prefix + Copy + PartialEq>() {
        let set = PrefixSet::<P>::from_iter([ip("10.0.0.0/24"), ip("10.0.0.128/25")]);
        assert!(set.address_count() == Some(expected_count::<P>(24)));
    }

    #[test]
    fn set_address_count_empty<P: Prefix + Copy + PartialEq>() {
        let set = PrefixSet::<P>::new();
        assert!(set.address_count() == Some(P::R::zero()));
    }

    #[test]
    fn set_address_count_full_space<P: Prefix + Copy + PartialEq>() {
        let set = PrefixSet::<P>::from_iter([ip("0.0.0.0/0")]);
        assert!(set.address_count().is_none());
    }

    #[test]
    fn set_address_count_non_overlapping<P: Prefix + Copy + PartialEq>() {
        let set = PrefixSet::<P>::from_iter([ip("10.0.0.0/24"), ip("10.0.1.0/24")]);
        assert!(set.address_count() == Some(expected_count::<P>(24) + expected_count::<P>(24)));
    }

    #[test]
    fn set_address_count_two_halves<P: Prefix + Copy + PartialEq>() {
        let set = PrefixSet::<P>::from_iter([ip("0.0.0.0/1"), ip("128.0.0.0/1")]);
        assert!(set.address_count().is_none());
    }

    // ── Instantiations ─────────────────────────────────────────────────────

    #[instantiate_tests(<(u32, u8)>)]
    mod raw32 {}

    #[instantiate_tests(<(u64, u8)>)]
    mod raw64 {}

    #[instantiate_tests(<(u128, u8)>)]
    mod raw128 {}

    #[cfg(feature = "ipnet")]
    #[instantiate_tests(<ipnet::Ipv4Net>)]
    mod ipv4net {}

    #[cfg(feature = "ipnet")]
    #[instantiate_tests(<ipnet::Ipv6Net>)]
    mod ipv6net {}

    #[cfg(feature = "ipnetwork")]
    #[instantiate_tests(<ipnetwork::Ipv4Network>)]
    mod ipv4network {}

    #[cfg(feature = "ipnetwork")]
    #[instantiate_tests(<ipnetwork::Ipv6Network>)]
    mod ipv6network {}

    #[cfg(feature = "cidr")]
    #[instantiate_tests(<cidr::Ipv4Cidr>)]
    mod ipv4cidr {}

    #[cfg(feature = "cidr")]
    #[instantiate_tests(<cidr::Ipv6Cidr>)]
    mod ipv6cidr {}

    #[cfg(feature = "cidr")]
    #[instantiate_tests(<cidr::Ipv4Inet>)]
    mod ipv4inet {}

    #[cfg(feature = "cidr")]
    #[instantiate_tests(<cidr::Ipv6Inet>)]
    mod ipv6inet {}
}

// ── JointPrefixMap tests (ipnet only, not generic) ────────────────────────

#[cfg(feature = "ipnet")]
#[cfg(test)]
mod joint {
    use crate::joint::{JointPrefixMap, JointPrefixSet};

    #[test]
    fn joint_map_address_count_basic() {
        let mut pm: JointPrefixMap<ipnet::IpNet, u32> = JointPrefixMap::new();
        pm.insert("192.0.2.0/24".parse().unwrap(), 1);
        pm.insert("2001:db8::/48".parse().unwrap(), 2);
        let count = pm.address_count();
        assert_eq!(count.0, Some(256));
        assert_eq!(count.1, Some(1u128 << 80));
    }

    #[test]
    fn joint_set_address_count_basic() {
        let mut set: JointPrefixSet<ipnet::IpNet> = JointPrefixSet::new();
        set.insert("192.0.2.0/24".parse().unwrap());
        set.insert("192.0.2.128/25".parse().unwrap());
        set.insert("2001:db8::/48".parse().unwrap());
        assert_eq!(set.address_count(), (Some(256), Some(1u128 << 80)));
    }

    #[test]
    fn joint_map_address_count_empty() {
        let pm: JointPrefixMap<ipnet::IpNet, u32> = JointPrefixMap::new();
        let count = pm.address_count();
        assert_eq!(count.0, Some(0));
        assert_eq!(count.1, Some(0));
    }

    #[test]
    fn joint_map_address_count_full_ipv4_only() {
        let mut pm: JointPrefixMap<ipnet::IpNet, u32> = JointPrefixMap::new();
        pm.insert("0.0.0.0/0".parse().unwrap(), 1);
        let count = pm.address_count();
        // 2^32 does not fit in u32.
        assert_eq!(count.0, None);
        assert_eq!(count.1, Some(0));
    }

    #[test]
    fn joint_map_address_count_full_ipv6_only() {
        let mut pm: JointPrefixMap<ipnet::IpNet, u32> = JointPrefixMap::new();
        pm.insert("::/0".parse().unwrap(), 1);
        let count = pm.address_count();
        assert_eq!(count.0, Some(0));
        assert_eq!(count.1, None); // 2^128 does not fit in u128
    }

    #[test]
    fn joint_map_address_count_both_full() {
        let mut pm: JointPrefixMap<ipnet::IpNet, u32> = JointPrefixMap::new();
        pm.insert("0.0.0.0/0".parse().unwrap(), 1);
        pm.insert("::/0".parse().unwrap(), 2);
        let count = pm.address_count();
        assert_eq!(count.0, None);
        assert_eq!(count.1, None);
    }

    #[test]
    fn joint_map_address_count_overlapping_v4() {
        let mut pm: JointPrefixMap<ipnet::IpNet, u32> = JointPrefixMap::new();
        pm.insert("192.0.2.0/24".parse().unwrap(), 1);
        pm.insert("192.0.2.128/25".parse().unwrap(), 2);
        pm.insert("198.51.100.0/24".parse().unwrap(), 3);
        let count = pm.address_count();
        assert_eq!(count.0, Some(512));
        assert_eq!(count.1, Some(0));
    }

    #[test]
    fn joint_map_address_count_overlapping_v6() {
        let mut pm: JointPrefixMap<ipnet::IpNet, u32> = JointPrefixMap::new();
        pm.insert("2001:db8::/48".parse().unwrap(), 1);
        pm.insert("2001:db8::/64".parse().unwrap(), 2); // inside /48
        pm.insert("2001:db9::/48".parse().unwrap(), 3); // distinct
        let count = pm.address_count();
        // /48 + /48 = 2 * 2^80
        assert_eq!(count.0, Some(0));
        assert_eq!(count.1, Some(2 * (1u128 << 80)));
    }
}