Struct IpIntelligenceDataBase 

pub struct IpIntelligenceDataBase { /* private fields */ }

The concrete IP-intelligence element data both engines produce.

Embeds an AspectDataBase for the standard aspect plumbing (the dynamic property bag, the engine keys and the cache-hit flag) and keeps the typed values in dedicated stores next to it: one plain store per value type, plus a weighted store for the genuinely weighted properties. The generated IpIntelligenceData accessors read these stores by name; the dynamic ElementData bag holds a mirror so string-keyed lookups also work.

Implementations

impl IpIntelligenceDataBase

pub fn new(engine_key: impl Into<String>) -> Self

Create empty IP-intelligence data attributed to the engine with the given data key (typically IP_DATA_KEY_NAME).

pub fn from_base(base: AspectDataBase) -> Self

Create IP-intelligence data wrapping an existing AspectDataBase, preserving its bag, engine keys and cache-hit flag.

pub fn base(&self) -> &AspectDataBase

Borrow the embedded AspectDataBase.

pub fn base_mut(&mut self) -> &mut AspectDataBase

Mutably borrow the embedded AspectDataBase.

pub fn set_cache_hit(&mut self)

Mark this data as having been served from a cache hit.

pub fn add_engine_key(&mut self, engine_key: impl Into<String>)

Record that another engine (by data key) also contributed to this data.

pub fn set_string(&mut self, name: impl AsRef<str>, value: impl Into<String>)

Store a plain string-valued property and its dynamic-bag mirror.

This is the entry point a wrapper calls for the registered-range and textual location properties (including the IP range bounds). The property name is matched case-insensitively by the accessors and the dynamic bag.

pub fn set_float(&mut self, name: impl AsRef<str>, value: f32)

Store a plain single-precision float property (Latitude, Longitude) and its dynamic-bag mirror.

pub fn set_integer(&mut self, name: impl AsRef<str>, value: i32)

Store a plain integer property (TimeZoneOffset, AccuracyRadiusMin, the diversity scores) and its dynamic-bag mirror.

pub fn set_boolean(&mut self, name: impl AsRef<str>, value: bool)

Store a plain boolean property (IsBroadband, IsVPN, IsEu, and the rest of the network flags) and its dynamic-bag mirror.

pub fn set_weighted_string( &mut self, name: impl AsRef<str>, values: Vec<WeightedValue<String>>, )

Store a weighted string property (CountryCodesGeographical, CountryCodesPopulation, Mcc) and its dynamic-bag mirror.

The list is sorted high weighting first and mirrored into the dynamic bag as a PropertyValue::KeyValueList of value/weight records.

pub fn set_string_no_value( &mut self, name: impl AsRef<str>, message: impl Into<String>, )

Record that a string-valued property had no value, with an explanatory message. The matching accessor then returns a no-value carrying it.

pub fn set_float_no_value( &mut self, name: impl AsRef<str>, message: impl Into<String>, )

Record that a float-valued property had no value, with a message.

pub fn set_integer_no_value( &mut self, name: impl AsRef<str>, message: impl Into<String>, )

Record that an integer property had no value, with a message.

pub fn set_boolean_no_value( &mut self, name: impl AsRef<str>, message: impl Into<String>, )

Record that a boolean property had no value, with a message.

pub fn set_weighted_string_no_value( &mut self, name: impl AsRef<str>, message: impl Into<String>, )

Record that a weighted string property had no value, with a message.

pub fn string(&self, name: &str) -> AspectPropertyValue<String>

Read a plain string property by name, as the generated string accessors do.

pub fn float(&self, name: &str) -> AspectPropertyValue<f32>

Read a plain float property by name.

pub fn integer(&self, name: &str) -> AspectPropertyValue<i32>

Read a plain integer property by name.

pub fn boolean(&self, name: &str) -> AspectPropertyValue<bool>

Read a plain boolean property by name.

pub fn weighted_string( &self, name: &str, ) -> AspectPropertyValue<Vec<WeightedValue<String>>>

Read a weighted string property by name.

Returns AspectPropertyValue::NoValue when the property is absent or was recorded as a no-value. The list is ordered high weighting first. This is how the genuinely weighted properties (CountryCodesGeographical, CountryCodesPopulation, Mcc) are read.

Trait Implementations

impl AspectData for IpIntelligenceDataBase

fn engine_keys(&self) -> &[String]

The data keys of the engines that contributed to this data.

fn cache_hit(&self) -> bool

True if this data instance was the result of a cache hit rather than the engine processing the evidence.

