Struct IpGeoDb 

pub struct IpGeoDb { /* private fields */ }

Available on crate feature net only.

A collection of labelled IP geolocation sources, queried together.

Cheap to clone and safe to query concurrently, so it suits shared application state.

Implementations

impl IpGeoDb

pub fn builder() -> IpGeoDbBuilder

Start building an IpGeoDb.

pub fn len(&self) -> usize

Number of labelled sources.

pub fn is_empty(&self) -> bool

Whether there are no sources.

pub fn labels(&self) -> impl Iterator<Item = &str>

The source labels, in precedence order.

pub fn attributions(&self) -> impl Iterator<Item = &'static str>

The distinct attribution notices required by the loaded sources, derived from each source’s label (e.g. a geolite2 source requires the MaxMind GeoLite2 notice, an ip2location source the IP2Location LITE notice). Sources whose label maps to no known provider contribute nothing, so the result reflects only what is actually loaded.

The operator-assigned label is used rather than the database’s own database_type metadata: some providers ship that field set to another provider’s value (IP2Location’s MMDB reports GeoLite2-City), so it is not a reliable signal of origin.

Yielded lazily and de-duplicated; .collect() if you need a slice.

pub fn lookup(&self, ip: IpAddr) -> Option<GeoLocation>

Look up ip across every source and merge into a single GeoLocation, earlier sources taking precedence. Returns None if no source carries data for ip.

pub fn lookup_all(&self, ip: IpAddr) -> Vec<IpGeoSourceResult>

Look up ip in each source separately, returning the per-source (merged-within-source) results in precedence order. Sources without data for ip are omitted.

pub fn resolve(&self, ip: IpAddr) -> Option<IpGeoInfo>

Resolve ip into an IpGeoInfo (the merged location plus the per-source breakdown), or None if no source has data for it.

pub fn from_env() -> Result<Option<IpGeoDb>, GeoIpError>

Build from the RAMA_IP_GEO_DB_ENV environment variable.

Returns Ok(None) when the variable is unset or empty.

Errors

Returns GeoIpError if the value is malformed, set but not valid UTF-8, or a configured file cannot be loaded.

pub fn from_env_positional( config: &MmdbFileConfig, ) -> Result<Option<IpGeoDb>, GeoIpError>

Self::from_env, reading each configured file through positional reads with MmdbFileReader (configured by config) instead of loading it into memory. Each file follows replacements of its path.

Errors

Same as Self::from_env.

pub unsafe fn from_env_mmap() -> Result<Option<IpGeoDb>, GeoIpError>

Available on crate feature mmap only.

Self::from_env, memory-mapping each configured file through MmdbReader::open_mmap instead of reading it into memory.

Safety

Every file named by RAMA_IP_GEO_DB_ENV must meet the MmdbReader::open_mmap # Safety contract for as long as the returned database or any clone of it is alive.

Errors

Same as Self::from_env.

pub fn parse_spec(spec: &str) -> Result<IpGeoDb, GeoIpError>

Parse a configuration string of the form label=file[+file...][;label=file[+file...]...].

; separates sources; + joins several files under one label (queried and merged together). An entry without a label= prefix is labelled by the first file’s stem.

Errors

Returns GeoIpError::InvalidConfig for a malformed string, or GeoIpError::Source if a configured file cannot be loaded.

pub fn parse_spec_positional( spec: &str, config: &MmdbFileConfig, ) -> Result<IpGeoDb, GeoIpError>

Self::parse_spec, reading each configured file through positional reads with MmdbFileReader (configured by config) instead of loading it into memory. Each file follows replacements of its path.

Errors

Same as Self::parse_spec.

pub unsafe fn parse_spec_mmap(spec: &str) -> Result<IpGeoDb, GeoIpError>

Available on crate feature mmap only.

Self::parse_spec, memory-mapping each configured file through MmdbReader::open_mmap instead of reading it into memory.

Safety

Every file named in spec must meet the MmdbReader::open_mmap # Safety contract for as long as the returned database or any clone of it is alive.

Errors

Same as Self::parse_spec.

Trait Implementations

impl Clone for IpGeoDb

fn clone(&self) -> IpGeoDb

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for IpGeoDb

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

Formats the value using the given formatter.

impl Default for IpGeoDb

fn default() -> IpGeoDb

Returns the “default value” for a type.