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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
use std::boxed::Box;
use std::mem;

use super::{Prefix, Range};
use crate::traits::{self, Afi};

mod iter;
use self::iter::{Prefixes, Ranges};

mod node;
use self::node::Node;

mod ops;

/// A collection of IP prefixes, providing fast insertion and iteration,
/// and set-theorectic arithmetic.
///
/// This is a Rust implementation derived in large part from the internal
/// data-structure used in the widely used [`bgpq3`] tool by Alexandre Snarskii,
/// packaged as a library, and with set-theoretic operations added.
///
/// # Examples
///
/// ``` rust
/// use ip::{traits::PrefixSet as _, Error, Ipv6, Prefix, PrefixLength, PrefixRange, PrefixSet};
///
/// fn main() -> Result<(), Error> {
///     // create a set by parsing a Vec<&str>
///     let set: PrefixSet<Ipv6> = ["2001:db8::/37", "2001:db8:f00::/37"]
///         .into_iter()
///         .map(|s| s.parse::<Prefix<Ipv6>>())
///         .collect::<Result<_, _>>()?;
///
///     // create a range by parsing a &str and providing the lower
///     // and upper prefix lenth bounds
///     let length = PrefixLength::<Ipv6>::from_primitive(37)?;
///     let range = PrefixRange::<Ipv6>::new("2001:db8::/36".parse()?, length..=length)?;
///
///     assert_eq!(set.ranges().collect::<Vec<_>>(), vec![range]);
///     Ok(())
/// }
/// ```
///
/// Most mutating methods return `&mut Self` for easy chaining, e.g.:
///
/// ``` rust
/// # use ip::{traits::PrefixSet as _, Error, Ipv4, Prefix, PrefixSet};
/// let set = PrefixSet::<Ipv4>::new()
///     .insert("192.0.2.0/24".parse::<Prefix<Ipv4>>()?)
///     .to_owned();
/// assert_eq!(set.len(), 1);
/// # Ok::<_, Error>(())
/// ```
///
/// [`bgpq3`]: https://github.com/snar/bgpq3
#[derive(Clone, Debug)]
pub struct Set<A: Afi> {
    root: Option<Box<Node<A>>>,
}

impl<A: Afi> Set<A> {
    /// Construct a new, empty [`PrefixSet<A>`][Self].
    #[must_use]
    pub const fn new() -> Self {
        Self::new_with_root(None)
    }

    const fn new_with_root(root: Option<Box<Node<A>>>) -> Self {
        Self { root }
    }

    fn insert_node(&mut self, new: Box<Node<A>>) -> &mut Self {
        match mem::take(&mut self.root) {
            Some(root) => {
                self.root = Some(root.add(new));
            }
            None => {
                self.root = Some(new);
            }
        };
        self
    }

    pub(crate) fn insert_only<T>(&mut self, item: T) -> &mut Self
    where
        T: Into<Node<A>>,
    {
        self.insert_node(item.into().boxed())
    }

    /// Insert a new `item` into `self`.
    ///
    /// `T` can be either a [`Prefix<A>`](crate::concrete::Prefix) or a
    /// [`PrefixRange<A>`](crate::concrete::PrefixRange).
    ///
    /// ``` rust
    /// # use ip::{traits::PrefixSet as _, Error, Ipv6, PrefixRange, PrefixSet};
    /// let range: PrefixRange<Ipv6> = "2001:db8:f00::/48,64,64".parse()?;
    /// let set = PrefixSet::<Ipv6>::new().insert(range).to_owned();
    /// assert_eq!(set.len(), 1 << 16);
    /// # Ok::<_, Error>(())
    /// ```
    pub fn insert<T>(&mut self, item: T) -> &mut Self
    where
        T: Into<Node<A>>,
    {
        self.insert_only(item).aggregate()
    }

    /// Insert items into `self` from an iterator yielding either
    /// [`Prefix<A>`](crate::concrete::Prefix) or
    /// [`PrefixRange<A>`](crate::concrete::PrefixRange).
    ///
    /// Aggregation occurs after all items are inserted, making this far more
    /// efficient than calling [`PrefixSet::insert()`][Self::insert] repeatedly.
    ///
    /// ``` rust
    /// # use ip::{traits::PrefixSet as _, Error, Ipv4, Prefix, PrefixSet};
    /// let prefixes: Vec<_> = ["192.0.2.0/26", "192.0.2.64/26"]
    ///     .into_iter()
    ///     .map(|s| s.parse::<Prefix<Ipv4>>())
    ///     .collect::<Result<_, _>>()?;
    /// let set = PrefixSet::<Ipv4>::new().insert_from(prefixes).to_owned();
    /// assert_eq!(set.len(), 2);
    /// # Ok::<_, Error>(())
    /// ```
    pub fn insert_from<I, T>(&mut self, iter: I) -> &mut Self
    where
        I: IntoIterator<Item = T>,
        T: Into<Node<A>>,
    {
        iter.into_iter()
            .fold(self, |set, item| set.insert_only(item))
            .aggregate()
    }

