Merge pull request #79 from sharksforarms/issue-#62

Parse Ipv4Addr using Ipv4Addr::from_str

.gitignore

@@ -1,3 +1,5 @@
 .gitignore
 Cargo.lock
 target
+.vscode
+.idea/

.travis.yml

@@ -6,12 +6,10 @@ rust:
 env:
   global:
     - secure: gokQ7xIWwmAuEUW3IyS5B/pbZxdFSSDBto5beJ+4ACGcRMDqJ/eCPf1ekSVXME4TWM46uUCjxcdUjYhIhQ6sG4zfWck4u45qRJ5JbIoTvR+ykxhN1j3Zi5x9ptP3ALDbHn2i3v6t9xohORfQpz3dVND5c7thbYDyKP2ZR1sez5c=
+    - FEATURES: default
 
 script:
   - cargo build --verbose
   - cargo test --verbose
   - cargo build --release --verbose
   - cargo doc --verbose
-
-after_script:
-  - curl http://www.rust-ci.org/artifacts/put?t=$RUSTCI_TOKEN | sh

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ipnetwork"
-version = "0.12.1"
+version = "0.13.0" # When updating version, also modify html_root_url in the lib.rs
 authors = ["Abhishek Chanda <abhishek.becs@gmail.com>", "Linus Färnstrand <faern@faern.net>"]
 description = "A library to work with IP CIDRs in Rust, heavily WIP"
 license = "Apache-2.0"
@@ -8,9 +8,18 @@ repository = "https://github.com/achanda/ipnetwork"
 keywords = ["network", "ip", "address"]
 readme = "README.md"
 documentation = "https://docs.rs/ipnetwork/"
+categories = ["network-programming", "os"]
 
 [dependencies]
 clippy = {version = "0.0.104", optional = true}
+serde = ">=0.8.0, <2.0"
+serde_derive = ">=0.8.0, <2.0"
+
+[dev-dependencies]
+serde_json = "1.0"
+
+[badges]
+travis-ci = { repository = "achanda/ipnetwork" }
 
 [features]
 default = []

src/common.rs

@@ -1,41 +1,58 @@
+use std::error::Error;
+use std::fmt;
 use std::net::Ipv4Addr;
 
 /// Represents a bunch of errors that can occur while working with a `IpNetwork`
-#[derive(Debug,Clone,PartialEq,Eq)]
+#[derive(Debug, Clone, PartialEq, Eq)]
 pub enum IpNetworkError {
     InvalidAddr(String),
     InvalidPrefix,
     InvalidCidrFormat(String),
 }
 
