Struct ip2proxy::Database

pub struct Database { /* fields omitted */ }

An IP2Proxy BIN database.

Methods

impl Database

pub fn open<P: AsRef<Path>>(path: P) -> Result<Self>

Open a database file.

Example

use ip2proxy::Database;

let db = Database::open("data/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP.SAMPLE.BIN")?;

Errors

• Error while opening the file.
• Error while reading from the file.
• Invalid data in header section or index section.

pub fn query(&self, addr: IpAddr, query: Columns) -> Result<Option<Row>>

Look up information for an IP address.

The Columns parameter allows optimizing the lookup by limiting the number columns to retrieve.

Returns a Row, if any.

Example

use ip2proxy::{Columns, Database, Row};

let db = Database::open("data/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP.SAMPLE.BIN")?;

let row = db.query("1.0.0.1".parse()?, Columns::all())?;

assert_eq!(row, Some(Row {
    proxy_type: Some(String::from("DCH")),
    country_short: Some(String::from("AU")),
    country_long: Some(String::from("Australia")),
    region: Some(String::from("Queensland")),
    city: Some(String::from("Brisbane")),
    isp: Some(String::from("Research Prefix for APNIC Labs")),
    ..Row::default()
}));

Errors

• Error while reading from the source.
• Invalid row or string data.

pub fn header(&self) -> &Header

Get meta data from the database header.

Example

use ip2proxy::Database;

let db = Database::open("data/IP2PROXY-IP-PROXYTYPE-COUNTRY-REGION-CITY-ISP.SAMPLE.BIN")?;
let header = db.header();
assert_eq!(header.px(), 4);
assert_eq!(header.year(), 16); // 2016
assert_eq!(header.month(), 11); // November
assert_eq!(header.day(), 17); // 17th
assert_eq!(header.rows_ipv4(), 150);
assert_eq!(header.rows_ipv6(), 4);

Trait Implementations

impl Debug for Database

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.