ipnetwork/
ipv4.rs

1use std::{convert::TryFrom, fmt, net::Ipv4Addr, str::FromStr};
2
3use crate::{
4    error::IpNetworkError,
5    parse::{cidr_parts, parse_prefix},
6};
7
8const IPV4_BITS: u8 = 32;
9
10/// Represents a network range where the IP addresses are of v4
11#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
12pub struct Ipv4Network {
13    addr: Ipv4Addr,
14    prefix: u8,
15}
16
17#[cfg(feature = "serde")]
18impl<'de> serde::Deserialize<'de> for Ipv4Network {
19    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
20    where
21        D: serde::Deserializer<'de>,
22    {
23        let s = <String>::deserialize(deserializer)?;
24        Ipv4Network::from_str(&s).map_err(serde::de::Error::custom)
25    }
26}
27
28#[cfg(feature = "serde")]
29impl serde::Serialize for Ipv4Network {
30    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
31    where
32        S: serde::Serializer,
33    {
34        serializer.collect_str(self)
35    }
36}
37
38#[cfg(feature = "schemars")]
39impl schemars::JsonSchema for Ipv4Network {
40    fn schema_name() -> std::borrow::Cow<'static, str> {
41        std::borrow::Cow::Borrowed("Ipv4Network")
42    }
43
44    fn json_schema(_: &mut schemars::SchemaGenerator) -> schemars::Schema {
45        schemars::json_schema!({
46            "type": "string",
47            "pattern": concat!(
48                r#"^((25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\.){3}"#,
49                r#"(25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)"#,
50                r#"\/(3[0-2]|[0-2]?[0-9])$"#,
51            ),
52            "x-rust-type": "ipnetwork::Ipv4Network"
53        })
54    }
55}
56
57impl Ipv4Network {
58    /// Constructs a new `Ipv4Network` from any `Ipv4Addr` and a prefix denoting the network size.
59    ///
60    /// If the prefix is larger than 32 this will return an `IpNetworkError::InvalidPrefix`.
61    pub const fn new(addr: Ipv4Addr, prefix: u8) -> Result<Ipv4Network, IpNetworkError> {
62        match Ipv4Network::new_checked(addr, prefix) {
63            Some(a) => Ok(a),
64            None => Err(IpNetworkError::InvalidPrefix),
65        }
66    }
67
68    /// Constructs a new `Ipv4Network` from any `Ipv4Addr`, and a prefix denoting the network size.
69    ///
70    /// If the prefix is larger than 32 this will return `None`. This is useful in const contexts,
71    /// where [`Option::unwrap`] may be called to trigger a compile-time error in case the prefix
72    /// is an unexpected value.
73    ///
74    /// # Examples
75    ///
76    /// ```
77    /// use std::net::Ipv4Addr;
78    /// use ipnetwork::Ipv4Network;
79    ///
80    /// const PREFIX: u8 = 24;
81    /// const ADDR: Ipv4Addr = Ipv4Addr::new(192, 168, 1, 1);
82    ///
83    /// // Okay!
84    /// const NETWORK: Ipv4Network = Ipv4Network::new_checked(ADDR, PREFIX).unwrap();
85    /// assert_eq!(NETWORK.prefix(), PREFIX);
86    /// ```
87    ///
88    /// ```should_panic
89    /// use std::net::Ipv4Addr;
90    /// use ipnetwork::Ipv4Network;
91    ///
92    /// // Prefix is greater than 32.
93    /// const PREFIX: u8 = 32 + 1;
94    /// const ADDR: Ipv4Addr = Ipv4Addr::new(192, 168, 1, 1);
95    ///
96    /// // This fails!
97    /// const NETWORK: Option<Ipv4Network> = Ipv4Network::new_checked(ADDR, PREFIX);
98    /// assert_eq!(NETWORK.unwrap().prefix(), PREFIX);
99    /// ```
100    pub const fn new_checked(addr: Ipv4Addr, prefix: u8) -> Option<Ipv4Network> {
101        if prefix > IPV4_BITS {
102            None
103        } else {
104            Some(Ipv4Network {
105                addr,
106                prefix,
107            })
108        }
109    }
110
111    /// Constructs a new `Ipv4Network` from a network address and a network mask.
112    ///
113    /// If the netmask is not valid this will return an `IpNetworkError::InvalidPrefix`.
114    pub fn with_netmask(netaddr: Ipv4Addr, netmask: Ipv4Addr) -> Result<Ipv4Network, IpNetworkError> {
115        let prefix = ipv4_mask_to_prefix(netmask)?;
116        let net = Self {
117            addr: netaddr,
118            prefix,
119        };
120        Ok(net)
121    }
122
123    /// Returns an iterator over `Ipv4Network`. Each call to `next` will return the next
124    /// `Ipv4Addr` in the given network. `None` will be returned when there are no more
125    /// addresses.
126    pub fn iter(self) -> Ipv4NetworkIterator {
127        let start = u32::from(self.network());
128        let end = start + (self.size() - 1);
129        Ipv4NetworkIterator {
130            next: Some(start),
131            end,
132        }
133    }
134
135    pub const fn ip(self) -> Ipv4Addr {
136        self.addr
137    }
138
139    pub const fn prefix(self) -> u8 {
140        self.prefix
141    }
142
143    /// Checks if the given `Ipv4Network` is a subnet of the other.
144    pub fn is_subnet_of(self, other: Ipv4Network) -> bool {
145        other.ip() <= self.ip() && other.broadcast() >= self.broadcast()
146    }
147
148    /// Checks if the given `Ipv4Network` is a supernet of the other.
149    pub fn is_supernet_of(self, other: Ipv4Network) -> bool {
150        other.is_subnet_of(self)
151    }
152
153    /// Checks if the given `Ipv4Network` is partly contained in other.
154    pub fn overlaps(self, other: Ipv4Network) -> bool {
155        other.contains(self.ip())
156            || other.contains(self.broadcast())
157            || self.contains(other.ip())
158            || self.contains(other.broadcast())
159    }
160
161    /// Returns the mask for this `Ipv4Network`.
162    /// That means the `prefix` most significant bits will be 1 and the rest 0
163    ///
164    /// # Examples
165    ///
166    /// ```
167    /// use std::net::Ipv4Addr;
168    /// use ipnetwork::Ipv4Network;
169    ///
170    /// let net: Ipv4Network = "127.0.0.0".parse().unwrap();
171    /// assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 255, 255));
172    /// let net: Ipv4Network = "127.0.0.0/16".parse().unwrap();
173    /// assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 0, 0));
174    /// ```
175    pub const fn mask(&self) -> Ipv4Addr {
176        debug_assert!(self.prefix <= 32);
177        if self.prefix == 0 {
178            return Ipv4Addr::new(0, 0, 0, 0);
179        }
180        let mask = u32::MAX << (IPV4_BITS - self.prefix);
181        Ipv4Addr::from_bits(mask)
182    }
183
184    /// Returns the address of the network denoted by this `Ipv4Network`.
185    /// This means the lowest possible IPv4 address inside of the network.
186    ///
187    /// # Examples
188    ///
189    /// ```
190    /// use std::net::Ipv4Addr;
191    /// use ipnetwork::Ipv4Network;
192    ///
193    /// let net: Ipv4Network = "10.1.9.32/16".parse().unwrap();
194    /// assert_eq!(net.network(), Ipv4Addr::new(10, 1, 0, 0));
195    /// ```
196    pub const fn network(&self) -> Ipv4Addr {
197        let mask = self.mask().to_bits();
198        let ip = self.addr.to_bits() & mask;
199        Ipv4Addr::from_bits(ip)
200    }
201
202    /// Returns the broadcasting address of this `Ipv4Network`.
203    /// This means the highest possible IPv4 address inside of the network.
204    ///
205    /// # Examples
206    ///
207    /// ```
208    /// use std::net::Ipv4Addr;
209    /// use ipnetwork::Ipv4Network;
210    ///
211    /// let net: Ipv4Network = "10.9.0.32/16".parse().unwrap();
212    /// assert_eq!(net.broadcast(), Ipv4Addr::new(10, 9, 255, 255));
213    /// ```
214    pub const fn broadcast(&self) -> Ipv4Addr {
215        let mask = self.mask().to_bits();
216        let broadcast = self.addr.to_bits() | !mask;
217        Ipv4Addr::from_bits(broadcast)
218    }
219
220    /// Checks if a given `Ipv4Addr` is in this `Ipv4Network`
221    ///
222    /// # Examples
223    ///
224    /// ```
225    /// use std::net::Ipv4Addr;
226    /// use ipnetwork::Ipv4Network;
227    ///
228    /// let net: Ipv4Network = "127.0.0.0/24".parse().unwrap();
229    /// assert!(net.contains(Ipv4Addr::new(127, 0, 0, 70)));
230    /// assert!(!net.contains(Ipv4Addr::new(127, 0, 1, 70)));
231    /// ```
232    #[inline]
233    pub const fn contains(&self, ip: Ipv4Addr) -> bool {
234        debug_assert!(self.prefix <= IPV4_BITS);
235
236        let mask = !(0xffff_ffff_u64 >> self.prefix) as u32;
237        let net = self.addr.to_bits() & mask;
238        (ip.to_bits() & mask) == net
239    }
240
241    /// Returns number of possible host addresses in this `Ipv4Network`.
242    ///
243    /// # Examples
244    ///
245    /// ```
246    /// use std::net::Ipv4Addr;
247    /// use ipnetwork::Ipv4Network;
248    ///
249    /// let net: Ipv4Network = "10.1.0.0/16".parse().unwrap();
250    /// assert_eq!(net.size(), 65536);
251    ///
252    /// let tinynet: Ipv4Network = "0.0.0.0/32".parse().unwrap();
253    /// assert_eq!(tinynet.size(), 1);
254    /// ```
255    pub fn size(self) -> u32 {
256        debug_assert!(self.prefix <= 32);
257        if self.prefix == 0 {
258            return u32::MAX;
259        }
260        1 << (IPV4_BITS - self.prefix)
261    }
262
263    /// Returns the `n`:th address within this network.
264    /// The adresses are indexed from 0 and `n` must be smaller than the size of the network.
265    ///
266    /// # Examples
267    ///
268    /// ```
269    /// use std::net::Ipv4Addr;
270    /// use ipnetwork::Ipv4Network;
271    ///
272    /// let net: Ipv4Network = "192.168.0.0/24".parse().unwrap();
273    /// assert_eq!(net.nth(0).unwrap(), Ipv4Addr::new(192, 168, 0, 0));
274    /// assert_eq!(net.nth(15).unwrap(), Ipv4Addr::new(192, 168, 0, 15));
275    /// assert!(net.nth(256).is_none());
276    ///
277    /// let net2: Ipv4Network = "10.0.0.0/16".parse().unwrap();
278    /// assert_eq!(net2.nth(256).unwrap(), Ipv4Addr::new(10, 0, 1, 0));
279    /// ```
280    pub fn nth(self, n: u32) -> Option<Ipv4Addr> {
281        if n < self.size() {
282            let net = u32::from(self.network());
283            Some(Ipv4Addr::from(net + n))
284        } else {
285            None
286        }
287    }
288}
289
290impl fmt::Display for Ipv4Network {
291    fn fmt(&self, fmt: &mut fmt::Formatter<'_>) -> fmt::Result {
292        write!(fmt, "{}/{}", self.ip(), self.prefix())
293    }
294}
295
296/// Creates an `Ipv4Network` from parsing a string in CIDR notation.
297///
298/// # Examples
299///
300/// ```
301/// use std::net::Ipv4Addr;
302/// use ipnetwork::Ipv4Network;
303///
304/// let new = Ipv4Network::new(Ipv4Addr::new(10, 1, 9, 32), 16).unwrap();
305/// let from_cidr: Ipv4Network = "10.1.9.32/16".parse().unwrap();
306/// assert_eq!(new.ip(), from_cidr.ip());
307/// assert_eq!(new.prefix(), from_cidr.prefix());
308/// ```
309impl FromStr for Ipv4Network {
310    type Err = IpNetworkError;
311    fn from_str(s: &str) -> Result<Self, Self::Err> {
312        let (addr_str, prefix_str) = cidr_parts(s)?;
313        let addr = Ipv4Addr::from_str(addr_str)?;
314        let prefix = match prefix_str {
315            Some(v) => {
316                if let Ok(netmask) = Ipv4Addr::from_str(v) {
317                    ipv4_mask_to_prefix(netmask)?
318                } else {
319                    parse_prefix(v, IPV4_BITS)?
320                }
321            }
322            None => IPV4_BITS,
323        };
324        Ipv4Network::new(addr, prefix)
325    }
326}
327
328impl TryFrom<&str> for Ipv4Network {
329    type Error = IpNetworkError;
330
331    fn try_from(s: &str) -> Result<Self, Self::Error> {
332        Ipv4Network::from_str(s)
333    }
334}
335
336impl From<Ipv4Addr> for Ipv4Network {
337    fn from(a: Ipv4Addr) -> Ipv4Network {
338        Ipv4Network {
339            addr: a,
340            prefix: 32,
341        }
342    }
343}
344
345#[derive(Clone, Debug)]
346pub struct Ipv4NetworkIterator {
347    next: Option<u32>,
348    end: u32,
349}
350
351impl Iterator for Ipv4NetworkIterator {
352    type Item = Ipv4Addr;
353
354    fn next(&mut self) -> Option<Ipv4Addr> {
355        let next = self.next?;
356        self.next = if next == self.end { None } else { Some(next + 1) };
357        Some(next.into())
358    }
359
360    fn size_hint(&self) -> (usize, Option<usize>) {
361        if let Some(n) = self.next {
362            let elms = (self.end - n + 1) as usize;
363            (elms, Some(elms))
364        } else {
365            (0, None)
366        }
367    }
368}
369
370impl IntoIterator for &'_ Ipv4Network {
371    type IntoIter = Ipv4NetworkIterator;
372    type Item = Ipv4Addr;
373    fn into_iter(self) -> Ipv4NetworkIterator {
374        self.iter()
375    }
376}
377
378/// Converts a `Ipv4Addr` network mask into a prefix.
379///
380/// If the mask is invalid this will return an `IpNetworkError::InvalidPrefix`.
381pub fn ipv4_mask_to_prefix(mask: Ipv4Addr) -> Result<u8, IpNetworkError> {
382    match ipv4_mask_to_prefix_checked(mask) {
383        Some(prefix) => Ok(prefix),
384        None => Err(IpNetworkError::InvalidPrefix),
385    }
386}
387
388/// Converts a `Ipv4Addr` network mask into a prefix.
389///
390/// If the mask is invalid this will return `None`. This is useful in const contexts where
391/// [`Option::unwrap`] may be called to trigger a compile-time error if the prefix is invalid.
392pub const fn ipv4_mask_to_prefix_checked(mask: Ipv4Addr) -> Option<u8> {
393    let mask = mask.to_bits();
394
395    let prefix = (!mask).leading_zeros() as u8;
396    if ((mask as u64) << prefix) & 0xffff_ffff != 0 {
397        None
398    } else {
399        Some(prefix)
400    }
401}
402
403#[cfg(test)]
404mod test {
405    use std::{collections::HashMap, mem, net::Ipv4Addr};
406
407    use super::*;
408
409    #[test]
410    fn create_v4() {
411        let cidr = Ipv4Network::new(Ipv4Addr::new(77, 88, 21, 11), 24).unwrap();
412        assert_eq!(cidr.prefix(), 24);
413    }
414
415    #[test]
416    fn create_v4_invalid_prefix() {
417        let net = Ipv4Network::new(Ipv4Addr::new(0, 0, 0, 0), 33);
418        assert!(net.is_err());
419    }
420
421    #[test]
422    fn create_checked_v4() {
423        let cidr = Ipv4Network::new_checked(Ipv4Addr::new(77, 88, 21, 11), 24).unwrap();
424        assert_eq!(cidr.prefix(), 24);
425    }
426
427    #[test]
428    #[should_panic]
429    fn try_create_invalid_checked_v4() {
430        Ipv4Network::new_checked(Ipv4Addr::new(0, 0, 0, 0), 33).unwrap();
431    }
432
433    #[test]
434    fn parse_v4_24bit() {
435        let cidr: Ipv4Network = "127.1.0.0/24".parse().unwrap();
436        assert_eq!(cidr.ip(), Ipv4Addr::new(127, 1, 0, 0));
437        assert_eq!(cidr.prefix(), 24);
438    }
439
440    #[test]
441    fn parse_v4_32bit() {
442        let cidr: Ipv4Network = "127.0.0.0/32".parse().unwrap();
443        assert_eq!(cidr.ip(), Ipv4Addr::new(127, 0, 0, 0));
444        assert_eq!(cidr.prefix(), 32);
445    }
446
447    #[test]
448    fn parse_v4_noprefix() {
449        let cidr: Ipv4Network = "127.0.0.0".parse().unwrap();
450        assert_eq!(cidr.ip(), Ipv4Addr::new(127, 0, 0, 0));
451        assert_eq!(cidr.prefix(), 32);
452    }
453
454    #[test]
455    fn parse_v4_fail_addr() {
456        let cidr: Option<Ipv4Network> = "10.a.b/8".parse().ok();
457        assert_eq!(None, cidr);
458    }
459
460    #[test]
461    fn parse_v4_fail_addr2() {
462        let cidr: Option<Ipv4Network> = "10.1.1.1.0/8".parse().ok();
463        assert_eq!(None, cidr);
464    }
465
466    #[test]
467    fn parse_v4_fail_addr3() {
468        let cidr: Option<Ipv4Network> = "256/8".parse().ok();
469        assert_eq!(None, cidr);
470    }
471
472    #[test]
473    fn parse_v4_non_zero_host_bits() {
474        let cidr: Ipv4Network = "10.1.1.1/24".parse().unwrap();
475        assert_eq!(cidr.ip(), Ipv4Addr::new(10, 1, 1, 1));
476        assert_eq!(cidr.prefix(), 24);
477    }
478
479    #[test]
480    fn parse_v4_fail_prefix() {
481        let cidr: Option<Ipv4Network> = "0/39".parse().ok();
482        assert_eq!(None, cidr);
483    }
484
485    #[test]
486    fn parse_v4_fail_two_slashes() {
487        let cidr: Option<Ipv4Network> = "10.1.1.1/24/".parse().ok();
488        assert_eq!(None, cidr);
489    }
490
491    #[test]
492    fn nth_v4() {
493        let net = Ipv4Network::new(Ipv4Addr::new(127, 0, 0, 0), 24).unwrap();
494        assert_eq!(net.nth(0).unwrap(), Ipv4Addr::new(127, 0, 0, 0));
495        assert_eq!(net.nth(1).unwrap(), Ipv4Addr::new(127, 0, 0, 1));
496        assert_eq!(net.nth(255).unwrap(), Ipv4Addr::new(127, 0, 0, 255));
497        assert!(net.nth(256).is_none());
498    }
499
500    #[test]
501    fn nth_v4_fail() {
502        let net = Ipv4Network::new(Ipv4Addr::new(10, 0, 0, 0), 32).unwrap();
503        assert!(net.nth(1).is_none());
504    }
505
506    #[test]
507    fn hash_eq_compatibility_v4() {
508        let mut map = HashMap::new();
509        let net = Ipv4Network::new(Ipv4Addr::new(127, 0, 0, 1), 16).unwrap();
510        map.insert(net, 137);
511        assert_eq!(137, map[&net]);
512    }
513
514    #[test]
515    #[allow(dropping_copy_types)]
516    fn copy_compatibility_v4() {
517        let net = Ipv4Network::new(Ipv4Addr::new(127, 0, 0, 1), 16).unwrap();
518        mem::drop(net);
519        assert_eq!(16, net.prefix());
520    }
521
522    #[test]
523    fn mask_v4() {
524        let cidr = Ipv4Network::new(Ipv4Addr::new(74, 125, 227, 0), 29).unwrap();
525        let mask = cidr.mask();
526        assert_eq!(mask, Ipv4Addr::new(255, 255, 255, 248));
527    }
528
529    #[test]
530    fn network_v4() {
531        let cidr = Ipv4Network::new(Ipv4Addr::new(10, 10, 1, 97), 23).unwrap();
532        let net = cidr.network();
533        assert_eq!(net, Ipv4Addr::new(10, 10, 0, 0));
534    }
535
536    #[test]
537    fn broadcast_v4() {
538        let cidr = Ipv4Network::new(Ipv4Addr::new(10, 10, 1, 97), 23).unwrap();
539        let bcast = cidr.broadcast();
540        assert_eq!(bcast, Ipv4Addr::new(10, 10, 1, 255));
541    }
542
543    #[test]
544    fn contains_v4() {
545        let cidr = Ipv4Network::new(Ipv4Addr::new(74, 125, 227, 0), 25).unwrap();
546        let ip = Ipv4Addr::new(74, 125, 227, 4);
547        assert!(cidr.contains(ip));
548    }
549
550    #[test]
551    fn not_contains_v4() {
552        let cidr = Ipv4Network::new(Ipv4Addr::new(10, 0, 0, 50), 24).unwrap();
553        let ip = Ipv4Addr::new(10, 1, 0, 1);
554        assert!(!cidr.contains(ip));
555    }
556
557    #[test]
558    fn iterator_v4() {
559        let cidr: Ipv4Network = "192.168.122.0/30".parse().unwrap();
560        let mut iter = cidr.iter();
561        assert_eq!(Ipv4Addr::new(192, 168, 122, 0), iter.next().unwrap());
562        assert_eq!(Ipv4Addr::new(192, 168, 122, 1), iter.next().unwrap());
563        assert_eq!(Ipv4Addr::new(192, 168, 122, 2), iter.next().unwrap());
564        assert_eq!(Ipv4Addr::new(192, 168, 122, 3), iter.next().unwrap());
565        assert_eq!(None, iter.next());
566    }
567
568    // Tests the entire IPv4 space to see if the iterator will stop at the correct place
569    // and not overflow or wrap around. Ignored since it takes a long time to run.
570    #[test]
571    #[ignore]
572    fn iterator_v4_huge() {
573        let cidr: Ipv4Network = "0/0".parse().unwrap();
574        let mut iter = cidr.iter();
575        for i in 0..(u32::MAX as u64 + 1) {
576            assert_eq!(i as u32, u32::from(iter.next().unwrap()));
577        }
578        assert_eq!(None, iter.next());
579    }
580
581    #[test]
582    fn iterator_v4_size_hint() {
583        let cidr: Ipv4Network = "192.168.0.0/24".parse().unwrap();
584        let mut iter = cidr.iter();
585        assert_eq!((256, Some(256)), iter.size_hint());
586        iter.next();
587        assert_eq!((255, Some(255)), iter.size_hint());
588
589        let cidr: Ipv4Network = "192.168.0.0/32".parse().unwrap();
590        let mut iter = cidr.iter();
591        assert_eq!((1, Some(1)), iter.size_hint());
592        iter.next();
593        assert_eq!((0, None), iter.size_hint());
594
595        let cidr: Ipv4Network = "192.168.0.0/0".parse().unwrap();
596        let iter = cidr.iter();
597        assert_eq!((4294967295, Some(4294967295)), iter.size_hint());
598    }
599
600    #[test]
601    fn v4_mask_to_prefix() {
602        let mask = Ipv4Addr::new(255, 255, 255, 128);
603        let prefix = ipv4_mask_to_prefix(mask).unwrap();
604        assert_eq!(prefix, 25);
605    }
606
607    /// Parse netmask as well as prefix
608    #[test]
609    fn parse_netmask() {
610        let from_netmask: Ipv4Network = "192.168.1.0/255.255.255.0".parse().unwrap();
611        let from_prefix: Ipv4Network = "192.168.1.0/24".parse().unwrap();
612        assert_eq!(from_netmask, from_prefix);
613    }
614
615    #[test]
616    fn parse_netmask_broken_v4() {
617        assert_eq!(
618            "192.168.1.0/255.0.255.0".parse::<Ipv4Network>(),
619            Err(IpNetworkError::InvalidPrefix)
620        );
621    }
622
623    #[test]
624    fn invalid_v4_mask_to_prefix() {
625        let mask = Ipv4Addr::new(255, 0, 255, 0);
626        let prefix = ipv4_mask_to_prefix(mask);
627        assert!(prefix.is_err());
628    }
629
630    #[test]
631    fn ipv4network_with_netmask() {
632        {
633            // Positive test-case.
634            let addr = Ipv4Addr::new(127, 0, 0, 1);
635            let mask = Ipv4Addr::new(255, 0, 0, 0);
636            let net = Ipv4Network::with_netmask(addr, mask).unwrap();
637            let expected = Ipv4Network::new(Ipv4Addr::new(127, 0, 0, 1), 8).unwrap();
638            assert_eq!(net, expected);
639        }
640        {
641            // Negative test-case.
642            let addr = Ipv4Addr::new(127, 0, 0, 1);
643            let mask = Ipv4Addr::new(255, 0, 255, 0);
644            Ipv4Network::with_netmask(addr, mask).unwrap_err();
645        }
646    }
647
648    #[test]
649    fn ipv4network_from_ipv4addr() {
650        let net = Ipv4Network::from(Ipv4Addr::new(127, 0, 0, 1));
651        let expected = Ipv4Network::new(Ipv4Addr::new(127, 0, 0, 1), 32).unwrap();
652        assert_eq!(net, expected);
653    }
654
655    #[test]
656    fn test_send() {
657        fn assert_send<T: Send>() {}
658        assert_send::<Ipv4Network>();
659    }
660
661    #[test]
662    fn test_sync() {
663        fn assert_sync<T: Sync>() {}
664        assert_sync::<Ipv4Network>();
665    }
666
667    // Tests from cpython https://github.com/python/cpython/blob/e9bc4172d18db9c182d8e04dd7b033097a994c06/Lib/test/test_ipaddress.py
668    #[test]
669    fn test_is_subnet_of() {
670        let mut test_cases: HashMap<(Ipv4Network, Ipv4Network), bool> = HashMap::new();
671
672        test_cases.insert(("10.0.0.0/30".parse().unwrap(), "10.0.1.0/24".parse().unwrap()), false);
673        test_cases.insert(("10.0.0.0/30".parse().unwrap(), "10.0.0.0/24".parse().unwrap()), true);
674        test_cases.insert(("10.0.0.0/30".parse().unwrap(), "10.0.1.0/24".parse().unwrap()), false);
675        test_cases.insert(("10.0.1.0/24".parse().unwrap(), "10.0.0.0/30".parse().unwrap()), false);
676
677        for (key, val) in test_cases.iter() {
678            let (src, dest) = (key.0, key.1);
679            assert_eq!(src.is_subnet_of(dest), *val, "testing with {src} and {dest}");
680        }
681    }
682
683    #[test]
684    fn test_is_supernet_of() {
685        let mut test_cases: HashMap<(Ipv4Network, Ipv4Network), bool> = HashMap::new();
686
687        test_cases.insert(("10.0.0.0/30".parse().unwrap(), "10.0.1.0/24".parse().unwrap()), false);
688        test_cases.insert(("10.0.0.0/30".parse().unwrap(), "10.0.0.0/24".parse().unwrap()), false);
689        test_cases.insert(("10.0.0.0/30".parse().unwrap(), "10.0.1.0/24".parse().unwrap()), false);
690        test_cases.insert(("10.0.0.0/24".parse().unwrap(), "10.0.0.0/30".parse().unwrap()), true);
691
692        for (key, val) in test_cases.iter() {
693            let (src, dest) = (key.0, key.1);
694            assert_eq!(src.is_supernet_of(dest), *val, "testing with {src} and {dest}");
695        }
696    }
697
698    #[test]
699    fn test_overlaps() {
700        let other: Ipv4Network = "1.2.3.0/30".parse().unwrap();
701        let other2: Ipv4Network = "1.2.2.0/24".parse().unwrap();
702        let other3: Ipv4Network = "1.2.2.64/26".parse().unwrap();
703
704        let skynet: Ipv4Network = "1.2.3.0/24".parse().unwrap();
705        assert!(skynet.overlaps(other));
706        assert!(!skynet.overlaps(other2));
707        assert!(other2.overlaps(other3));
708    }
709
710    #[test]
711    fn edges() {
712        let low: Ipv4Network = "0.0.0.0/24".parse().unwrap();
713        let low_addrs: Vec<Ipv4Addr> = low.iter().collect();
714        assert_eq!(256, low_addrs.len());
715        assert_eq!("0.0.0.0".parse::<Ipv4Addr>().unwrap(), low_addrs[0]);
716        assert_eq!("0.0.0.255".parse::<Ipv4Addr>().unwrap(), low_addrs[255]);
717
718        let high: Ipv4Network = "255.255.255.0/24".parse().unwrap();
719        let high_addrs: Vec<Ipv4Addr> = high.iter().collect();
720        assert_eq!(256, high_addrs.len());
721        assert_eq!("255.255.255.0".parse::<Ipv4Addr>().unwrap(), high_addrs[0]);
722        assert_eq!("255.255.255.255".parse::<Ipv4Addr>().unwrap(), high_addrs[255]);
723    }
724}
ipnetwork/ipv4.rs

ipnetwork/
ipv4.rs
