Merge pull request #44 from achanda/release

Uprev for release

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "ipnetwork"
-version = "0.12.1"
+version = "0.12.3"
 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"

src/common.rs

@@ -1,4 +1,6 @@
 use std::net::Ipv4Addr;
+use std::fmt;
+use std::error::Error;
 
 /// Represents a bunch of errors that can occur while working with a `IpNetwork`
 #[derive(Debug,Clone,PartialEq,Eq)]
@@ -8,6 +10,29 @@ pub enum IpNetworkError {
     InvalidCidrFormat(String),
 }
 
+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 prifex"),
+            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, &str), IpNetworkError> {
     let parts = cidr.split('/').collect::<Vec<&str>>();
     if parts.len() == 2 {

src/lib.rs

@@ -5,12 +5,15 @@
 #![cfg_attr(feature = "dev", plugin(clippy))]
 #![crate_type = "lib"]
 
+use std::fmt;
 use std::net::IpAddr;
 
 mod ipv4;
 mod ipv6;
 mod common;
 
+use std::str::FromStr;
+
 pub use ipv4::{Ipv4Network, ipv4_mask_to_prefix};
 pub use ipv6::{Ipv6Network, ipv6_mask_to_prefix};
 pub use common::IpNetworkError;
@@ -36,15 +39,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()),
@@ -68,14 +62,18 @@ 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);
-    /// assert_eq!(IpNetwork::V6("ff01::0/32".parse().unwrap()).mask(), 32u8);
+    /// 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/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 {
@@ -83,6 +81,71 @@ impl IpNetwork {
             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,
+        }
+    }
+}
+
+/// 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 +160,15 @@ impl From<Ipv6Network> for IpNetwork {
     }
 }
 
+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> {