Struct Value 

pub struct Value<'v> {
    val: Local<'v, JSVal>,
}

Represents a JavaScript Value in the runtime. It can represent either a primitive or an object.

Fields

val: Local<'v, JSVal>

Implementations

impl<'v> Value<'v>

pub fn bool(cx: &Context, b: bool) -> Value<'_>

Creates a Value from a boolean.

pub fn i32(cx: &Context, i: i32) -> Value<'_>

Creates a Value from a 32-bit signed integer.

pub fn u32(cx: &Context, u: u32) -> Value<'_>

Creates a Value from a 32-bit unsigned integer.

pub fn f64(cx: &Context, f: f64) -> Value<'_>

Creates a Value from a 64-bit float.

pub fn string(cx: &'v Context, str: &str) -> Value<'v>

Creates a Value from a string.

pub fn bigint<'cx>(cx: &'cx Context, bi: &BigInt<'_>) -> Value<'cx>

Creates a Value from a BigInt.

pub fn symbol<'cx>(cx: &'cx Context, sym: &Symbol<'_>) -> Value<'cx>

Creates a Value from a Symbol.

pub fn object<'cx>(cx: &'cx Context, object: &Object<'_>) -> Value<'cx>

Creates a Value from an Object.

pub fn array<'cx>(cx: &'cx Context, array: &Array<'_>) -> Value<'cx>

Creates a Value from an Array.

pub fn undefined(cx: &Context) -> Value<'_>

Creates an undefined Value.

pub fn null(cx: &Context) -> Value<'_>

Creates a null Value.

pub fn undefined_handle() -> Value<'v>

pub fn null_handle() -> Value<'v>

pub fn to_object<'cx>(&self, cx: &'cx Context) -> Object<'cx>

Converts a Value to an Object.

Panics

This panics if the Value is not an object.

pub fn is_same(&self, cx: &Context, other: &Value<'_>) -> bool

Compares two values for equality using the SameValue algorithm. This is identical to strict equality (===), except that NaN’s are equal and 0 !== -0.

pub fn to_source<'cx>(&self, cx: &'cx Context) -> String<'cx>

Methods from Deref<Target = Local<'v, JSVal>>

pub fn handle(&self) -> Handle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

pub fn handle_mut(&mut self) -> MutableHandle<'local, T>

Forms a Handle to the Local which can be passed to SpiderMonkey APIs.

Panics

Panics when a Local::Handle is passed.

pub fn get(&self) -> T

Trait Implementations

impl<'v> Debug for Value<'v>

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

Formats the value using the given formatter.

impl<'v> Deref for Value<'v>

type Target = Local<'v, Value>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for Value<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'v> From<Local<'v, Value>> for Value<'v>

fn from(val: Local<'v, JSVal>) -> Value<'v>

Converts to this type from the input type.

impl<'cx> FromValue<'cx> for Value<'cx>

type Config = ()

fn from_value( cx: &'cx Context, value: &Value<'_>, _: bool, _: (), ) -> Result<Value<'cx>>

Converts value to the desired type. strict and config determine the strictness of the conversion and specify additional conversion constraints respectively. Returns Err with the error if conversion fails.

impl<'cx> ToPropertyKey<'cx> for Value<'cx>

fn to_key(&self, cx: &'cx Context) -> Option<PropertyKey<'cx>>

Converts self to a new PropertyKey. Returns None when conversion fails.

impl<'cx> ToValue<'cx> for Value<'cx>

fn to_value(&self, cx: &'cx Context, value: &mut Value<'_>)

Converts self to a Value and stores it in value.

fn as_value(&self, cx: &'cx Context) -> Value<'cx>

Converts self to a new Value.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 16 bytes