impl Clone for IpIntelligenceDataBase

fn clone(&self) -> IpIntelligenceDataBase

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IpIntelligenceDataBase

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

Formats the value using the given formatter.

impl ElementData for IpIntelligenceDataBase

fn get(&self, name: &str) -> Result<PropertyValue, NoValueError>

Get a property value by name.

fn keys(&self) -> Vec<String>

List the property names available in this data. The order is unspecified.

fn as_any(&self) -> &dyn Any

Borrow this value as &dyn Any for downcasting to the concrete type.

fn as_any_mut(&mut self) -> &mut dyn Any

Borrow this value as &mut dyn Any for downcasting to the concrete type.

impl IpIntelligenceData for IpIntelligenceDataBase

fn accuracy_radius_max(&self) -> AspectPropertyValue<i32>

Radius in kilometers of the circle centred around the most probable location that encompasses the entire area. Where multiple areas are returned, this will only cover the area the most probable location is in. See Areas property. This will likely be a very large distance. It is recommend to use the AccuracyRadiusMin property.

fn accuracy_radius_min(&self) -> AspectPropertyValue<i32>

Radius in kilometers of the largest circle centred around the most probable location that fits within the area. Where multiple areas are returned, only the area that the most probable location falls within is considered. See Areas property.

fn areas(&self) -> AspectPropertyValue<String>

Any shapes associated with the location. Usually this is the area which the IP range covers. This is returned as a WKT String stored as a reduced format of WKB.

fn asn(&self) -> AspectPropertyValue<String>

Autonomous System Number associated with the IP address.

fn asn_name(&self) -> AspectPropertyValue<String>

The name registered to the Asn associated with the IP address.

fn browser_diversity(&self) -> AspectPropertyValue<i32>

Refers to the diversity of browsers observed from the IP range. An integer between 1-10, a lower value indicates a low number of browsers seen per IP address, while a higher value indicates a high number of browsers seen per IP address. A 0 value indicates that the probability is unknown.

fn connection_type(&self) -> AspectPropertyValue<String>

Indicates the type of connection being used. Returns either Broadband, Cellular, or Hosting and Anonymous.

fn continent_code2(&self) -> AspectPropertyValue<String>

The 3-character ISO 3166-1 continent code for the supplied location.

fn continent_name(&self) -> AspectPropertyValue<String>

The name of the continent the supplied location is in.

fn country(&self) -> AspectPropertyValue<String>

The name of the country that the supplied location is in.

fn country_code(&self) -> AspectPropertyValue<String>

The 2-character ISO 3166-1 code of the country that the supplied location is in.

fn country_code3(&self) -> AspectPropertyValue<String>

The 3-character ISO 3166-1 alpha-3 code of the country that the supplied location is in.

fn country_codes_geographical( &self, ) -> AspectPropertyValue<Vec<WeightedValue<String>>>

A list of countries in ISO 3166-1 alpha-2 country code format that overlap with the area likely associated with the provided evidence, weighted and ordered by each country’s proportion of the area. Administrative areas that cannot be cleanly resolved to the country level will not contribute to the resulting data.

fn country_codes_population( &self, ) -> AspectPropertyValue<Vec<WeightedValue<String>>>

A list of countries in ISO 3166-1 alpha-2 country code format that overlap with the area likely associated with the provided evidence, weighted and ordered by each country’s proportion of the total population within the area. Administrative areas that cannot be cleanly resolved to the country level will not contribute to the resulting data.

fn county(&self) -> AspectPropertyValue<String>

The name of the county that the supplied location is in. In this case, a county is defined as an administrative sub-section of a country or state.

fn currency_code(&self) -> AspectPropertyValue<String>

The Alpha-3 ISO 4217 code of the currency associated with the supplied location.

fn dial_code(&self) -> AspectPropertyValue<String>

ITU international telephone numbering plan code for the country.

fn hardware_diversity(&self) -> AspectPropertyValue<i32>

Refers to the diversity of hardware devices observed from the IP range. An integer between 1-10, a lower value indicates a low number of devices seen per IP address, while a higher value indicates a high number of devices seen per IP address. A 0 value indicates that the probability is unknown.

fn human_probability(&self) -> AspectPropertyValue<i32>

The confidence that the IP address is a human user versus associated with hosting. A 0-10 value where; 0-3: Low confidence the user is human, 4-6: Medium confidence, 7-10: High confidence. A -1 value indicates that the probability is unknown.

fn ip(&self) -> AspectPropertyValue<String>

