Switch back to IpAddr

Author: oschwald

CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change Log #
+
+## 0.7.0 - 2016-05-15
+
+* API CHANGE: `lookup` takes an `IpAddr` again instead of a `SocketAddr`. We
+  previously switched to `SocketAddr` after `IpAddr` had been deprecated, but
+  it has since been re-added.

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "maxminddb"
-version = "0.6.2"
+version = "0.7.0"
 description = "Library for reading MaxMind DB format used by GeoIP2"
 documentation = "http://oschwald.github.io/maxminddb-rust/maxminddb/struct.Reader.html"
 readme = "README.md"
@@ -16,10 +16,5 @@ crate_type = ["lib", "dylib", "staticlib"]
 path = "src/maxminddb/lib.rs"
 
 [dependencies]
-log = "0.3.5"
-rustc-serialize = "0.3.16"
-clippy = {version = "0.0.37", optional = true}
-
-[features]
-default = []
-dev = ["clippy"]
+log = "0.3.6"
+rustc-serialize = "0.3.19"

example/lookup.rs

@@ -1,14 +1,14 @@
 extern crate maxminddb;
 extern crate rustc_serialize;
 
-use std::net::SocketAddr;
+use std::net::IpAddr;
 use std::str::FromStr;
 
 use maxminddb::geoip2;
 
 fn main() {
     let reader = maxminddb::Reader::open("/usr/local/share/GeoIP/GeoIP2-City.mmdb").unwrap();
-    let ip: SocketAddr = FromStr::from_str("128.101.101.101:0").unwrap();
+    let ip: IpAddr = FromStr::from_str("128.101.101.101").unwrap();
     let city: geoip2::City = reader.lookup(ip).unwrap();
     print!("{:?}\n", city);
 }

src/maxminddb/lib.rs

@@ -6,10 +6,6 @@
         unstable_features,
         unused_import_braces)]
 
-#![cfg_attr(feature = "dev", allow(unstable_features))]
-#![cfg_attr(feature = "dev", feature(plugin))]
-#![cfg_attr(feature = "dev", plugin(clippy))]
-
 #[macro_use]
 extern crate log;
 
@@ -21,7 +17,7 @@ use std::io::prelude::*;
 use std::io;
 use std::error::Error;
 use std::mem;
-use std::net::SocketAddr;
+use std::net::IpAddr;
 use std::path::Path;
 
 use rustc_serialize::Decodable;
