Struct screeps::LocalRoomPosition

pub struct LocalRoomPosition {
    pub room_name: LocalRoomName,
    pub x: u32,
    pub y: u32,
}

This is a room position located in Rust memory.

It's "local" in the sense that while RoomPosition always references a room position allocated by and managed by the JavaScript VM, this is a self-contained plain-data struct in Rust memory.

Using LocalRoomPosition

A LocalRoomPosition can be retrieved at any point by using RoomPosition::local. It can then be copied around freely, and have its values modified.

&LocalRoomPosition can be passed into any game method taking an object, and will be automatically uploaded to JavaScript as a RoomPosition.

If you need to manually create a RoomPosition from a LocalRoomPosition, use LocalRoomPosition::remote.

Serialization

LocalRoomPosition implements both serde::Serialize and serde::Deserialize.

When serializing, it will use the obvious format of {roomName: String, x: u32, y: u32} in "human readable" formats like JSON, and a less obvious format {room_x: u32, room_y: u32, x: u32, y: u32} in "non-human readable" formats like bincode.

You can also pass LocalRoomPosition into JavaScript using the js!{} macro provided by stdweb, or helper methods using the same code like MemoryReference::set. It will be serialized the same as in JSON, as an object with roomName, x and y properties.

Note: serializing using js!{} or MemoryReference::set will not create a RoomPosition, only something with the same properties. Use .remote() if you need a RoomPosition.

Fields

room_name: LocalRoomName

x: u32

y: u32

Methods

impl LocalRoomPosition

pub fn remote(&self) -> RoomPosition

Trait Implementations

impl HasPosition for LocalRoomPosition

fn pos(&self) -> RoomPosition

impl PartialEq<LocalRoomPosition> for LocalRoomPosition

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

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

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

This method tests for !=.

impl Clone for LocalRoomPosition

fn clone(&self) -> LocalRoomPosition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for LocalRoomPosition

impl Eq for LocalRoomPosition

impl Hash for LocalRoomPosition

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 LocalRoomPosition

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

Formats the value using the given formatter.

impl Display for LocalRoomPosition

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

Formats this into a nice looking string mimicking RoomPosition's toString.

impl TryFrom<Value> for LocalRoomPosition

type Error = <Value as TryInto<String>>::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<LocalRoomPosition> for Value

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = ConversionError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl JsSerialize for LocalRoomPosition

fn _into_js<'x>(&'x self) -> SerializedValue<'x>

impl JsSerializeOwned for LocalRoomPosition

fn into_js_owned<'_a>(value: &'_a mut Option<Self>) -> SerializedValue<'_a>

impl<'_r> JsSerializeOwned for &'_r LocalRoomPosition

fn into_js_owned<'_a>(value: &'_a mut Option<Self>) -> SerializedValue<'_a>

impl Serialize for LocalRoomPosition

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 LocalRoomPosition

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

Deserialize this value from the given Serde deserializer.