Struct GeoCatalog 

pub struct GeoCatalog {
    pub regions: Vec<GeoRegion>,
    pub subregions: Vec<GeoSubregion>,
    pub countries: Vec<GeoCountry>,
}

The regions, sub-regions and countries a geo ban can name (ISO 3166-1 + UN M49), as Core serves them from Relay’s country table (GET /api/v1/geo). A geo ban code is valid only if it is in here at its level.

Read it with Geo::catalog; name lookups are methods (GeoCatalog::parse_area, GeoCatalog::name, GeoCatalog::known_areas). Core lets clients cache it for a day; serializable, so a caller can keep a copy.

Fields

regions: Vec<GeoRegion>

Continent-sized UN M49 regions (Europe, 150).

subregions: Vec<GeoSubregion>

UN M49 sub-regions (Southern Europe, 39).

countries: Vec<GeoCountry>

Countries and territories (Croatia, 191).

Implementations

impl GeoCatalog

pub fn parse_area(&self, input: &str) -> Result<GeoArea>

Resolves what a user typed. Accepted, case-insensitive: level:code or level:name (country:276, region:Europe), a country alpha-2 or alpha-3 code (DE, DEU), a country, region or sub-region name. A bare number is ambiguous (region and country codes overlap) and needs a level prefix.

Errors

Error::InvalidInput for an unknown or ambiguous area, or a code that is not in the catalog at its level (Core would refuse it); the message says what is accepted. GeoCatalog::known_areas lists every area.

Examples

use dinio_sdk::models::GeoCatalog;
use dinio_sdk::ops::GeoLevel;

// let catalog = client.geo().catalog().await?;
let hr = catalog.parse_area("HR")?;
assert_eq!((hr.level, hr.code), (GeoLevel::Country, 191));
assert_eq!(catalog.parse_area("croatia")?, hr);
assert_eq!(catalog.parse_area("Europe")?.level, GeoLevel::Region);
assert!(catalog.parse_area("150").is_err()); // region or country? say `region:150`
assert!(catalog.parse_area("country:999").is_err()); // not in the catalog

pub fn name(&self, area: GeoArea) -> Option<&str>

The area’s English name (Germany, Europe), if the catalog has it.

pub fn describe(&self, area: GeoArea) -> String

Country Germany (276); an area the catalog does not have shows without a name (Country 999).

pub fn known_areas(&self) -> Vec<KnownArea<'_>>

Every area: regions, then sub-regions, then countries.

Trait Implementations

impl Clone for GeoCatalog

fn clone(&self) -> GeoCatalog

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GeoCatalog

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GeoCatalog

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GeoCatalog

impl PartialEq for GeoCatalog

fn eq(&self, other: &GeoCatalog) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for GeoCatalog

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GeoCatalog