pub struct Ruin { /* private fields */ }
Expand description
A Ruin
, which represents a destroyed structure and can have
resources withdrawn from it.
Implementations§
source§impl Ruin
impl Ruin
source§impl Ruin
impl Ruin
sourcepub fn structure(&self) -> Structure
pub fn structure(&self) -> Structure
Methods from Deref<Target = RoomObject>§
sourcepub fn js_pos(&self) -> RoomPosition
pub fn js_pos(&self) -> RoomPosition
Gets the RoomPosition
of an object, which is a reference to an
object in the javascript heap. In most cases, you’ll likely want a
native Position
instead of using this function (see
HasPosition::pos
), there may be cases where this can provide
some slight performance benefits due to reducing object churn in the js
heap, so this is kept public.
Methods from Deref<Target = JsValue>§
pub const NULL: JsValue = _
pub const UNDEFINED: JsValue = _
pub const TRUE: JsValue = _
pub const FALSE: JsValue = _
sourcepub fn as_f64(&self) -> Option<f64>
pub fn as_f64(&self) -> Option<f64>
Returns the f64
value of this JS value if it’s an instance of a
number.
If this JS value is not an instance of a number then this returns
None
.
sourcepub fn as_string(&self) -> Option<String>
Available on crate feature std
only.
pub fn as_string(&self) -> Option<String>
std
only.If this JS value is a string value, this function copies the JS string
value into wasm linear memory, encoded as UTF-8, and returns it as a
Rust String
.
To avoid the copying and re-encoding, consider the
JsString::try_from()
function from js-sys
instead.
If this JS value is not an instance of a string or if it’s not valid
utf-8 then this returns None
.
UTF-16 vs UTF-8
JavaScript strings in general are encoded as UTF-16, but Rust strings
are encoded as UTF-8. This can cause the Rust string to look a bit
different than the JS string sometimes. For more details see the
documentation about the str
type which contains a few
caveats about the encodings.
sourcepub fn as_bool(&self) -> Option<bool>
pub fn as_bool(&self) -> Option<bool>
Returns the bool
value of this JS value if it’s an instance of a
boolean.
If this JS value is not an instance of a boolean then this returns
None
.
sourcepub fn is_undefined(&self) -> bool
pub fn is_undefined(&self) -> bool
Tests whether this JS value is undefined
sourcepub fn is_function(&self) -> bool
pub fn is_function(&self) -> bool
Tests whether the type of this JS value is function
.
sourcepub fn js_in(&self, obj: &JsValue) -> bool
pub fn js_in(&self, obj: &JsValue) -> bool
Applies the binary in
JS operator on the two JsValue
s.
sourcepub fn loose_eq(&self, other: &JsValue) -> bool
pub fn loose_eq(&self, other: &JsValue) -> bool
Compare two JsValue
s for equality, using the ==
operator in JS.
sourcepub fn unsigned_shr(&self, rhs: &JsValue) -> u32
pub fn unsigned_shr(&self, rhs: &JsValue) -> u32
Applies the binary >>>
JS operator on the two JsValue
s.
sourcepub fn checked_div(&self, rhs: &JsValue) -> JsValue
pub fn checked_div(&self, rhs: &JsValue) -> JsValue
Applies the binary /
JS operator on two JsValue
s, catching and returning any RangeError
thrown.
sourcepub fn pow(&self, rhs: &JsValue) -> JsValue
pub fn pow(&self, rhs: &JsValue) -> JsValue
Applies the binary **
JS operator on the two JsValue
s.
sourcepub fn lt(&self, other: &JsValue) -> bool
pub fn lt(&self, other: &JsValue) -> bool
Applies the binary <
JS operator on the two JsValue
s.
sourcepub fn le(&self, other: &JsValue) -> bool
pub fn le(&self, other: &JsValue) -> bool
Applies the binary <=
JS operator on the two JsValue
s.
sourcepub fn ge(&self, other: &JsValue) -> bool
pub fn ge(&self, other: &JsValue) -> bool
Applies the binary >=
JS operator on the two JsValue
s.
sourcepub fn gt(&self, other: &JsValue) -> bool
pub fn gt(&self, other: &JsValue) -> bool
Applies the binary >
JS operator on the two JsValue
s.
sourcepub fn unchecked_into_f64(&self) -> f64
pub fn unchecked_into_f64(&self) -> f64
Applies the unary +
JS operator on a JsValue
. Can throw.
Trait Implementations§
source§impl AsRef<RoomObject> for Ruin
impl AsRef<RoomObject> for Ruin
source§fn as_ref(&self) -> &RoomObject
fn as_ref(&self) -> &RoomObject
source§impl CanDecay for Ruin
impl CanDecay for Ruin
source§fn ticks_to_decay(&self) -> u32
fn ticks_to_decay(&self) -> u32
source§impl Deref for Ruin
impl Deref for Ruin
§type Target = RoomObject
type Target = RoomObject
source§fn deref(&self) -> &RoomObject
fn deref(&self) -> &RoomObject
source§impl From<Ruin> for DecayingObject
impl From<Ruin> for DecayingObject
source§fn from(v: Ruin) -> DecayingObject
fn from(v: Ruin) -> DecayingObject
source§impl From<Ruin> for ObjectWithPosition
impl From<Ruin> for ObjectWithPosition
source§fn from(v: Ruin) -> ObjectWithPosition
fn from(v: Ruin) -> ObjectWithPosition
source§impl From<Ruin> for RoomObject
impl From<Ruin> for RoomObject
source§fn from(obj: Ruin) -> RoomObject
fn from(obj: Ruin) -> RoomObject
source§impl From<Ruin> for StoreObject
impl From<Ruin> for StoreObject
source§fn from(v: Ruin) -> StoreObject
fn from(v: Ruin) -> StoreObject
source§impl From<Ruin> for TypedRoomObject
impl From<Ruin> for TypedRoomObject
source§fn from(v: Ruin) -> TypedRoomObject
fn from(v: Ruin) -> TypedRoomObject
source§impl FromWasmAbi for Ruin
impl FromWasmAbi for Ruin
source§impl HasId for Ruin
impl HasId for Ruin
source§fn js_raw_id(&self) -> JsString
fn js_raw_id(&self) -> JsString
source§fn id(&self) -> ObjectId<Self>where
Self: Sized,
fn id(&self) -> ObjectId<Self>where
Self: Sized,
source§fn raw_id(&self) -> RawObjectId
fn raw_id(&self) -> RawObjectId
source§fn js_id(&self) -> JsObjectId<Self>where
Self: Sized,
fn js_id(&self) -> JsObjectId<Self>where
Self: Sized,
source§impl<'a> IntoWasmAbi for &'a Ruin
impl<'a> IntoWasmAbi for &'a Ruin
source§impl IntoWasmAbi for Ruin
impl IntoWasmAbi for Ruin
source§impl JsCast for Ruin
impl JsCast for Ruin
source§fn instanceof(val: &JsValue) -> bool
fn instanceof(val: &JsValue) -> bool
instanceof
check to see whether the JsValue
provided is an instance of this type. Read moresource§fn unchecked_from_js(val: JsValue) -> Self
fn unchecked_from_js(val: JsValue) -> Self
source§fn unchecked_from_js_ref(val: &JsValue) -> &Self
fn unchecked_from_js_ref(val: &JsValue) -> &Self
source§fn has_type<T>(&self) -> boolwhere
T: JsCast,
fn has_type<T>(&self) -> boolwhere
T: JsCast,
T
. Read moresource§fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
fn dyn_into<T>(self) -> Result<T, Self>where
T: JsCast,
T
. Read moresource§fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
fn dyn_ref<T>(&self) -> Option<&T>where
T: JsCast,
T
. Read moresource§fn unchecked_into<T>(self) -> Twhere
T: JsCast,
fn unchecked_into<T>(self) -> Twhere
T: JsCast,
source§fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
fn unchecked_ref<T>(&self) -> &Twhere
T: JsCast,
source§impl LongRefFromWasmAbi for Ruin
impl LongRefFromWasmAbi for Ruin
source§impl OptionFromWasmAbi for Ruin
impl OptionFromWasmAbi for Ruin
source§impl<'a> OptionIntoWasmAbi for &'a Ruin
impl<'a> OptionIntoWasmAbi for &'a Ruin
source§impl OptionIntoWasmAbi for Ruin
impl OptionIntoWasmAbi for Ruin
source§impl RefFromWasmAbi for Ruin
impl RefFromWasmAbi for Ruin
§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.§type Anchor = ManuallyDrop<Ruin>
type Anchor = ManuallyDrop<Ruin>
Self
for the duration of the
invocation of the function that has an &Self
parameter. This is
required to ensure that the lifetimes don’t persist beyond one function
call, and so that they remain anonymous.source§impl TryInto<Ruin> for DecayingObject
impl TryInto<Ruin> for DecayingObject
source§impl TryInto<Ruin> for ObjectWithPosition
impl TryInto<Ruin> for ObjectWithPosition
source§impl TryInto<Ruin> for StoreObject
impl TryInto<Ruin> for StoreObject
source§impl TryInto<Ruin> for TypedRoomObject
impl TryInto<Ruin> for TypedRoomObject
impl Withdrawable for Ruin
Auto Trait Implementations§
impl RefUnwindSafe for Ruin
impl !Send for Ruin
impl !Sync for Ruin
impl Unpin for Ruin
impl UnwindSafe for Ruin
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> HasPosition for Twhere
T: AsRef<RoomObject>,
impl<T> HasPosition for Twhere
T: AsRef<RoomObject>,
source§impl<T> MaybeHasId for Twhere
T: HasId,
impl<T> MaybeHasId for Twhere
T: HasId,
source§fn try_js_raw_id(&self) -> Option<JsString>
fn try_js_raw_id(&self) -> Option<JsString>
None
if the object doesn’t currently
have an ID.source§fn try_id(&self) -> Option<ObjectId<Self>>where
Self: Sized,
fn try_id(&self) -> Option<ObjectId<Self>>where
Self: Sized,
None
if the
object doesn’t currently have an ID.source§fn try_raw_id(&self) -> Option<RawObjectId>
fn try_raw_id(&self) -> Option<RawObjectId>
None
if the object doesn’t currently have an ID.source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
IntoWasmAbi::Abi
source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.