-pub fn cidr_parts(cidr: &str) -> Result<(&str, &str), IpNetworkError> {
+impl fmt::Display for IpNetworkError {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        use IpNetworkError::*;
+        match *self {
+            InvalidAddr(ref s) => write!(f, "invalid address: {}", s),
+            InvalidPrefix => write!(f, "invalid prefix"),
+            InvalidCidrFormat(ref s) => write!(f, "invalid cidr format: {}", s),
+        }
+    }
+}
+
+impl Error for IpNetworkError {
+    fn description(&self) -> &str {
+        use IpNetworkError::*;
+        match *self {
+            InvalidAddr(_) => "address is invalid",
+            InvalidPrefix => "prefix is invalid",
+            InvalidCidrFormat(_) => "cidr is invalid",
+        }
+    }
+}
+
+pub fn cidr_parts(cidr: &str) -> Result<(&str, Option<&str>), IpNetworkError> {
     let parts = cidr.split('/').collect::<Vec<&str>>();
-    if parts.len() == 2 {
+    if parts.len() == 1 {
-        Ok((parts[0], parts[1]))
+        Ok((parts[0], None))
+    } else if parts.len() == 2 {
+        Ok((parts[0], Some(parts[1])))
     } else {
-        Err(IpNetworkError::InvalidCidrFormat(format!("CIDR must contain '/': {}", cidr)))
+        Err(IpNetworkError::InvalidCidrFormat(format!(
+            "CIDR must contain a single '/': {}",
+            cidr
+        )))
     }
 }
 
 pub fn parse_prefix(prefix: &str, max: u8) -> Result<u8, IpNetworkError> {
-    let mask = prefix.parse::<u8>().map_err(|_| IpNetworkError::InvalidPrefix)?;
+    let mask = prefix
+        .parse::<u8>()
+        .map_err(|_| IpNetworkError::InvalidPrefix)?;
     if mask > max {
         Err(IpNetworkError::InvalidPrefix)
     } else {
         Ok(mask)
     }
 }
-
-pub fn parse_addr(addr: &str) -> Result<Ipv4Addr, IpNetworkError> {
-    let addr_parts = addr.split('.').map(|b| b.parse::<u8>());
-    let mut bytes = [0; 4];
-    for (i, byte) in addr_parts.enumerate() {
-        if i >= 4 {
-            return Err(IpNetworkError::InvalidAddr(format!("More than 4 bytes: {}", addr)));
-        }
-        bytes[i] = byte.map_err(|_| {
-                IpNetworkError::InvalidAddr(format!("All bytes not 0-255: {}", addr))
-            })?;
-    }
-    Ok(Ipv4Addr::new(bytes[0], bytes[1], bytes[2], bytes[3]))
-}

src/ipv4.rs

@@ -2,17 +2,38 @@ use std::fmt;
 use std::net::Ipv4Addr;
 use std::str::FromStr;
 
-use common::{IpNetworkError, cidr_parts, parse_prefix, parse_addr};
+use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
+
+use common::{cidr_parts, parse_prefix, IpNetworkError};
 
 const IPV4_BITS: u8 = 32;
 
 /// Represents a network range where the IP addresses are of v4
-#[derive(Debug,Clone,Copy,Hash,PartialEq,Eq)]
+#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
 pub struct Ipv4Network {
     addr: Ipv4Addr,
     prefix: u8,
 }
 
+impl<'de> Deserialize<'de> for Ipv4Network {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s = <&str>::deserialize(deserializer)?;
+        Ipv4Network::from_str(s).map_err(de::Error::custom)
+    }
+}
+
+impl Serialize for Ipv4Network {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(&self.to_string())
+    }
+}
+
 impl Ipv4Network {
     /// Constructs a new `Ipv4Network` from any `Ipv4Addr` and a prefix denoting the network size.
     /// If the prefix is larger than 32 this will return an `IpNetworkError::InvalidPrefix`.
@@ -20,10 +41,7 @@ impl Ipv4Network {
         if prefix > IPV4_BITS {
             Err(IpNetworkError::InvalidPrefix)
         } else {
-            Ok(Ipv4Network {
+            Ok(Ipv4Network { addr, prefix })
-                addr: addr,
-                prefix: prefix,
-            })
         }
     }
 
@@ -31,12 +49,9 @@ impl Ipv4Network {
     /// `Ipv4Addr` in the given network. `None` will be returned when there are no more
     /// addresses.
     pub fn iter(&self) -> Ipv4NetworkIterator {
-        let start = u32::from(self.network()) as u64;
+        let start = u64::from(u32::from(self.network()));
         let end = start + self.size();
-        Ipv4NetworkIterator {
+        Ipv4NetworkIterator { next: start, end }
-            next: start,
-            end: end,
-        }
     }
 
     pub fn ip(&self) -> Ipv4Addr {
@@ -56,12 +71,14 @@ impl Ipv4Network {
     /// use std::net::Ipv4Addr;
     /// use ipnetwork::Ipv4Network;
     ///
+    /// let net: Ipv4Network = "127.0.0.0".parse().unwrap();
+    /// assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 255, 255));
     /// let net: Ipv4Network = "127.0.0.0/16".parse().unwrap();
     /// assert_eq!(net.mask(), Ipv4Addr::new(255, 255, 0, 0));
     /// ```
     pub fn mask(&self) -> Ipv4Addr {
         let prefix = self.prefix;
-        let mask = !(0xffffffff as u64 >> prefix) as u32;
+        let mask = !(0xffff_ffff as u64 >> prefix) as u32;
         Ipv4Addr::from(mask)
     }
 
@@ -134,7 +151,7 @@ impl Ipv4Network {
     /// assert_eq!(tinynet.size(), 1);
     /// ```
     pub fn size(&self) -> u64 {
-        let host_bits = (IPV4_BITS - self.prefix) as u32;
+        let host_bits = u32::from(IPV4_BITS - self.prefix);
         (2 as u64).pow(host_bits)
     }
 
@@ -156,7 +173,7 @@ impl Ipv4Network {
     /// assert_eq!(net2.nth(256).unwrap(), Ipv4Addr::new(10, 0, 1, 0));
     /// ```
     pub fn nth(&self, n: u32) -> Option<Ipv4Addr> {
-        if (n as u64) < self.size() {
+        if u64::from(n) < self.size() {
             let net = u32::from(self.network());
             Some(Ipv4Addr::from(net + n))
         } else {
@@ -171,7 +188,6 @@ impl fmt::Display for Ipv4Network {
     }
 }
 
-
 /// Creates an `Ipv4Network` from parsing a string in CIDR notation.
 ///
 /// # Examples
@@ -189,12 +205,25 @@ impl FromStr for Ipv4Network {
     type Err = IpNetworkError;
     fn from_str(s: &str) -> Result<Ipv4Network, IpNetworkError> {
         let (addr_str, prefix_str) = cidr_parts(s)?;
-        let addr = parse_addr(addr_str)?;
+        let addr = Ipv4Addr::from_str(addr_str)
-        let prefix = parse_prefix(prefix_str, IPV4_BITS)?;
+            .map_err(|_| IpNetworkError::InvalidAddr(addr_str.to_string()))?;
+        let prefix = match prefix_str {
+            Some(v) => parse_prefix(v, IPV4_BITS)?,
+            None => IPV4_BITS,
+        };
         Ipv4Network::new(addr, prefix)
     }
 }
 
+impl From<Ipv4Addr> for Ipv4Network {
+    fn from(a: Ipv4Addr) -> Ipv4Network {
+        Ipv4Network {
+            addr: a,
+            prefix: 32,
+        }
+    }
+}
+
 pub struct Ipv4NetworkIterator {
     next: u64,
     end: u64,
@@ -220,7 +249,7 @@ pub fn ipv4_mask_to_prefix(mask: Ipv4Addr) -> Result<u8, IpNetworkError> {
     let mask = u32::from(mask);
 
     let prefix = (!mask).leading_zeros() as u8;
-    if ((mask as u64) << prefix) & 0xffffffff != 0 {
+    if (u64::from(mask) << prefix) & 0xffff_ffff != 0 {
         Err(IpNetworkError::InvalidPrefix)
     } else {
         Ok(prefix)
@@ -229,10 +258,10 @@ pub fn ipv4_mask_to_prefix(mask: Ipv4Addr) -> Result<u8, IpNetworkError> {
 
 #[cfg(test)]
 mod test {
-    use std::mem;
-    use std::collections::HashMap;
-    use std::net::Ipv4Addr;
     use super::*;
+    use std::collections::HashMap;
+    use std::mem;
+    use std::net::Ipv4Addr;
 
     #[test]
     fn create_v4() {
@@ -246,13 +275,6 @@ mod test {
         assert!(net.is_err());
     }
 
-    #[test]
-    fn parse_v4_0bit() {
-        let cidr: Ipv4Network = "0/0".parse().unwrap();
-        assert_eq!(cidr.ip(), Ipv4Addr::new(0, 0, 0, 0));
-        assert_eq!(cidr.prefix(), 0);
-    }
-
     #[test]
     fn parse_v4_24bit() {
         let cidr: Ipv4Network = "127.1.0.0/24".parse().unwrap();
@@ -267,6 +289,13 @@ mod test {
         assert_eq!(cidr.prefix(), 32);
     }
 
+    #[test]
+    fn parse_v4_noprefix() {
+        let cidr: Ipv4Network = "127.0.0.0".parse().unwrap();
+        assert_eq!(cidr.ip(), Ipv4Addr::new(127, 0, 0, 0));
+        assert_eq!(cidr.prefix(), 32);
+    }
+
     #[test]
     fn parse_v4_fail_addr() {
         let cidr: Option<Ipv4Network> = "10.a.b/8".parse().ok();
@@ -299,27 +328,9 @@ mod test {
     }
 
     #[test]
-    fn size_v4_24bit() {
+    fn parse_v4_fail_two_slashes() {
-        let net: Ipv4Network = "0/24".parse().unwrap();
+        let cidr: Option<Ipv4Network> = "10.1.1.1/24/".parse().ok();
-        assert_eq!(net.size(), 256);
+        assert_eq!(None, cidr);
-    }
-
-    #[test]
-    fn size_v4_1bit() {
-        let net: Ipv4Network = "0/31".parse().unwrap();
-        assert_eq!(net.size(), 2);
-    }
-
-    #[test]
-    fn size_v4_max() {
-        let net: Ipv4Network = "0/0".parse().unwrap();
-        assert_eq!(net.size(), 4_294_967_296);
-    }
-
-    #[test]
-    fn size_v4_min() {
-        let net: Ipv4Network = "0/32".parse().unwrap();
-        assert_eq!(net.size(), 1);
     }
 
     #[test]
@@ -398,14 +409,6 @@ mod test {
         assert_eq!(None, iter.next());
     }
 
-    #[test]
-    fn iterator_v4_tiny() {
-        let cidr: Ipv4Network = "10/32".parse().unwrap();
-        let mut iter = cidr.iter();
-        assert_eq!(Ipv4Addr::new(10, 0, 0, 0), iter.next().unwrap());
-        assert_eq!(None, iter.next());
-    }
-
     // Tests the entire IPv4 space to see if the iterator will stop at the correct place
     // and not overflow or wrap around. Ignored since it takes a long time to run.
     #[test]
@@ -432,4 +435,23 @@ mod test {
         let prefix = ipv4_mask_to_prefix(mask);
         assert!(prefix.is_err());
     }
+
+    #[test]
+    fn ipv4network_from_ipv4addr() {
+        let net = Ipv4Network::from(Ipv4Addr::new(127, 0, 0, 1));
+        let expected = Ipv4Network::new(Ipv4Addr::new(127, 0, 0, 1), 32).unwrap();
+        assert_eq!(net, expected);
+    }
+
+    #[test]
+    fn test_send() {
+        fn assert_send<T: Send>() {}
+        assert_send::<Ipv4Network>();
+    }
+
+    #[test]
+    fn test_sync() {
+        fn assert_sync<T: Sync>() {}
+        assert_sync::<Ipv4Network>();
+    }
 }

src/ipv6.rs

@@ -3,18 +3,39 @@ use std::fmt;
 use std::net::Ipv6Addr;
 use std::str::FromStr;
 
-use common::{IpNetworkError, cidr_parts, parse_prefix};
+use serde::{de, Deserialize, Deserializer, Serialize, Serializer};
+
+use common::{cidr_parts, parse_prefix, IpNetworkError};
 
 const IPV6_BITS: u8 = 128;
 const IPV6_SEGMENT_BITS: u8 = 16;
 
 /// Represents a network range where the IP addresses are of v6
-#[derive(Debug,Clone,Copy,Hash,PartialEq,Eq)]
+#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord)]
 pub struct Ipv6Network {
     addr: Ipv6Addr,
     prefix: u8,
 }
 
+impl<'de> Deserialize<'de> for Ipv6Network {
+    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s = <&str>::deserialize(deserializer)?;
+        Ipv6Network::from_str(s).map_err(de::Error::custom)
+    }
+}
+
+impl Serialize for Ipv6Network {
+    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
+    where
+        S: Serializer,
+    {
+        serializer.serialize_str(&self.to_string())
+    }
+}
+
 impl Ipv6Network {
     /// Constructs a new `Ipv6Network` from any `Ipv6Addr` and a prefix denoting the network size.
     /// If the prefix is larger than 128 this will return an `IpNetworkError::InvalidPrefix`.
@@ -22,13 +43,66 @@ impl Ipv6Network {
         if prefix > IPV6_BITS {
             Err(IpNetworkError::InvalidPrefix)
         } else {
-            Ok(Ipv6Network {
+            Ok(Ipv6Network { addr, prefix })
-                addr: addr,
-                prefix: prefix,
-            })
         }
     }
 
+    /// Returns an iterator over `Ipv6Network`. Each call to `next` will return the next
+    /// `Ipv6Addr` in the given network. `None` will be returned when there are no more
+    /// addresses.
+    pub fn iter(&self) -> Ipv6NetworkIterator {
+        let dec = u128::from(self.addr);
+        let max = u128::max_value();
+        let prefix = self.prefix;
+
+        let mask = max.checked_shl((IPV6_BITS - prefix) as u32).unwrap_or(0);
+        let start: u128 = dec & mask;
+
+        let mask = max.checked_shr(prefix as u32).unwrap_or(0);
+        let end: u128 = dec | mask;
+
+        Ipv6NetworkIterator {
+            next: start,
+            end: end,
+        }
+    }
+
+    /// Returns the address of the network denoted by this `Ipv6Network`.
+    /// This means the lowest possible IPv6 address inside of the network.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::net::Ipv6Addr;
+    /// use ipnetwork::Ipv6Network;
+    ///
+    /// let net: Ipv6Network = "2001:db8::/96".parse().unwrap();
+    /// assert_eq!(net.network(), Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0));
+    /// ```
+    pub fn network(&self) -> Ipv6Addr {
+        let mask = u128::from(self.mask());
+        let ip = u128::from(self.addr) & mask;
+        Ipv6Addr::from(ip)
+    }
+
+    /// Returns the broadcast address of this `Ipv6Network`.
+    /// This means the highest possible IPv4 address inside of the network.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::net::Ipv6Addr;
+    /// use ipnetwork::Ipv6Network;
+    ///
+    /// let net: Ipv6Network = "2001:db8::/96".parse().unwrap();
+    /// assert_eq!(net.broadcast(), Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0xffff, 0xffff));
+    /// ```
+    pub fn broadcast(&self) -> Ipv6Addr {
+        let mask = u128::from(self.mask());
+        let broadcast = u128::from(self.addr) | !mask;
+        Ipv6Addr::from(broadcast)
+    }
+
     pub fn ip(&self) -> Ipv6Addr {
         self.addr
     }
@@ -46,6 +120,8 @@ impl Ipv6Network {
     /// use std::net::Ipv6Addr;
     /// use ipnetwork::Ipv6Network;
     ///
+    /// let net: Ipv6Network = "ff01::0".parse().unwrap();
+    /// assert_eq!(net.mask(), Ipv6Addr::new(0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff));
     /// let net: Ipv6Network = "ff01::0/32".parse().unwrap();
     /// assert_eq!(net.mask(), Ipv6Addr::new(0xffff, 0xffff, 0, 0, 0, 0, 0, 0));
     /// ```
@@ -76,7 +152,30 @@ impl Ipv6Network {
         let a = self.addr.segments();
         let b = ip.segments();
         let addrs = Iterator::zip(a.iter(), b.iter());
-        self.mask().segments().iter().zip(addrs).all(|(mask, (a, b))| a & mask == b & mask)
+        self.mask()
+            .segments()
+            .iter()
+            .zip(addrs)
+            .all(|(mask, (a, b))| a & mask == b & mask)
+    }
+
+    /// Returns number of possible host addresses in this `Ipv6Network`.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::net::Ipv6Addr;
+    /// use ipnetwork::Ipv6Network;
+    ///
+    /// let net: Ipv6Network = "ff01::0/32".parse().unwrap();
+    /// assert_eq!(net.size(), 79228162514264337593543950336);
+    ///
+    /// let tinynet: Ipv6Network = "ff01::0/128".parse().unwrap();
+    /// assert_eq!(tinynet.size(), 1);
+    /// ```
+    pub fn size(&self) -> u128 {
+        let host_bits = (IPV6_BITS - self.prefix) as u32;
+        (2 as u128).pow(host_bits)
     }
 }
 
@@ -84,12 +183,44 @@ impl FromStr for Ipv6Network {
     type Err = IpNetworkError;
     fn from_str(s: &str) -> Result<Ipv6Network, IpNetworkError> {
         let (addr_str, prefix_str) = cidr_parts(s)?;
-        let addr = Ipv6Addr::from_str(addr_str).map_err(|_| IpNetworkError::InvalidAddr(addr_str.to_string()))?;
+        let addr = Ipv6Addr::from_str(addr_str)
-        let prefix = parse_prefix(prefix_str, IPV6_BITS)?;
+            .map_err(|_| IpNetworkError::InvalidAddr(addr_str.to_string()))?;
+        let prefix = match prefix_str {
+            Some(v) => parse_prefix(v, IPV6_BITS)?,
+            None => IPV6_BITS,
+        };
         Ipv6Network::new(addr, prefix)
     }
 }
 
+impl From<Ipv6Addr> for Ipv6Network {
+    fn from(a: Ipv6Addr) -> Ipv6Network {
+        Ipv6Network {
+            addr: a,
+            prefix: 128,
+        }
+    }
+}
+
+pub struct Ipv6NetworkIterator {
+    next: u128,
+    end: u128,
+}
+
+impl Iterator for Ipv6NetworkIterator {
+    type Item = Ipv6Addr;
+
+    fn next(&mut self) -> Option<Ipv6Addr> {
+        if self.next <= self.end {
+            let next = Ipv6Addr::from(self.next);
+            self.next += 1;
+            Some(next)
+        } else {
+            None
+        }
+    }
+}
+
 impl fmt::Display for Ipv6Network {
     fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
         write!(fmt, "{}/{}", self.ip(), self.prefix())
@@ -133,8 +264,8 @@ pub fn ipv6_mask_to_prefix(mask: Ipv6Addr) -> Result<u8, IpNetworkError> {
 
 #[cfg(test)]
 mod test {
-    use std::net::Ipv6Addr;
     use super::*;
+    use std::net::Ipv6Addr;
 
     #[test]
     fn create_v6() {
@@ -162,6 +293,13 @@ mod test {
         assert_eq!(cidr.prefix(), 64);
     }
 
+    #[test]
+    fn parse_v6_noprefix() {
+        let cidr: Ipv6Network = "::1".parse().unwrap();
+        assert_eq!(cidr.ip(), Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+        assert_eq!(cidr.prefix(), 128);
+    }
+
     #[test]
     fn parse_v6_fail_addr() {
         let cidr: Option<Ipv6Network> = "2001::1::/8".parse().ok();
@@ -174,6 +312,12 @@ mod test {
         assert_eq!(None, cidr);
     }
 
+    #[test]
+    fn parse_v6_fail_two_slashes() {
+        let cidr: Option<Ipv6Network> = "::1/24/".parse().ok();
+        assert_eq!(None, cidr);
+    }
+
     #[test]
     fn mask_v6() {
         let cidr = Ipv6Network::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0), 40).unwrap();
@@ -208,4 +352,88 @@ mod test {
         let prefix = ipv6_mask_to_prefix(mask);
         assert!(prefix.is_err());
     }
+
+    #[test]
+    fn iterator_v6() {
+        let cidr: Ipv6Network = "2001:db8::/126".parse().unwrap();
+        let mut iter = cidr.iter();
+        assert_eq!(
+            Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0),
+            iter.next().unwrap()
+        );
+        assert_eq!(
+            Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 1),
+            iter.next().unwrap()
+        );
+        assert_eq!(
+            Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 2),
+            iter.next().unwrap()
+        );
+        assert_eq!(
+            Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 3),
+            iter.next().unwrap()
+        );
+        assert_eq!(None, iter.next());
+    }
+
+    #[test]
+    fn iterator_v6_tiny() {
+        let cidr: Ipv6Network = "2001:db8::/128".parse().unwrap();
+        let mut iter = cidr.iter();
+        assert_eq!(
+            Ipv6Addr::new(0x2001, 0xdb8, 0, 0, 0, 0, 0, 0),
+            iter.next().unwrap()
+        );
+        assert_eq!(None, iter.next());
+    }
+
+    #[test]
+    fn iterator_v6_huge() {
+        let cidr: Ipv6Network = "2001:db8::/0".parse().unwrap();
+        let mut iter = cidr.iter();
+        assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0), iter.next().unwrap());
+        assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), iter.next().unwrap());
+        assert_eq!(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 2), iter.next().unwrap());
+    }
+
+    #[test]
+    fn network_v6() {
+        let cidr: Ipv6Network = "2001:db8::0/96".parse().unwrap();
+        let net = cidr.network();
+        let expected: Ipv6Addr = "2001:db8::".parse().unwrap();
+        assert_eq!(net, expected);
+    }
+
+    #[test]
+    fn broadcast_v6() {
+        let cidr: Ipv6Network = "2001:db8::0/96".parse().unwrap();
+        let net = cidr.broadcast();
+        let expected: Ipv6Addr = "2001:db8::ffff:ffff".parse().unwrap();
+        assert_eq!(net, expected);
+    }
+
+    #[test]
+    fn size_v6() {
+        let cidr: Ipv6Network = "2001:db8::0/96".parse().unwrap();
+        assert_eq!(cidr.size(), 4294967296);
+    }
+
+    #[test]
+    fn ipv6network_from_ipv6addr() {
+        let net = Ipv6Network::from(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1));
+        let expected = Ipv6Network::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1), 128).unwrap();
+        assert_eq!(net, expected);
+    }
+
+    #[test]
+    fn test_send() {
+        fn assert_send<T: Send>() {}
+        assert_send::<Ipv6Network>();
+    }
+
+    #[test]
+    fn test_sync() {
+        fn assert_sync<T: Sync>() {}
+        assert_sync::<Ipv6Network>();
+    }
 }

src/lib.rs

@@ -4,20 +4,29 @@
 #![cfg_attr(feature = "dev", feature(plugin))]
 #![cfg_attr(feature = "dev", plugin(clippy))]
 #![crate_type = "lib"]
+#![doc(html_root_url = "https://docs.rs/ipnetwork/0.13")]
 
+extern crate serde;
+#[macro_use]
+extern crate serde_derive;
+
+use std::fmt;
 use std::net::IpAddr;
 
+mod common;
 mod ipv4;
 mod ipv6;
-mod common;
 
+use std::str::FromStr;
+
+pub use common::IpNetworkError;
 pub use ipv4::{Ipv4Network, ipv4_mask_to_prefix};
 pub use ipv6::{Ipv6Network, ipv6_mask_to_prefix};
-pub use common::IpNetworkError;
 
 /// Represents a generic network range. This type can have two variants:
 /// the v4 and the v6 case.
-#[derive(Debug,Clone,Copy,Hash,PartialEq,Eq)]
+#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, PartialOrd, Ord, Serialize, Deserialize)]
+#[serde(untagged)]
 pub enum IpNetwork {
     V4(Ipv4Network),
     V6(Ipv6Network),
@@ -36,15 +45,6 @@ impl IpNetwork {
     }
 
     /// Returns the IP part of a given `IpNetwork`
-    ///
-    /// # Example
-    /// ```
-    /// use std::net::{Ipv4Addr, Ipv6Addr};
-    /// use ipnetwork::IpNetwork;
-    ///
-    /// assert_eq!(IpNetwork::V4("10.9.0.32/16".parse().unwrap()).ip(), "10.9.0.32".parse().unwrap());
-    /// assert_eq!(IpNetwork::V6("ff01::0/32".parse().unwrap()).ip(), "ff01::0".parse().unwrap());
-    /// ```
     pub fn ip(&self) -> IpAddr {
         match *self {
             IpNetwork::V4(ref a) => IpAddr::V4(a.ip()),
@@ -58,7 +58,10 @@ impl IpNetwork {
     /// ```
     /// use ipnetwork::IpNetwork;
     ///
+    /// assert_eq!(IpNetwork::V4("10.9.0.1".parse().unwrap()).prefix(), 32u8);
     /// assert_eq!(IpNetwork::V4("10.9.0.32/16".parse().unwrap()).prefix(), 16u8);
+    ///
+    /// assert_eq!(IpNetwork::V6("ff01::0".parse().unwrap()).prefix(), 128u8);
     /// assert_eq!(IpNetwork::V6("ff01::0/32".parse().unwrap()).prefix(), 32u8);
     /// ```
     pub fn prefix(&self) -> u8 {
@@ -68,21 +71,120 @@ impl IpNetwork {
         }
     }
 
-    /// Returns the mask of the given `IpNetwork`
+    /// Returns the mask for this `IpNetwork`.
+    /// That means the `prefix` most significant bits will be 1 and the rest 0
     ///
     /// # Example
+    ///
     /// ```
     /// use ipnetwork::IpNetwork;
+    /// use std::net::{Ipv4Addr, Ipv6Addr};
     ///
-    /// assert_eq!(IpNetwork::V4("10.9.0.32/16".parse().unwrap()).mask(), 16u8);
+    /// let v4_net: IpNetwork = "10.9.0.1".parse().unwrap();
-    /// assert_eq!(IpNetwork::V6("ff01::0/32".parse().unwrap()).mask(), 32u8);
+    /// assert_eq!(v4_net.mask(), Ipv4Addr::new(255, 255, 255, 255));
-    ///```
+    /// let v4_net: IpNetwork = "10.9.0.32/16".parse().unwrap();
+    /// assert_eq!(v4_net.mask(), Ipv4Addr::new(255, 255, 0, 0));
+    ///
+    /// let v6_net: IpNetwork = "ff01::0".parse().unwrap();
+    /// assert_eq!(v6_net.mask(), Ipv6Addr::new(0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff, 0xffff));
+    /// let v6_net: IpNetwork = "ff01::0/32".parse().unwrap();
+    /// assert_eq!(v6_net.mask(), Ipv6Addr::new(0xffff, 0xffff, 0, 0, 0, 0, 0, 0));
+    /// ```
     pub fn mask(&self) -> IpAddr {
         match *self {
             IpNetwork::V4(ref a) => IpAddr::V4(a.mask()),
             IpNetwork::V6(ref a) => IpAddr::V6(a.mask()),
         }
     }
+
+    /// Returns true if the IP in this `IpNetwork` is a valid IPv4 address,
+    /// false if it's a valid IPv6 address.
+    ///
+    /// # Example
+    ///
+    ///```
+    /// use ipnetwork::IpNetwork;
+    ///
+    /// let v4: IpNetwork = IpNetwork::V4("10.9.0.32/16".parse().unwrap());
+    /// assert_eq!(v4.is_ipv4(), true);
+    /// assert_eq!(v4.is_ipv6(), false);
+    ///```
+    pub fn is_ipv4(&self) -> bool {
+        match *self {
+            IpNetwork::V4(_) => true,
+            IpNetwork::V6(_) => false,
+        }
+    }
+
+    /// Returns true if the IP in this `IpNetwork` is a valid IPv6 address,
+    /// false if it's a valid IPv4 address.
+    ///
+    /// # Example
+    ///
+    ///```
+    /// use ipnetwork::IpNetwork;
+    ///
+    /// let v6: IpNetwork = IpNetwork::V6("ff01::0/32".parse().unwrap());
+    /// assert_eq!(v6.is_ipv6(), true);
+    /// assert_eq!(v6.is_ipv4(), false);
+    ///```
+    pub fn is_ipv6(&self) -> bool {
+        match *self {
+            IpNetwork::V4(_) => false,
+            IpNetwork::V6(_) => true,
+        }
+    }
+
+    /// Checks if a given `IpAddr` is in this `IpNetwork`
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use std::net::IpAddr;
+    /// use ipnetwork::IpNetwork;
+    ///
+    /// let net: IpNetwork = "127.0.0.0/24".parse().unwrap();
+    /// let ip1: IpAddr = "127.0.0.1".parse().unwrap();
+    /// let ip2: IpAddr = "172.0.0.1".parse().unwrap();
+    /// let ip4: IpAddr = "::1".parse().unwrap();
+    /// assert!(net.contains(ip1));
+    /// assert!(!net.contains(ip2));
+    /// assert!(!net.contains(ip4));
+    /// ```
+    pub fn contains(&self, ip: IpAddr) -> bool {
+        match (*self, ip) {
+            (IpNetwork::V4(net), IpAddr::V4(ip)) => net.contains(ip),
+            (IpNetwork::V6(net), IpAddr::V6(ip)) => net.contains(ip),
+            _ => false,
+        }
+    }
+}
+
+/// Tries to parse the given string into a `IpNetwork`. Will first try to parse
+/// it as an `Ipv4Network` and if that fails as an `Ipv6Network`. If both
+/// fails it will return an `InvalidAddr` error.
+///
+/// # Examples
+///
+/// ```
+/// use std::net::Ipv4Addr;
+/// use ipnetwork::{IpNetwork, Ipv4Network};
+///
+/// let expected = IpNetwork::V4(Ipv4Network::new(Ipv4Addr::new(10, 1, 9, 32), 16).unwrap());
+/// let from_cidr: IpNetwork = "10.1.9.32/16".parse().unwrap();
+/// assert_eq!(expected, from_cidr);
+/// ```
+impl FromStr for IpNetwork {
+    type Err = IpNetworkError;
+    fn from_str(s: &str) -> Result<IpNetwork, IpNetworkError> {
+        if let Ok(net) = Ipv4Network::from_str(s) {
+            Ok(IpNetwork::V4(net))
+        } else if let Ok(net) = Ipv6Network::from_str(s) {
+            Ok(IpNetwork::V6(net))
+        } else {
+            Err(IpNetworkError::InvalidAddr(s.to_string()))
+        }
+    }
 }
 
 impl From<Ipv4Network> for IpNetwork {
@@ -97,6 +199,24 @@ impl From<Ipv6Network> for IpNetwork {
     }
 }
 
+impl From<IpAddr> for IpNetwork {
+    fn from(addr: IpAddr) -> IpNetwork {
+        match addr {
+            IpAddr::V4(a) => IpNetwork::V4(Ipv4Network::from(a)),
+            IpAddr::V6(a) => IpNetwork::V6(Ipv6Network::from(a)),
+        }
+    }
+}
+
+impl fmt::Display for IpNetwork {
+    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
+        match *self {
+            IpNetwork::V4(net) => net.fmt(f),
+            IpNetwork::V6(net) => net.fmt(f),
+        }
+    }
+}
+
 /// Converts a `IpAddr` network mask into a prefix.
 /// If the mask is invalid this will return an `IpNetworkError::InvalidPrefix`.
 pub fn ip_mask_to_prefix(mask: IpAddr) -> Result<u8, IpNetworkError> {

tests/test_json.rs

@@ -0,0 +1,74 @@
+extern crate serde;
+
+extern crate serde_json;
+
+#[macro_use]
+extern crate serde_derive;
+
+extern crate ipnetwork;
+
+#[cfg(test)]
+mod tests {
+
+    use ipnetwork::{IpNetwork, Ipv4Network, Ipv6Network};
+    use std::net::{Ipv4Addr, Ipv6Addr};
+
+    #[test]
+    fn test_ipv4_json() {
+        let json_string = r#"{"ipnetwork":"127.1.0.0/24"}"#;
+
+        #[derive(Serialize, Deserialize)]
+        struct MyStruct {
+            ipnetwork: Ipv4Network,
+        }
+
+        let mystruct: MyStruct = ::serde_json::from_str(json_string).unwrap();
+
+        assert_eq!(mystruct.ipnetwork.ip(), Ipv4Addr::new(127, 1, 0, 0));
+        assert_eq!(mystruct.ipnetwork.prefix(), 24);
+
+        assert_eq!(::serde_json::to_string(&mystruct).unwrap(), json_string);
+    }
+
+    #[test]
+    fn test_ipv6_json() {
+        let json_string = r#"{"ipnetwork":"::1/0"}"#;
+
+        #[derive(Serialize, Deserialize)]
+        struct MyStruct {
+            ipnetwork: Ipv6Network,
+        }
+
+        let mystruct: MyStruct = ::serde_json::from_str(json_string).unwrap();
+
+        assert_eq!(
+            mystruct.ipnetwork.ip(),
+            Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)
+        );
+        assert_eq!(mystruct.ipnetwork.prefix(), 0);
+
+        assert_eq!(::serde_json::to_string(&mystruct).unwrap(), json_string);
+    }
+
+    #[test]
+    fn test_ipnetwork_json() {
+        let json_string = r#"{"ipnetwork":["127.1.0.0/24","::1/0"]}"#;
+
+        #[derive(Serialize, Deserialize)]
+        struct MyStruct {
+            ipnetwork: Vec<IpNetwork>,
+        }
+
+        let mystruct: MyStruct = ::serde_json::from_str(json_string).unwrap();
+
+        assert_eq!(mystruct.ipnetwork[0].ip(), Ipv4Addr::new(127, 1, 0, 0));
+        assert_eq!(mystruct.ipnetwork[0].prefix(), 24);
+        assert_eq!(
+            mystruct.ipnetwork[1].ip(),
+            Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 1)
+        );
+        assert_eq!(mystruct.ipnetwork[1].prefix(), 0);
+
+        assert_eq!(::serde_json::to_string(&mystruct).unwrap(), json_string);
+    }
+}