Struct MaxMindIntel 

pub struct MaxMindIntel { /* private fields */ }

Available on crate feature maxmind only.

Country and ASN lookups from MaxMind databases (GeoLite2-City / GeoLite2-Country / GeoIP2-* for the country, GeoLite2-ASN for the network).

Databases are read into memory and can be swapped at runtime with reload (for example after a geoipupdate run); lookups on the request path are lock-free. Unknown addresses and lookup errors yield empty fields.

use session_guard::{Guard, GuardConfig, MaxMindIntel, MemoryStore};

let intel = MaxMindIntel::open(
    "/var/lib/GeoIP/GeoLite2-Country.mmdb",
    Some("/var/lib/GeoIP/GeoLite2-ASN.mmdb"),
)?;
let guard = Guard::builder(MemoryStore::new(), GuardConfig::default()).ip_intel(intel).build();

Implementations

impl MaxMindIntel

pub fn open( country_db: impl AsRef<Path>, asn_db: Option<impl AsRef<Path>>, ) -> Result<Self, MaxMindError>

Reads the country database (City or Country edition) and, optionally, the ASN database.

Errors

Fails when a file cannot be read, is not a valid MMDB file, or is the wrong kind of database.

pub fn from_bytes( country_db: Vec<u8>, asn_db: Option<Vec<u8>>, ) -> Result<Self, MaxMindError>

Like open, from database contents already in memory.

Errors

Fails when the bytes are not a valid MMDB file or the wrong kind of database.

pub fn reload( &self, country_db: impl AsRef<Path>, asn_db: Option<impl AsRef<Path>>, ) -> Result<(), MaxMindError>

Replaces both databases with freshly read files. In-flight lookups finish on the old databases. On error the current databases stay in place.

To reload a source the guard uses, wrap it in an Arc, pass a clone to GuardBuilder::ip_intel and keep the other.

Errors

As for open.

pub fn reload_from_bytes( &self, country_db: Vec<u8>, asn_db: Option<Vec<u8>>, ) -> Result<(), MaxMindError>

Like reload, from database contents already in memory.

Errors

As for from_bytes.

Trait Implementations

impl Debug for MaxMindIntel

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

Formats the value using the given formatter.

impl IpIntel for MaxMindIntel

fn lookup(&self, ip: IpAddr) -> IpInfo

Looks up ip. Return empty fields for unknown addresses; never panic.