Struct screeps::js_collections::JsObjectId

pub struct JsObjectId<T> {
    pub raw: JsString,
    /* private fields */
}

Represents a reference to an Object ID string in JavaScript memory, typed according to the object type Rust expects for the object after resolving.

Use ObjectId if a value stored in Rust memory is preferred; the JavaScript representation can be harder to work with in Rust code due to lack of visibility on the underlying string and lack of most trait implementations, and consumes more memory, but is faster to resolve and may be useful with objects you plan to resolve frequently.

This object ID is typed, but not strictly, and can be converted into referring into another type of object with JsObjectId::into_type.

Fields

raw: JsString

Implementations

impl<T> JsObjectId<T>

pub fn into_type<U>(self) -> JsObjectId<U>

Changes the type this JsObjectId points to, unchecked.

This will allow changing to any type - JsObjectId makes no guarantees about its ID matching the type of any object in the game that it actually points to.

pub fn resolve(&self) -> Option<T>

where T: MaybeHasId + JsCast,

Resolves this ID into an object, assuming the type T is the correct type of object that this ID refers to. If the ID has been converted to an invalid type, using the returned object in a way not valid for its type will cause a panic.

Will return None if this object no longer exists, or is in a room we don’t have vision for.

Trait Implementations

impl<T> Clone for JsObjectId<T>

fn clone(&self) -> JsObjectId<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for JsObjectId<T>

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

Formats the value using the given formatter.

impl<T> Display for JsObjectId<T>

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

Formats the value using the given formatter.

impl<T> From<JsObjectId<T>> for JsString

fn from(id: JsObjectId<T>) -> Self

Converts to this type from the input type.

impl<T> From<JsObjectId<T>> for String

fn from(id: JsObjectId<T>) -> Self

Converts to this type from the input type.

impl<T> From<JsString> for JsObjectId<T>

fn from(raw: JsString) -> Self

Converts to this type from the input type.

impl<T> FromStr for JsObjectId<T>

type Err = RawObjectIdParseError

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<T> PartialEq for JsObjectId<T>

fn eq(&self, o: &JsObjectId<T>) -> 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<T> Eq for JsObjectId<T>