    fn remove_node(&mut self, mut old: Box<Node<A>>) -> &mut Self {
        if let Some(root) = mem::take(&mut self.root) {
            self.root = Some(root.remove(&mut old));
        };
        self
    }

    /// Remove an `item` from `self`.
    ///
    /// `T` can be either a [`Prefix<A>`](crate::concrete::Prefix) or a
    /// [`PrefixRange<A>`](crate::concrete::PrefixRange).
    ///
    /// ``` rust
    /// # use ip::{traits::PrefixSet as _, Error, Ipv6, Prefix, PrefixSet};
    /// let set = ["2001:db8:f00::/48", "2001:db8:baa::/48"]
    ///     .into_iter()
    ///     .map(|s| s.parse::<Prefix<Ipv6>>())
    ///     .collect::<Result<PrefixSet<Ipv6>, _>>()?
    ///     .remove("2001:db8:f00::/48".parse::<Prefix<Ipv6>>()?)
    ///     .to_owned();
    /// assert_eq!(set.len(), 1);
    /// # Ok::<_, Error>(())
    /// ```
    pub fn remove<T>(&mut self, item: T) -> &mut Self
    where
        T: Into<Node<A>>,
    {
        self.remove_node(item.into().boxed()).aggregate()
    }

    /// Remove items from `self` from an iterator yielding either
    /// [`Prefix<A>`](crate::concrete::Prefix) or
    /// [`PrefixRange<A>`](crate::concrete::PrefixRange).
    ///
    /// Aggregation occurs after all items are removed, making this far more
    /// efficient than calling [`PrefixSet::remove()`][Self::remove] repeatedly.
    ///
    /// ``` rust
    /// # use ip::{traits::PrefixSet as _, Error, Ipv4, Prefix, PrefixRange, PrefixSet};
    /// let prefixes: Vec<_> = vec!["192.0.2.0/26", "192.0.2.64/26"]
    ///     .into_iter()
    ///     .map(|s| s.parse::<Prefix<Ipv4>>())
    ///     .collect::<Result<_, _>>()?;
    /// let mut set = PrefixSet::<Ipv4>::new()
    ///     .insert("192.0.2.0/24,26,26".parse::<PrefixRange<Ipv4>>()?)
    ///     .to_owned();
    /// assert_eq!(set.remove_from(prefixes).len(), 2);
    /// # Ok::<_, Error>(())
    /// ```
    pub fn remove_from<I, T>(&mut self, iter: I) -> &mut Self
    where
        I: IntoIterator<Item = T>,
        T: Into<Node<A>>,
    {
        iter.into_iter()
            .fold(self, |set, item| set.remove_node(item.into().boxed()))
            .aggregate()
    }

    pub(crate) fn aggregate(&mut self) -> &mut Self {
        if let Some(root) = mem::take(&mut self.root) {
            self.root = root.aggregate(None);
        }
        self
    }

    /// Clear the contents of `self`
    ///
    /// ``` rust
    /// # use ip::{traits::PrefixSet as _, Error, Ipv6, Prefix, PrefixSet};
    /// let mut set = PrefixSet::<Ipv6>::new()
    ///     .insert("2001:db8::/32".parse::<Prefix<Ipv6>>()?)
    ///     .to_owned();
    /// assert!(!set.is_empty());
    /// set.clear();
    /// assert!(set.is_empty());
    /// # Ok::<_, Error>(())
    /// ```
    pub fn clear(&mut self) {
        self.root = None;
    }
}

impl<'a, A: Afi> traits::PrefixSet<'a> for Set<A> {
    type Prefix = Prefix<A>;
    type Range = Range<A>;
    type Prefixes = Prefixes<'a, A>;
    type Ranges = Ranges<'a, A>;

    fn prefixes(&'a self) -> Self::Prefixes {
        self.into()
    }

    fn ranges(&'a self) -> Self::Ranges {
        self.into()
    }

    fn contains(&self, prefix: Self::Prefix) -> bool {
        self.root
            .as_ref()
            .map_or(false, |root| root.search(&prefix.into()).is_some())
    }
}

impl<A: Afi> Default for Set<A> {
    fn default() -> Self {
        Self::new()
    }
}

impl<A: Afi, U> Extend<U> for Set<A>
where
    U: Into<Node<A>>,
{
    #[allow(unused_results)]
    fn extend<T>(&mut self, iter: T)
    where
        T: IntoIterator<Item = U>,
    {
        self.insert_from(iter);
    }
}

impl<A: Afi, T> FromIterator<T> for Set<A>
where
    T: Into<Node<A>>,
{
    fn from_iter<I>(iter: I) -> Self
    where
        I: IntoIterator<Item = T>,
    {
        Self::new().insert_from(iter).clone()
    }
}

#[cfg(test)]
mod tests;