Struct screeps::LocalRoomName

pub struct LocalRoomName {
    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)

Implementations

impl LocalRoomName

pub fn new<T>(x: &T) -> Result<Self, LocalRoomNameParseError<'_>>where
    T: AsRef<str> + ?Sized,

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_coords(east: bool, north: bool, x_pos: i32, y_pos: i32) -> Self

Creates a new room name from the given position parameters.

Trait Implementations

impl Add<(i32, i32)> for LocalRoomName

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

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

type Output = LocalRoomName

The resulting type after applying the + operator.

impl Clone for LocalRoomName

fn clone(&self) -> LocalRoomName

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for LocalRoomName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LocalRoomName

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

Deserialize this value from the given Serde deserializer.

impl Display for LocalRoomName

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 LocalRoomName if passed into LocalRoomName::new.

impl Hash for LocalRoomName

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 PartialEq<LocalRoomName> for LocalRoomName

fn eq(&self, other: &LocalRoomName) -> 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 Serialize for LocalRoomName

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 LocalRoomName

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

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

type Output = LocalRoomName

The resulting type after applying the - operator.

impl Sub<LocalRoomName> for LocalRoomName

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

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

type Output = (i32, i32)

The resulting type after applying the - operator.

impl<'_a> TryFrom<&'_a LocalRoomName> for Value

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &'_a LocalRoomName) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_a> TryFrom<&'_a mut LocalRoomName> for Value

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &'_a mut LocalRoomName) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<LocalRoomName> for Value

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: LocalRoomName) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Value> for LocalRoomName

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for LocalRoomName

impl Eq for LocalRoomName

impl JsSerialize for LocalRoomName

impl StructuralEq for LocalRoomName

impl StructuralPartialEq for LocalRoomName