Struct JSValue 

pub struct JSValue<'a> { /* private fields */ }

A JavaScript value.

This is the basic type for managing values in JavaScriptCore. It can represent any JavaScript value, including undefined, null, booleans, numbers, strings, symbols, objects, and arrays.

Implementations

impl<'a> JSValue<'a>

pub fn new_undefined(ctx: &'a JSContext) -> Self

Creates a Javascript undefined value.

pub fn new_null(ctx: &'a JSContext) -> Self

Creates a Javascript null value.

pub fn new_boolean(ctx: &'a JSContext, value: bool) -> Self

Creates a Javascript boolean value.

pub fn new_number(ctx: &'a JSContext, value: f64) -> Self

Creates a Javascript numeric value.

pub fn new_symbol(ctx: &'a JSContext, description: &str) -> Self

Creates a unique Javascript symbol object.

description is a string that describes the symbol.

pub fn from_jsstring(ctx: &'a JSContext, value: JSString) -> Self

Converts a Javascript string object to a Javascript value.

pub fn new_string(ctx: &'a JSContext, value: &str) -> Self

Creates a Javascript string value from a Rust string.

If you have already JSString object, use JSValue::from_jsstring instead.

pub fn new_from_json(ctx: &'a JSContext, value: &str) -> Option<Self>

Creates a JavaScript value from a JSON formatted string.

Returns None if the JSON string is invalid.

impl JSValue<'_>

pub fn get_type(&self) -> JSType

Returns a JavaScript value’s type.

pub fn is_undefined(&self) -> bool

Returns true if the value is undefined.

pub fn is_null(&self) -> bool

Returns true if the value is null.

pub fn is_date(&self) -> bool

Returns true if the value is a JavaScript date object.

pub fn is_array(&self) -> bool

Returns true if the value is a JavaScript array.

pub fn is_symbol(&self) -> bool

Returns true if the value’s type is the symbol type

pub fn is_object(&self) -> bool

Returns true if the value is an object.

pub fn is_string(&self) -> bool

Returns true if the value is a string.

pub fn is_number(&self) -> bool

Returns true if the value is a number.

pub fn is_boolean(&self) -> bool

Returns true if the value is a boolean.

pub fn is_typed_array(&self) -> bool

Returns true if the value is a Typed Array.

impl<'a> JSValue<'a>

pub fn as_object(&self) -> Result<JSObject<'a>, JSValue<'a>>

Converts a JavaScript value to object.

Returns an Err if an exception is thrown.

pub fn as_string(&self) -> Result<JSString, JSValue<'a>>

Converts a JavaScript value to string.

Returns an Err if an exception is thrown.

pub fn as_number(&self) -> Result<f64, JSValue<'a>>

Converts a JavaScript value to number.

Returns an Err if an exception is thrown.

pub fn as_boolean(&self) -> bool

Converts a JavaScript value to boolean.

pub fn as_typed_array(&self) -> Result<JSTypedArray<'a>, JSValue<'a>>

Converts a JavaScript value to a typed array.

Returns an Err if the value is not a typed array, or if an exception is thrown.

pub fn to_json_string(&self) -> Result<JSString, JSValue<'a>>

Converts a JavaScript value to JSON serialized representation of a JS value.

Returns an Err if an exception is thrown.

Trait Implementations

impl<'a> AsRef<JSValue<'a>> for JSObject<'a>

fn as_ref(&self) -> &JSValue<'a>

Converts this type into a shared reference of the (usually inferred) input type.

impl<'a> AsRef<JSValue<'a>> for JSTypedArray<'a>

fn as_ref(&self) -> &JSValue<'a>

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for JSValue<'_>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JSValue<'_>

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

Formats the value using the given formatter.

impl Drop for JSValue<'_>

fn drop(&mut self)

Executes the destructor for this type.