Enum sljs::value::JSValue

pub enum JSValue {
    Undefined,
    Bool(bool),
    Number(JSNumber),
    String(JSString),
    Ref(JSRef),
}

A JSValue is either a primitive value or a reference to an object.

Variants

Undefined

Bool(bool)

Number(JSNumber)

String(JSString)

Ref(JSRef)

Implementations

impl JSValue

pub const NULL: JSValue = _

pub fn to_ref(&self) -> JSResult<JSRef>

to_ref() tries to return the underlying object reference, if any. Throws Exception::ReferenceNotAnObject if it’s not a reference. Checking if a JSValue is a reference: val.to_ref().is_ok().

pub fn to_json(&self, heap: &Heap) -> JSResult<JSON>

pub fn to_string(&self, heap: &mut Heap) -> JSResult<JSString>

to_string() makes a human-readable string representation of the value:

assert_eq!(
    JSValue::from("1").to_string(&mut heap).unwrap().as_str(),
    "\"1\""
);
assert_eq!(
    JSValue::from(1).to_string(&mut heap).unwrap().as_str(),
    "1"
);

let json_object = json!({"one": 1});
let example_object = heap.object_from_json(&json_object);
assert_eq!(
    example_object.to_string(&mut heap).unwrap().as_str(),
    "{ one: 1 }"
);

let json_array = json!([1, 2]);
let example_array = heap.object_from_json(&json_array);
assert_eq!(
    example_array.to_string(&mut heap).unwrap().as_str(),
    "[1, 2]"
);

pub fn stringify(&self, heap: &mut Heap) -> JSResult<JSString>

stringify() makes everything into a string used for evaluation in a string context. It corresponds to .toString() in JavaScript

pub fn numberify(&self, heap: &Heap) -> Option<JSNumber>

numberify() tries to make everything into a numeric value for evalation in a numeric context. It is slightly more strict than +value in JavaScript: only value.numberify().unwrap_or(f64::NAN) corresponds to +value in JavaScript.

pub fn boolify(&self, heap: &Heap) -> bool

boolify() treats everythings as a truthy value. ES5: ToBoolean

pub fn objectify(&self, heap: &mut Heap) -> JSRef

objectify() wraps a primitive into its object:

• undefined becomes null
• bool/number/string becomes Boolean/Number/String
• objects just return their reference.

pub fn type_of(&self, heap: &Heap) -> &'static str

Javascript’s typeof

pub fn loose_eq(&self, other: &JSValue, heap: &Heap) -> bool

Abstract Equality Comparison, ==: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Equality_comparisons_and_sameness#Loose_equality_using_

pub fn strict_eq(&self, other: &JSValue, _heap: &Heap) -> bool

Strict Equality, === https://developer.mozilla.org/en-US/docs/Web/JavaScript/Equality_comparisons_and_sameness#strict_equality_using

pub fn numerically<F>(&self, other: &JSValue, heap: &Heap, op: F) -> JSValue where
    F: Fn(f64, f64) -> f64, 

pub fn plus(&self, other: &JSValue, heap: &mut Heap) -> JSResult<JSValue>

Addition operator: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Addition

pub fn minus(&self, other: &JSValue, heap: &Heap) -> JSResult<JSValue>

Subtraction operator: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Subtraction

pub fn compare<StrCmpFn: Fn(&str, &str) -> bool, NumCmpFn: Fn(f64, f64) -> bool>(
    &self,
    other: &JSValue,
    heap: &Heap,
    stringly: StrCmpFn,
    numberly: NumCmpFn
) -> JSValue

Trait Implementations

impl Clone for JSValue

fn clone(&self) -> JSValue

Returns a copy 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 From<JSRef> for JSValue

fn from(r: JSRef) -> Self

Converts to this type from the input type.

impl<S> From<S> for JSValue where
    JSString: From<S>, 

fn from(s: S) -> Self

Converts to this type from the input type.

impl From<bool> for JSValue

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f64> for JSValue

fn from(number: JSNumber) -> Self

Converts to this type from the input type.

impl From<i64> for JSValue

fn from(number: i64) -> Self

Converts to this type from the input type.

impl PartialEq<JSValue> for JSValue

fn eq(&self, other: &JSValue) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &JSValue) -> bool

This method tests for !=.

impl TryFrom<&Value> for JSValue

fn try_from(json: &JSON) -> Result<JSValue, Self::Error>

Constructs a pure value (without references), if possible. Excludes objects and arrays.

type Error = ()

The type returned in the event of a conversion error.

impl TryFrom<JSValue> for Literal

type Error = ()

The type returned in the event of a conversion error.

fn try_from(val: JSValue) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for JSValue