[−][src]Enum boa::builtins::value::Value

pub enum Value {
    Null,
    Undefined,
    Boolean(bool),
    String(RcString),
    Rational(f64),
    Integer(i32),
    BigInt(RcBigInt),
    Object(GcObject),
    Symbol(RcSymbol),
}

A Javascript value

Variants

Null

null - A null value, for when a value doesn't exist.

Undefined

undefined - An undefined value, for when a field or index doesn't exist.

Boolean(bool)

boolean - A true / false value, for if a certain criteria is met.

String(RcString)

String - A UTF-8 string, such as "Hello, world".

Rational(f64)

Number - A 64-bit floating point number, such as 3.1415

Integer(i32)

Number - A 32-bit integer, such as 42.

BigInt(RcBigInt)

BigInt - holds any arbitrary large signed integer.

Object(GcObject)

Object - An object, such as Math, represented by a binary tree of string keys to Javascript values.

Symbol(RcSymbol)

Symbol - A Symbol Primitive type.

Implementations

`impl Value`[src]

`pub fn get_type(&self) -> Type`[src]

Get the type of the value.

This is similar to typeof as described at https://tc39.es/ecma262/#sec-typeof-operator but instead of returning a string it returns a Type enum which implements fmt::Display to allow getting the string if required using to_string().

`impl Value`[src]

`pub fn strict_equals(&self, other: &Self) -> bool`[src]

Strict equality comparison.

This method is executed when doing strict equality comparisons with the === operator. For more information, check https://tc39.es/ecma262/#sec-strict-equality-comparison.

`pub fn equals( &self, other: &Self, interpreter: &mut Interpreter ) -> Result<bool, Value>`[src]

Abstract equality comparison.

This method is executed when doing abstract equality comparisons with the == operator. For more information, check https://tc39.es/ecma262/#sec-abstract-equality-comparison

`impl Value`[src]

`pub fn undefined() -> Self`[src]

Creates a new undefined value.

`pub fn null() -> Self`[src]

Creates a new null value.

`pub fn nan() -> Self`[src]

Creates a new number with NaN value.

`pub fn string<S>(value: S) -> Self where S: Into<RcString>,` [src]

Creates a new string value.

`pub fn rational<N>(value: N) -> Self where N: Into<f64>,` [src]

Creates a new number value.

`pub fn integer(value: I) -> Self where I: Into<i32>,` [src]

Creates a new number value.

`pub fn number<N>(value: N) -> Self where N: Into<f64>,` [src]

Creates a new number value.

`pub fn bigint(value: B) -> Self where B: Into<RcBigInt>,` [src]

Creates a new bigint value.

`pub fn boolean(value: bool) -> Self`[src]

Creates a new boolean value.

`pub fn object(object: Object) -> Self`[src]

Creates a new object value.

`pub fn as_num_to_power(&self, other: Self) -> Self`[src]

Helper function to convert the Value to a number and compute its power.

`pub fn new_object(global: Option<&Value>) -> Self`[src]

Returns a new empty object

`pub fn new_object_from_prototype(proto: Value, data: ObjectData) -> Self`[src]

Similar to new_object, but you can pass a prototype to create from, plus a kind

`pub fn from_json(json: JSONValue, interpreter: &mut Interpreter) -> Self`[src]

Convert from a JSON value to a JS value

`pub fn to_json(&self, interpreter: &mut Interpreter) -> Result<JSONValue, Value>`[src]

Conversts the Value to JSON.

`pub fn is_extensible(&self) -> bool`[src]

This will tell us if we can exten an object or not, not properly implemented yet

For now always returns true.

For scalar types it should be false, for objects check the private field for extensibilaty. By default true.

<https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/seal would turn extensible to false/> <https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/freeze would also turn extensible to false/>

`pub fn is_object(&self) -> bool`[src]

Returns true if the value is an object

`pub fn as_object(&self) -> Option<GcCellRef<Object>>`[src]

`pub fn as_object_mut(&self) -> Option<GcCellRefMut<Object>>`[src]

`pub fn is_symbol(&self) -> bool`[src]

Returns true if the value is a symbol.

`pub fn is_function(&self) -> bool`[src]

Returns true if the value is a function

`pub fn is_undefined(&self) -> bool`[src]

Returns true if the value is undefined.

`pub fn is_null(&self) -> bool`[src]

Returns true if the value is null.

`pub fn is_null_or_undefined(&self) -> bool`[src]

Returns true if the value is null or undefined.

`pub fn is_double(&self) -> bool`[src]

Returns true if the value is a 64-bit floating-point number.

`pub fn is_integer(&self) -> bool`[src]

Returns true if the value is integer.

`pub fn is_number(&self) -> bool`[src]

Returns true if the value is a number.

`pub fn is_string(&self) -> bool`[src]

Returns true if the value is a string.

`pub fn is_boolean(&self) -> bool`[src]

Returns true if the value is a boolean.

`pub fn is_bigint(&self) -> bool`[src]

Returns true if the value is a bigint.

`pub fn as_bigint(&self) -> Option<&BigInt>`[src]

Returns an optional reference to a BigInt if the value is a BigInt primitive.

`pub fn is_true(&self) -> bool`[src]

Returns true if the value is true.

toBoolean

`pub fn to_number(&self) -> f64`[src]

Converts the value into a 64-bit floating point number

`pub fn to_integer(&self) -> i32`[src]

Converts the value into a 32-bit integer

`pub fn to_boolean(&self) -> bool`[src]

Creates a new boolean value from the input

`pub fn remove_property(&self, field: &str) -> bool`[src]

Removes a property from a Value object.

It will return a boolean based on if the value was removed, if there was no value to remove false is returned.

`pub fn get_property(&self, field: &str) -> Option<Property>`[src]

Resolve the property in the object.

A copy of the Property is returned.

`pub fn update_property( &self, field: &str, value: Option<Value>, enumerable: Option<bool>, writable: Option<bool>, configurable: Option<bool> )`[src]

update_prop will overwrite individual Property fields, unlike Set_prop, which will overwrite prop with a new Property Mostly used internally for now

`pub fn get_internal_slot(&self, field: &str) -> Value`[src]

Resolve the property in the object.

Returns a copy of the Property.

`pub fn get_field<F>(&self, field: F) -> Self where F: Into<Value>,` [src]

Resolve the property in the object and get its value, or undefined if this is not an object or the field doesn't exist get_field recieves a Property from get_prop(). It should then return the [[Get]] result value if that's set, otherwise fall back to [Value] TODO: this function should use the get Value if its set