Struct screeps::local::RoomName

pub struct RoomName { /* private fields */ }

A structure representing a room name.

Ordering

To facilitate use as a key in a BTreeMap or other similar data structures, RoomName implements PartialOrd and Ord.

RoomNames are ordered first by y position, then by x position. North is considered less than south, and west less than east.

The total ordering is N127W127, N127W126, N127W125, …, N127W0, N127E0, …, N127E127, N126W127, …, S127E126, S127E127.

This follows left-to-right reading order when looking at the Screeps map from above.

Implementations

impl RoomName

pub fn new<T>(x: &T) -> Result<Self, RoomNameParseError>

where T: AsRef<str> + ?Sized,

Parses a room name from a string.

This will parse the input string, returning an error if it is in an invalid room name.

The expected format can be represented by the regex [ewEW][0-9]+[nsNS][0-9]+. If the sim feature is enabled, sim is also valid and uses the packed position of W127N127 (0), matching the game’s internal implementation of the sim room’s packed positions.

pub const fn x_coord(&self) -> i32

Gets the x coordinate.

For Wxx rooms, returns -xx - 1. For Exx rooms, returns xx.

pub const fn y_coord(&self) -> i32

Gets the y coordinate.

For Nyy rooms, returns -yy - 1. For Syy rooms, returns yy.

pub fn checked_add(&self, offset: (i32, i32)) -> Option<RoomName>

Adds an (x, y) pair to this room’s name.

Errors

Returns an error if the coordinates are outside of the valid room name bounds.

For a panicking variant of this function, use the implementation of ops::Add for (i32, i32).

pub fn to_array_string(&self) -> ArrayString<8>

Converts this RoomName into an efficient, stack-based string.

This is equivalent to ToString::to_string, but involves no allocation.

Trait Implementations

impl Add<(i32, i32)> for RoomName

fn add(self, (x, y): (i32, i32)) -> Self

Offsets this room name by a given horizontal and vertical (x, y) pair.

The first number offsets to the west when negative and to the east when positive. The first number offsets to the north when negative and to the south when positive.

Panics

Will panic if the addition overflows the boundaries of RoomName.

type Output = RoomName

The resulting type after applying the + operator.

impl Clone for RoomName

fn clone(&self) -> RoomName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RoomName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RoomName

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for RoomName

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

Formats this room name into the format the game expects.

Resulting string will be (E|W)[0-9]+(N|S)[0-9]+, and will result in the same RoomName if passed into RoomName::new.

If the sim feature is enabled, the room corresponding to W127N127 outputs sim instead.

impl From<&RoomName> for JsString

fn from(name: &RoomName) -> JsString

Converts to this type from the input type.

impl From<&RoomName> for JsValue

fn from(name: &RoomName) -> JsValue

Converts to this type from the input type.

impl From<RoomName> for JsString

fn from(name: RoomName) -> JsString

Converts to this type from the input type.

impl From<RoomName> for JsValue

fn from(name: RoomName) -> JsValue

Converts to this type from the input type.

impl FromStr for RoomName

type Err = RoomNameParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for RoomName

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl JsCollectionFromValue for RoomName

fn from_value(val: JsValue) -> Self

impl JsCollectionIntoValue for RoomName

fn into_value(self) -> JsValue

impl Ord for RoomName

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq<&String> for RoomName

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<&str> for RoomName

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomName> for &String

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomName> for &str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomName> for String

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<RoomName> for str

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<String> for RoomName

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq<str> for RoomName

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialEq for RoomName

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for RoomName

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

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

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

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

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

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

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

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

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

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

impl Serialize for RoomName

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<(i32, i32)> for RoomName

fn sub(self, (x, y): (i32, i32)) -> Self

Offsets this room name in the opposite direction from the coordinates.

See the implementation for Add<(i32, i32)>.

Panics

Will panic if the subtraction overflows the boundaries of RoomName.

type Output = RoomName

The resulting type after applying the - operator.

impl Sub for RoomName

fn sub(self, other: RoomName) -> (i32, i32)

Subtracts one room name from the other, extracting the difference.

The first return value represents east/west offset, with ‘more east’ being positive and ‘more west’ being negative.

The second return value represents north/south offset, with ‘more south’ being positive and ‘more north’ being negative.

This coordinate system agrees with the implementations Add<(i32, i32)> for RoomName and Sub<(i32, i32)> for RoomName.

type Output = (i32, i32)

The resulting type after applying the - operator.

impl TryFrom<JsString> for RoomName

type Error = <RoomName as FromStr>::Err

The type returned in the event of a conversion error.

fn try_from(val: JsString) -> Result<RoomName, Self::Error>

Performs the conversion.

impl TryFrom<JsValue> for RoomName

type Error = RoomNameConversionError

The type returned in the event of a conversion error.

fn try_from(val: JsValue) -> Result<RoomName, Self::Error>

Performs the conversion.

impl Copy for RoomName

impl Eq for RoomName

impl StructuralEq for RoomName

impl StructuralPartialEq for RoomName