Struct screeps_api::RoomName

pub struct RoomName {
    pub x_coord: i32,
    pub y_coord: i32,
}

A structure representing a room name.

Fields

x_coord: i32

Inner x coordinate representation.

0 represents E0, positive numbers represent E(x)

-1 represents W0, negative numbers represent W((-x) - 1)

y_coord: i32

Inner y coordinate representation.

0 represents N0, positive numbers represent N(y)

-1 represents S0, negative numbers represent S((-y) - 1)

Methods

impl RoomName

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

Creates a new room name from the given input.

This will parse the input, and return an error if it is in an invalid format.

pub fn from_pos(east: bool, north: bool, x_pos: i32, y_pos: i32) -> Self

Creates a new room name from the given position parameters.

Trait Implementations

impl IntoRoomName for RoomName

fn into_room_name(&self) -> Result<RoomName, RoomNameParseError>

Turns this data into a room name, erroring if the format is not as expected.

impl PartialEq<RoomName> 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: &RoomName) -> bool

This method tests for !=.

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 From<RoomName> for RoomNameAbsoluteCoordinates

fn from(other: RoomName) -> RoomNameAbsoluteCoordinates

Performs the conversion.

impl From<RoomNameAbsoluteCoordinates> for RoomName

fn from(other: RoomNameAbsoluteCoordinates) -> RoomName

Performs the conversion.

impl Copy for RoomName

impl Eq for RoomName

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, 

Feeds a slice of this type into the given [Hasher].

impl Debug for RoomName

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

Formats the value using the given formatter.

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 an equal same RoomName if passed into into_room_name.

impl Add<(i32, i32)> for RoomName

type Output = RoomName

The resulting type after applying the + operator.

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

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

impl Sub<(i32, i32)> for RoomName

type Output = RoomName

The resulting type after applying the - operator.

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

Subtracts an (x, y) coordinate pair to this room name.

impl Sub<RoomName> for RoomName

type Output = (i32, i32)

The resulting type after applying the - operator.

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

Subtracts an (x, y) coordinate pair to this room name.

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<'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.