Struct screeps::game::cpu::HeapStatistics
source · pub struct HeapStatistics { /* private fields */ }
Expand description
Object with info about the memory heap of your virtual machine.
Implementations§
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn total_heap_size(&self) -> u32
pub fn total_heap_size(&self) -> u32
The total heap consumed.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn total_heap_size_executable(&self) -> u32
pub fn total_heap_size_executable(&self) -> u32
The total heap consumed by executable code.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn total_physical_size(&self) -> u32
pub fn total_physical_size(&self) -> u32
The total amount of heap committed to memory.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn total_available_size(&self) -> u32
pub fn total_available_size(&self) -> u32
Amount of heap available for allocation.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn used_heap_size(&self) -> u32
pub fn used_heap_size(&self) -> u32
Total heap consumed by application data.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn heap_size_limit(&self) -> u32
pub fn heap_size_limit(&self) -> u32
The allowed limit for total heap memory.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn malloced_memory(&self) -> u32
pub fn malloced_memory(&self) -> u32
Total amount of memory obtained by malloc.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn peak_malloced_memory(&self) -> u32
pub fn peak_malloced_memory(&self) -> u32
Maximum amount of memory obtained by malloc.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn does_zap_garbage(&self) -> u32
pub fn does_zap_garbage(&self) -> u32
Whether the virtual machine overwrites memory as it deallocates - usually 0.
source§impl HeapStatistics
impl HeapStatistics
sourcepub fn externally_allocated_size(&self) -> u32
pub fn externally_allocated_size(&self) -> u32
External allocations that are outside of the v8 heap but still count against the memory limit.
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<HeapStatistics> for HeapStatistics
impl AsRef<HeapStatistics> for HeapStatistics
source§fn as_ref(&self) -> &HeapStatistics
fn as_ref(&self) -> &HeapStatistics
source§impl AsRef<JsValue> for HeapStatistics
impl AsRef<JsValue> for HeapStatistics
source§impl Deref for HeapStatistics
impl Deref for HeapStatistics
source§impl From<HeapStatistics> for JsValue
impl From<HeapStatistics> for JsValue
source§fn from(obj: HeapStatistics) -> JsValue
fn from(obj: HeapStatistics) -> JsValue
source§impl From<JsValue> for HeapStatistics
impl From<JsValue> for HeapStatistics
source§fn from(obj: JsValue) -> HeapStatistics
fn from(obj: JsValue) -> HeapStatistics
source§impl FromWasmAbi for HeapStatistics
impl FromWasmAbi for HeapStatistics
source§impl<'a> IntoWasmAbi for &'a HeapStatistics
impl<'a> IntoWasmAbi for &'a HeapStatistics
source§impl IntoWasmAbi for HeapStatistics
impl IntoWasmAbi for HeapStatistics
source§impl JsCast for HeapStatistics
impl JsCast for HeapStatistics
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 HeapStatistics
impl LongRefFromWasmAbi for HeapStatistics
§type Abi = <JsValue as LongRefFromWasmAbi>::Abi
type Abi = <JsValue as LongRefFromWasmAbi>::Abi
RefFromWasmAbi::Abi
§type Anchor = HeapStatistics
type Anchor = HeapStatistics
RefFromWasmAbi::Anchor
source§unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor
RefFromWasmAbi::ref_from_abi
source§impl OptionFromWasmAbi for HeapStatistics
impl OptionFromWasmAbi for HeapStatistics
source§impl<'a> OptionIntoWasmAbi for &'a HeapStatistics
impl<'a> OptionIntoWasmAbi for &'a HeapStatistics
source§impl OptionIntoWasmAbi for HeapStatistics
impl OptionIntoWasmAbi for HeapStatistics
source§impl RefFromWasmAbi for HeapStatistics
impl RefFromWasmAbi for HeapStatistics
§type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
Self
are recovered from.§type Anchor = ManuallyDrop<HeapStatistics>
type Anchor = ManuallyDrop<HeapStatistics>
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.Auto Trait Implementations§
impl RefUnwindSafe for HeapStatistics
impl !Send for HeapStatistics
impl !Sync for HeapStatistics
impl Unpin for HeapStatistics
impl UnwindSafe for HeapStatistics
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> 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
.