The IPv4 address of the request.

fn ip_range_end(&self) -> AspectPropertyValue<String>

End of the IP range to which the evidence IP belongs.

fn ip_range_start(&self) -> AspectPropertyValue<String>

Start of the IP range to which the evidence IP belongs.

fn ip_v6(&self) -> AspectPropertyValue<String>

The IPv6 address of the request.

fn is_broadband(&self) -> AspectPropertyValue<bool>

Indicates whether the IP address is associated with a broadband connection. Includes DSL, Cable, Fibre, and Satellite connections.

fn is_cellular(&self) -> AspectPropertyValue<bool>

Indicates whether the IP address is associated with a cellular network.

fn is_eu(&self) -> AspectPropertyValue<bool>

Indicates whether the country of the supplied location is within the European Union.

fn is_hosted(&self) -> AspectPropertyValue<bool>

Indicates whether the IP address is associated with hosting. Includes both hosting and anonymised connections such as hosting networks, hosting ASNs, VPNs, proxies, TOR networks, and unreachable IP addresses.

fn iso31662_lvl4(&self) -> AspectPropertyValue<String>

The ISO 3166-2 code for the supplied location. This is using the ‘ISO3166-2-lvl4’ property from OpenStreetMap.

fn iso31662_lvl4_subdivision_only(&self) -> AspectPropertyValue<String>

The alphanumeric code representing the subdivision from the ISO 3166-2 code of the supplied location. This is using the ‘ISO3166-2-lvl4’ property from OpenStreetMap.

fn iso31662_lvl8(&self) -> AspectPropertyValue<String>

The ISO 3166-2 code for the supplied location. This is using the ‘ISO3166-2-lvl8’ property from OpenStreetMap.

fn iso31662_lvl8_subdivision_only(&self) -> AspectPropertyValue<String>

The alphanumeric code representing the subdivision from the ISO 3166-2 code of the supplied location. This is using the ‘ISO3166-2-lvl8’ property from OpenStreetMap.

fn is_proxy(&self) -> AspectPropertyValue<bool>

Indicates whether the IP address is associated with a Proxy server.

fn is_public_router(&self) -> AspectPropertyValue<bool>

Indicates whether the IP address is associated with a public router.

fn is_tor(&self) -> AspectPropertyValue<bool>

Indicates whether the IP address is associated with a TOR server.

fn is_vpn(&self) -> AspectPropertyValue<bool>

Indicates whether the IP address is associated with a VPN server.

fn language_code(&self) -> AspectPropertyValue<String>

The Alpha-2 ISO 639 Language code associated with the supplied location.

fn latitude(&self) -> AspectPropertyValue<f32>

Average latitude of the IP. For privacy, this is randomized within around 1 kilometer of the result. Randomized result will change only once per day.

fn location_confidence(&self) -> AspectPropertyValue<String>

The confidence in the town and country provided.

fn longitude(&self) -> AspectPropertyValue<f32>

Average longitude of the IP. For privacy, this is randomized within around 1 kilometer of the result. Randomized result will change only once per day.

fn mcc(&self) -> AspectPropertyValue<Vec<WeightedValue<String>>>

The mobile country code of the network the device is connected to.

fn platform_diversity(&self) -> AspectPropertyValue<i32>

Refers to the diversity of software observed from the IP range. An integer between 1-10, a lower value indicates a low number of software seen per IP address, while a higher value indicates a high number of software seen per IP address. A 0 value indicates that the probability is unknown.

fn region(&self) -> AspectPropertyValue<String>

The name of the geographical region that the supplied location is in.

fn registered_country(&self) -> AspectPropertyValue<String>

Country code of the registered range.

fn registered_name(&self) -> AspectPropertyValue<String>

Name of the IP range. This is usually the owner.

fn registered_owner(&self) -> AspectPropertyValue<String>

Registered owner of the range.

fn state(&self) -> AspectPropertyValue<String>

The name of the state that the supplied location is in.

fn suburb(&self) -> AspectPropertyValue<String>

The name of the suburb that the supplied location is in.

fn time_zone_iana(&self) -> AspectPropertyValue<String>

The time zone at the supplied location in the IANA Time Zone format.

fn time_zone_offset(&self) -> AspectPropertyValue<i32>

The offset from UTC in minutes in the supplied location, at the time that the value is produced.

fn town(&self) -> AspectPropertyValue<String>

The name of the town that the supplied location is in.

fn zip_code(&self) -> AspectPropertyValue<String>

The zip or postal code that the supplied location falls under.