Struct Reader

pub struct Reader<S: AsRef<[u8]>> {
    pub metadata: Metadata,
    /* private fields */
}

A reader for the MaxMind DB format. The lifetime 'data is tied to the lifetime of the underlying buffer holding the contents of the database file.

Fields

metadata: Metadata

Implementations

impl Reader<Vec<u8>>

pub fn open_readfile<P: AsRef<Path>>( database: P, ) -> Result<Reader<Vec<u8>>, MaxMindDbError>

Open a MaxMind DB database file by loading it into memory.

Example

let reader = maxminddb::Reader::open_readfile("test-data/test-data/GeoIP2-City-Test.mmdb").unwrap();

impl<'de, S: AsRef<[u8]>> Reader<S>

pub fn from_source(buf: S) -> Result<Reader<S>, MaxMindDbError>

Open a MaxMind DB database from anything that implements AsRef<u8>

Example

use std::fs;
let buf = fs::read("test-data/test-data/GeoIP2-City-Test.mmdb").unwrap();
let reader = maxminddb::Reader::from_source(buf).unwrap();

pub fn lookup<T>( &'de self, address: IpAddr, ) -> Result<Option<T>, MaxMindDbError>

where T: Deserialize<'de>,

Lookup the socket address in the opened MaxMind DB. Returns Ok(None) if the address is not found in the database.

Example:

let reader = maxminddb::Reader::open_readfile("test-data/test-data/GeoIP2-City-Test.mmdb")?;

let ip: IpAddr = FromStr::from_str("89.160.20.128").unwrap();
if let Some(city) = reader.lookup::<geoip2::City>(ip)? {
    println!("{:?}", city);
} else {
    println!("Address not found");
}

pub fn lookup_prefix<T>( &'de self, address: IpAddr, ) -> Result<(Option<T>, usize), MaxMindDbError>

where T: Deserialize<'de>,

Lookup the socket address in the opened MaxMind DB, returning the found value (if any) and the prefix length of the network associated with the lookup.

Returns Ok((None, prefix_len)) if the address is found in the tree but has no data record. Returns Err(...) for database errors (IO, corruption, decoding).

Example:

let reader = maxminddb::Reader::open_readfile("test-data/test-data/GeoIP2-City-Test.mmdb")?;

let ip: IpAddr = "89.160.20.128".parse().unwrap(); // Known IP
let ip_unknown: IpAddr = "10.0.0.1".parse().unwrap(); // Unknown IP

let (city_option, prefix_len) = reader.lookup_prefix::<geoip2::City>(ip)?;
if let Some(city) = city_option {
    println!("Found {:?} at prefix length {}", city.city.unwrap().names.unwrap().get("en").unwrap(), prefix_len);
} else {
    // This case is less likely with lookup_prefix if the IP resolves in the tree
    println!("IP found in tree but no data (prefix_len: {})", prefix_len);
}

let (city_option_unknown, prefix_len_unknown) = reader.lookup_prefix::<geoip2::City>(ip_unknown)?;
assert!(city_option_unknown.is_none());
println!("Unknown IP resolved to prefix_len: {}", prefix_len_unknown);

pub fn within<T>( &'de self, cidr: IpNetwork, ) -> Result<Within<'de, T, S>, MaxMindDbError>

where T: Deserialize<'de>,

Iterate over blocks of IP networks in the opened MaxMind DB

Example:

use ipnetwork::IpNetwork;
use maxminddb::{geoip2, Within};

let reader = maxminddb::Reader::open_readfile("test-data/test-data/GeoIP2-City-Test.mmdb").unwrap();

let ip_net = IpNetwork::V6("::/0".parse().unwrap());
let mut iter: Within<geoip2::City, _> = reader.within(ip_net).unwrap();
while let Some(next) = iter.next() {
    let item = next.unwrap();
    println!("ip_net={}, city={:?}", item.ip_net, item.info);
}

Trait Implementations

impl<S: Debug + AsRef<[u8]>> Debug for Reader<S>

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

Formats the value using the given formatter.