@@ -387,23 +383,23 @@ impl Reader {
     ///
     /// ```
     /// use maxminddb::geoip2;
-    /// use std::net::SocketAddr;
+    /// use std::net::IpAddr;
     /// use std::str::FromStr;
     ///
     /// let reader = maxminddb::Reader::open("test-data/test-data/GeoIP2-City-Test.mmdb").unwrap();
     ///
-    /// let ip: SocketAddr = FromStr::from_str("89.160.20.128:0").unwrap();
+    /// let ip: IpAddr = FromStr::from_str("89.160.20.128").unwrap();
     /// let city: geoip2::City = reader.lookup(ip).unwrap();
     /// print!("{:?}", city);
     /// ```
     ///
     /// Note that SocketAddr requires a port, which is not needed to look up
     /// the address in the database. This library will likely switch to IpAddr
     /// if the feature gate for that is removed.
-    pub fn lookup<T: Decodable>(&self, address: SocketAddr) -> Result<T, MaxMindDBError> {
+    pub fn lookup<T: Decodable>(&self, address: IpAddr) -> Result<T, MaxMindDBError> {
         let ip_bytes = ip_to_bytes(address);
         let pointer = try!(self.find_address_in_tree(ip_bytes));
-        if pointer <= 0 {
+        if pointer == 0 {
             return Err(MaxMindDBError::AddressNotFoundError("Address not found in database"
                                                                 .to_owned()));
         }
@@ -512,11 +508,11 @@ fn to_usize(base: u8, bytes: &[u8]) -> usize {
     bytes.iter().fold(base as usize, |acc, &b| (acc << 8) | b as usize)
 }
 
-fn ip_to_bytes(address: SocketAddr) -> Vec<u8> {
+fn ip_to_bytes(address: IpAddr) -> Vec<u8> {
     match address {
-        SocketAddr::V4(a) => a.ip().octets().to_vec(),
-        SocketAddr::V6(a) => {
-            let s = a.ip().segments();
+        IpAddr::V4(a) => a.octets().to_vec(),
+        IpAddr::V6(a) => {
+            let s = a.segments();
             vec![(s[0] >> 8) as u8,
                  s[0] as u8,
                  (s[1] >> 8) as u8,

src/maxminddb/reader_test.rs

@@ -1,7 +1,7 @@
 use super::{MaxMindDBError, Reader};
 
 use std::str::FromStr;
-use std::net::SocketAddr;
+use std::net::IpAddr;
 
 #[test]
 fn test_decoder() {
@@ -36,7 +36,7 @@ fn test_decoder() {
     }
 
     let r = Reader::open("test-data/test-data/MaxMind-DB-test-decoder.mmdb").ok().unwrap();
-    let ip: SocketAddr = FromStr::from_str("1.1.1.0:0").unwrap();
+    let ip: IpAddr = FromStr::from_str("1.1.1.0").unwrap();
     let result: TestType = r.lookup(ip).unwrap();
 
     assert_eq!(result.array, vec![1usize, 2usize, 3usize]);
@@ -68,7 +68,7 @@ fn test_broken_database() {
     let r = Reader::open("test-data/test-data/GeoIP2-City-Test-Broken-Double-Format.mmdb")
                 .ok()
                 .unwrap();
-    let ip: SocketAddr = FromStr::from_str("[2001:220::]:0").unwrap();
+    let ip: IpAddr = FromStr::from_str("2001:220::").unwrap();
 
     #[derive(RustcDecodable, Debug)]
     struct TestType;
@@ -148,51 +148,50 @@ fn check_metadata(reader: &Reader, ip_version: usize, record_size: usize) {
 fn check_ip(reader: &Reader, ip_version: usize) {
 
     let subnets = match ip_version {
-        6 => [["[::1:ffff:ffff]", "::1:ffff:ffff"],
-              ["[::2:0:0]", "::2:0:0"],
-              ["[::2:0:1]", "::2:0:0"],
-              ["[::2:0:33]", "::2:0:0"],
-              ["[::2:0:39]", "::2:0:0"],
-              ["[::2:0:40]", "::2:0:40"],
-              ["[::2:0:41]", "::2:0:40"],
-              ["[::2:0:49]", "::2:0:40"],
-              ["[::2:0:50]", "::2:0:50"],
-              ["[::2:0:52]", "::2:0:50"],
-              ["[::2:0:57]", "::2:0:50"],
-              ["[::2:0:58]", "::2:0:58"],
-              ["[::2:0:59]", "::2:0:58"]],
-        _ => [["1.1.1.1", "1.1.1.1"],
-              ["1.1.1.2", "1.1.1.2"],
-              ["1.1.1.3", "1.1.1.2"],
-              ["1.1.1.4", "1.1.1.4"],
-              ["1.1.1.5", "1.1.1.4"],
-              ["1.1.1.6", "1.1.1.4"],
-              ["1.1.1.7", "1.1.1.4"],
-              ["1.1.1.8", "1.1.1.8"],
-              ["1.1.1.9", "1.1.1.8"],
-              ["1.1.1.15", "1.1.1.8"],
-              ["1.1.1.16", "1.1.1.16"],
-              ["1.1.1.17", "1.1.1.16"],
-              ["1.1.1.31", "1.1.1.16"]],
+        6 => ["::1:ffff:ffff",
+              "::2:0:0",
+              "::2:0:0",
+              "::2:0:0",
+              "::2:0:0",
+              "::2:0:40",
+              "::2:0:40",
+              "::2:0:40",
+              "::2:0:50",
+              "::2:0:50",
+              "::2:0:50",
+              "::2:0:58",
+              "::2:0:58"],
+        _ => ["1.1.1.1",
+              "1.1.1.2",
+              "1.1.1.2",
+              "1.1.1.4",
+              "1.1.1.4",
+              "1.1.1.4",
+              "1.1.1.4",
+              "1.1.1.8",
+              "1.1.1.8",
+              "1.1.1.8",
+              "1.1.1.16",
+              "1.1.1.16",
+              "1.1.1.16"],
     };
 
     #[derive(RustcDecodable, Debug)]
     struct IpType {
         ip: String,
     }
 
-    for values in subnets.iter() {
-        let addr = format!("{}:0", values[0]);
-        let ip: SocketAddr = FromStr::from_str(&addr).unwrap();
+    for subnet in subnets.iter() {
+        let ip: IpAddr = FromStr::from_str(&subnet).unwrap();
         let value: IpType = reader.lookup(ip).unwrap();
 
-        assert_eq!(value.ip, values[1].to_string());
+        assert_eq!(value.ip, subnet.to_string());
     }
 
-    let no_record = ["1.1.1.33:0", "255.254.253.123:0", "[89fa::]:0"];
+    let no_record = ["1.1.1.33", "255.254.253.123", "89fa::"];
 
     for &address in no_record.iter() {
-        let ip: SocketAddr = FromStr::from_str(address).unwrap();
+        let ip: IpAddr = FromStr::from_str(address).unwrap();
         match reader.lookup::<IpType>(ip) {
             Ok(v) => panic!("received an unexpected value: {:?}", v),
             Err(e) =>