Struct abstutil::MapName

pub struct MapName {
    pub city: String,
    pub map: String,
}

A single map is identified using this. Using a struct makes refactoring later easier, to organize cities hierarchially.

Fields

city: String

The name of the city, in filename-friendly form -- for example, "tel_aviv". In the future, this field may change to express more geographic hierarchy.

map: String

The name of the map within the city, in filename-friendly form -- for example, "downtown"

Implementations

impl MapName

pub fn new(city: &str, map: &str) -> MapName

Create a MapName from a simple city and map name.

pub fn seattle(map: &str) -> MapName

Convenient constructor for the main city of the game.

pub fn describe(&self) -> String

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

pub fn as_filename(&self) -> String

Stringify the map name for filenames.

pub fn from_path(path: &str) -> MapName

Transforms a path to a map back to a MapName. Crashes if the input is strange.

pub fn path(&self) -> String

Returns the filesystem path to this map.

pub fn list_all_maps() -> Vec<MapName>

Returns all maps from all cities.

Trait Implementations

impl Clone for MapName

fn clone(&self) -> MapName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MapName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for MapName

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

Deserialize this value from the given Serde deserializer.

impl Eq for MapName

impl Ord for MapName

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<MapName> for MapName

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

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

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

This method tests for !=.

impl PartialOrd<MapName> for MapName

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

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

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

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

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

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

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

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

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

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

impl Serialize for MapName

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 MapName

impl StructuralPartialEq for MapName