poptrie 0.2.0

A pure-rust implementation of poptrie
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

use core::net::{Ipv4Addr, Ipv6Addr};

use crate::address::Address;

/// A prefix is a pattern to match the beginning of a sequence, in this case called an
/// `ADDRESS`. The prefix is represented by an `ADDRESS` and a `prefix_length` that
/// defines the number of bits in the prefix (counted from the most significant bits).
///
/// # Examples
///
/// ```
/// use poptrie::{Poptrie, Prefix};
///
/// let mut trie = Poptrie::<(u32, u8), &str>::new();
/// trie.insert((u32::from_be_bytes([10, 0, 0, 0]), 8), "10/8");
/// assert_eq!(trie.lookup(u32::from_be_bytes([10, 1, 2, 3])), Some(&"10/8"));
/// ```
///
/// Implementing `Prefix` for a custom type:
/// ```
/// use poptrie::{Prefix};
///
/// #[derive(Clone, Copy, PartialEq, Eq)]
/// struct Ipv4Net { addr: u32, len: u8 }
///
/// impl Prefix for Ipv4Net {
///     type ADDRESS = u32;
///     fn address(&self) -> u32 { self.addr }
///     fn prefix_length(&self) -> u8 { self.len }
/// }
/// ```
pub trait Prefix: Copy {
    /// The underlying address type.
    type ADDRESS: Address;

    /// Returns the address part of the prefix.
    fn address(&self) -> Self::ADDRESS;

    /// Returns the prefix length (number of significant bits).
    fn prefix_length(&self) -> u8;
}

impl<A: Address> Prefix for (A, u8) {
    type ADDRESS = A;

    #[inline(always)]
    fn address(&self) -> Self::ADDRESS {
        self.0
    }

    #[inline(always)]
    fn prefix_length(&self) -> u8 {
        self.1
    }
}

impl Prefix for (Ipv4Addr, u8) {
    type ADDRESS = u32;

    #[inline(always)]
    fn address(&self) -> Self::ADDRESS {
        self.0.to_bits()
    }

    #[inline(always)]
    fn prefix_length(&self) -> u8 {
        self.1
    }
}

impl Prefix for (Ipv6Addr, u8) {
    type ADDRESS = u128;

    #[inline(always)]
    fn address(&self) -> Self::ADDRESS {
        self.0.to_bits()
    }

    #[inline(always)]
    fn prefix_length(&self) -> u8 {
        self.1
    }
}

#[cfg(feature = "ipnet")]
impl Prefix for ipnet::Ipv4Net {
    type ADDRESS = u32;

    #[inline(always)]
    fn address(&self) -> Self::ADDRESS {
        u32::from(self.network())
    }

    #[inline(always)]
    fn prefix_length(&self) -> u8 {
        self.prefix_len()
    }
}

#[cfg(feature = "ipnet")]
impl Prefix for ipnet::Ipv6Net {
    type ADDRESS = u128;

    #[inline(always)]
    fn address(&self) -> Self::ADDRESS {
        u128::from(self.network())
    }

    #[inline(always)]
    fn prefix_length(&self) -> u8 {
        self.prefix_len()
    }
}

#[cfg(feature = "cidr")]
impl Prefix for cidr::Ipv4Cidr {
    type ADDRESS = u32;

    #[inline(always)]
    fn address(&self) -> Self::ADDRESS {
        self.first_address().into()
    }

    #[inline(always)]
    fn prefix_length(&self) -> u8 {
        self.network_length()
    }
}

#[cfg(feature = "cidr")]
impl Prefix for cidr::Ipv6Cidr {
    type ADDRESS = u128;

    #[inline(always)]
    fn address(&self) -> Self::ADDRESS {
        self.first_address().into()
    }

    #[inline(always)]
    fn prefix_length(&self) -> u8 {
        self.network_length()
    }
}