Struct abstio::CityName

pub struct CityName {
    pub country: String,
    pub city: String,
}

A single city is identified using this.

Fields

country: String

A two letter lowercase country code, from https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2. To represent imaginary/test cities, use the code zz.

city: String

The name of the city, in filename-friendly form -- for example, "tel_aviv".

Implementations

impl CityName

pub fn new(country: &str, city: &str) -> CityName

Create a CityName from a country code and city.

pub fn seattle() -> CityName

Convenient constructor for the main city of the game.

pub fn list_all_cities_from_system_data() -> Vec<CityName>

Returns all city names based on system data.

pub fn list_all_cities_from_importer_config() -> Vec<CityName>

Returns all city names based on importer config.

pub fn parse(x: &str) -> Result<CityName>

Parses a CityName from something like "gb/london"; the inverse of to_path.

pub fn to_path(&self) -> String

Expresses the city as a path, like "gb/london"; the inverse of parse.

pub fn describe(&self) -> String

Stringify the city name for debug messages. Don't implement std::fmt::Display, to force callers to explicitly opt into this description, which could change.

pub fn input_path<I: AsRef<str>>(&self, file: I) -> String

Constructs the path to some city-scoped data/input.

Trait Implementations

impl Clone for CityName

fn clone(&self) -> CityName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CityName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CityName

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for CityName

impl Ord for CityName

fn cmp(&self, other: &CityName) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<CityName> for CityName

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<CityName> for CityName

fn partial_cmp(&self, other: &CityName) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &CityName) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &CityName) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &CityName) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &CityName) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for CityName

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

Serialize this value into the given Serde serializer.

impl StructuralEq for CityName

impl StructuralPartialEq for CityName