Struct ip2proxy::Database

pub struct Database { /* private fields */ }

An IP2Proxy BIN database.

Implementations

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.and_then(|r| r.is_proxy()), Some(true));

Errors

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

pub fn package_version(&self) -> u8

Get package version.

Example

use ip2proxy::Database;

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

pub fn database_version(&self) -> String

Get database version as YY.M.D.

Example

use ip2proxy::Database;

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

pub fn columns(&self) -> Columns

Get the set of supported columns.

Example

use ip2proxy::{Columns, Database};

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

pub fn year(&self) -> u8

Get the database creation year. Convention is 16 for 2016.

pub fn month(&self) -> u8

Get the database creation month. Convention is 1 for January.

pub fn day(&self) -> u8

Get the database creation day. Convention is 1 for the first day of the month.

pub fn rows_ipv4(&self) -> u32

Get the number of rows for IPv4 addresses. Rows can cover a range, so there may be information for many more IP addresses.

pub fn rows_ipv6(&self) -> u32

Get the number of rows for IPv6 addresses. Rows can cover a range, so there may be information for many more IP addresses.

Trait Implementations

impl Debug for Database

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

Formats the value using the given formatter.