db_ip 0.3.11

An (unofficial) Rust library for querying db-ip.com data
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

#![forbid(unsafe_code)]
#![cfg_attr(all(test, feature = "nightly"), feature(test))]

pub use db_ip_core::*;

#[cfg(feature = "bincode")]
#[doc(hidden)]
pub use bincode;

#[cfg(feature = "include-region-lite")]
#[doc(hidden)]
pub const REGION_LITE_BYTES: &[u8] = include_bytes!(concat!(env!("OUT_DIR"), "/region_lite.bin"));

#[cfg(feature = "include-country-code-lite")]
#[doc(hidden)]
pub const COUNTRY_CODE_LITE_BYTES: &[u8] =
    include_bytes!(concat!(env!("OUT_DIR"), "/country_code_lite.bin"));

#[macro_export]
#[cfg(feature = "include-region-lite")]
macro_rules! include_region_database {
    () => {{
        let db: $crate::DbIpDatabase<$crate::Region> =
            $crate::bincode::deserialize($crate::REGION_LITE_BYTES).unwrap();
        db
    }};
}

#[macro_export]
#[cfg(feature = "include-country-code-lite")]
macro_rules! include_country_code_database {
    () => {{
        let db: $crate::DbIpDatabase<$crate::CountryCode> =
            $crate::bincode::deserialize($crate::COUNTRY_CODE_LITE_BYTES).unwrap();
        db
    }};
}

#[cfg(test)]
#[cfg(any(feature = "ipv4", feature = "ipv6"))]
mod test {
    #[cfg(feature = "nightly")]
    extern crate test;
    #[allow(unused_imports)]
    use crate::{CountryCode, DbIpDatabase};

    #[test]
    fn country_code() {
        assert_eq!(CountryCode::from_str("US"), CountryCode::from_str("us"));
    }

    #[test]
    #[cfg(all(feature = "ipv4", feature = "include-region-lite"))]
    fn region_v4() {
        use crate::Region;

        let db = include_region_database!();
        assert_eq!(
            db.get_v4(&"100.128.0.0".parse().unwrap()),
            Some(Region::NorthAmerica)
        );
    }

    #[test]
    #[cfg(all(feature = "ipv4", feature = "include-country-code-lite"))]
    fn country_code_v4() {
        let db = include_country_code_database!();
        println!("country code length v4: {}", db.len_v4());
        assert_eq!(
            db.get_v4(&"100.128.0.0".parse().unwrap()),
            Some(CountryCode::from_str("US").unwrap())
        );
    }

    #[test]
    #[cfg(all(feature = "ipv4", feature = "include-country-code-lite"))]
    fn city_country_code_v4() {
        let db = include_country_code_database!();
        println!("city country code length v4: {}", db.len_v4());
        assert_eq!(
            db.get_v4(&"100.128.0.0".parse().unwrap()),
            Some(CountryCode::from_str("US").unwrap())
        );
    }

    #[test]
    #[ignore = "unreliable - need ipv6 address with stable region"]
    #[cfg(all(feature = "ipv6", feature = "include-region-lite"))]
    fn region_v6() {
        use crate::Region;

        let db = crate::include_region_database!();
        assert_eq!(
            db.get_v6(&"2a07:7ec5:77a1::".parse().unwrap()),
            Some(Region::Europe)
        );
    }

    // cargo bench --features nightly  -- bench_region_v4
    #[allow(soft_unstable)]
    #[cfg(all(feature = "nightly", feature = "include-country-code-lite"))]
    #[bench]
    fn bench_region_v4(b: &mut test::Bencher) {
        use crate::Region;
        use std::net::Ipv4Addr;

        let db = crate::include_region_code_lite!();
        let mut i = 0u32;

        b.iter(|| {
            test::black_box(db.get_v4(&Ipv4Addr::from(i.to_be_bytes())));
            i = i.wrapping_add(1).wrapping_mul(7);
        });
    }

    // cargo bench --features nightly  -- bench_region_v6
    #[allow(soft_unstable)]
    #[cfg(all(
        feature = "nightly",
        feature = "csv",
        feature = "download-country-lite"
    ))]
    #[bench]
    fn bench_region_v6(b: &mut test::Bencher) {
        use std::net::Ipv6Addr;

        let db = crate::include_region_database!();
        let mut i = 0u128;

        b.iter(|| {
            test::black_box(db.get_v6(&Ipv6Addr::from(i.to_be_bytes())));
            i = i.wrapping_add(1).wrapping_mul(7);
        });
    }
}

doc_comment::doctest!("../README.md");