Struct boa::builtins::value::Value

pub struct Value(_);

A Garbage-collected Javascript value as represented in the interpreter.

Implementations

impl Value

pub fn strict_equals(&self, other: &Self) -> bool

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(
    &mut self,
    other: &mut Self,
    interpreter: &mut Interpreter
) -> bool

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

pub fn undefined() -> Self

Creates a new undefined value.

pub fn null() -> Self

Creates a new null value.

pub fn string<S>(value: S) -> Self where
    S: Into<String>, 

Creates a new string value.

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

Creates a new number value.

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

Creates a new number value.

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

Creates a new number value.

pub fn bigint(value: BigInt) -> Self

Creates a new bigint value.

pub fn boolean(value: bool) -> Self

Creates a new boolean value.

pub fn object(object: Object) -> Self

Creates a new object value.

pub fn data(&self) -> &ValueData

Gets the underlying ValueData structure.

pub fn as_num_to_power(&self, other: Self) -> Self

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

pub fn new_object(global: Option<&Value>) -> Self

Returns a new empty object

pub fn new_object_from_prototype(proto: Value, kind: ObjectKind) -> Self

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

Methods from Deref<Target = ValueData>

pub fn is_extensible(&self) -> bool

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

Returns true if the value is an object

pub fn is_symbol(&self) -> bool

Returns true if the value is a symbol

pub fn is_function(&self) -> bool

Returns true if the value is a function

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_null_or_undefined(&self) -> bool

Returns true if the value is null or undefined

pub fn is_double(&self) -> bool

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

pub fn is_integer(&self) -> bool

Returns true if the value is integer.

pub fn is_number(&self) -> bool

Returns true if the value is a number

pub fn is_string(&self) -> bool

Returns true if the value is a string

pub fn is_boolean(&self) -> bool

Returns true if the value is a boolean

pub fn is_true(&self) -> bool

Returns true if the value is true

toBoolean

pub fn to_number(&self) -> f64

Converts the value into a 64-bit floating point number

pub fn to_integer(&self) -> i32

Converts the value into a 32-bit integer

pub fn to_bigint(&self) -> Option<BigInt>

Helper function.

pub fn as_object(&self) -> Option<GcCellRef<Object>>

pub fn remove_property(&self, field: &str) -> bool

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>

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>
)

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

Resolve the property in the object.

Returns a copy of the Property.

pub fn get_field(&self, field: Value) -> Value

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

pub fn has_internal_state(&self) -> bool

Check whether an object has an internal state set.

pub fn get_internal_state(&self) -> Option<InternalStateCell>

Get the internal state of an object.

pub fn with_internal_state_ref<S: Any + InternalState, R, F: FnOnce(&S) -> R>(
    &self,
    f: F
) -> R

Run a function with a reference to the internal state.

Panics

This will panic if this value doesn't have an internal state or if the internal state doesn't have the concrete type S.

pub fn with_internal_state_mut<S: Any + InternalState, R, F: FnOnce(&mut S) -> R>(
    &self,
    f: F
) -> R

Run a function with a mutable reference to the internal state.

Panics

This will panic if this value doesn't have an internal state or if the internal state doesn't have the concrete type S.

pub fn has_field(&self, field: &str) -> bool

Check to see if the Value has the field, mainly used by environment records

pub fn get_field_slice(&self, field: &str) -> Value

Resolve the property in the object and get its value, or undefined if this is not an object or the field doesn't exist

pub fn set_field(&self, field: Value, val: Value) -> Value

Set the field in the value Field could be a Symbol, so we need to accept a Value (not a string)

pub fn set_field_slice(&self, field: &str, val: Value) -> Value

Set the field in the value

pub fn set_internal_slot(&self, field: &str, val: Value) -> Value

Set the private field in the value

pub fn set_kind(&self, kind: ObjectKind)

Set the kind of an object

pub fn set_property(&self, field: String, prop: Property) -> Property

Set the property in the value

pub fn set_property_slice(&self, field: &str, prop: Property) -> Property

Set the property in the value

pub fn set_internal_state<T: Any + InternalState>(&self, state: T)

Set internal state of an Object. Discards the previous state if it was set.

pub fn to_json(&self) -> JSONValue

Conversts the Value to JSON.

pub fn get_type(&self) -> &'static str

Get the type of the value

https://tc39.es/ecma262/#sec-typeof-operator

Trait Implementations

impl Add<Value> for Value

type Output = Self

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self

Performs the + operation.

impl BitAnd<Value> for Value

type Output = Self

The resulting type after applying the & operator.

fn bitand(self, other: Self) -> Self

Performs the & operation.

impl BitOr<Value> for Value

type Output = Self

The resulting type after applying the | operator.

fn bitor(self, other: Self) -> Self

Performs the | operation.

impl BitXor<Value> for Value

type Output = Self

The resulting type after applying the ^ operator.

fn bitxor(self, other: Self) -> Self

Performs the ^ operation.

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the "default value" for a type.

impl Deref for Value

type Target = ValueData

The resulting type after dereferencing.

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

Dereferences the value.

impl Display for Value

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

Formats the value using the given formatter.

impl Div<Value> for Value

type Output = Self

The resulting type after applying the / operator.

fn div(self, other: Self) -> Self

Performs the / operation.

impl Drop for Value

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for Value

fn finalize(&self)

impl<'_, T> From<&'_ [T]> for Value where
    T: Clone + Into<Value>, 

fn from(value: &[T]) -> Self

Performs the conversion.

impl<'_> From<&'_ Property> for Value

fn from(value: &Property) -> Value

Performs the conversion.

impl<'_> From<&'_ Value> for Value

fn from(value: &Value) -> Self

Performs the conversion.

impl<'_> From<&'_ Value> for String

fn from(value: &Value) -> Self

Performs the conversion.

impl<'_> From<&'_ Value> for f64

fn from(value: &Value) -> Self

Performs the conversion.

impl<'_> From<&'_ Value> for i32

fn from(value: &Value) -> i32

Performs the conversion.

impl<'_> From<&'_ Value> for usize

fn from(value: &Value) -> usize

Performs the conversion.

impl<'_> From<&'_ Value> for bool

fn from(value: &Value) -> Self

Performs the conversion.

impl<'_> From<&'_ Value> for JSONValue

fn from(value: &Value) -> Self

Performs the conversion.

impl<'_> From<&'_ str> for Value

fn from(value: &str) -> Value

Performs the conversion.

impl<'a> From<&'a Value> for Property

fn from(value: &Value) -> Self

Attempt to fetch values "configurable", "enumerable", "writable" from the value, if they're not there default to false

impl From<()> for Value

fn from(_: ()) -> Self

Performs the conversion.

impl From<BigInt> for Value

fn from(value: BigInt) -> Self

Performs the conversion.

impl From<Object> for Value

fn from(object: Object) -> Self

Performs the conversion.

impl<T> From<Option<T>> for Value where
    T: Into<Value>, 

fn from(value: Option<T>) -> Self

Performs the conversion.

impl From<String> for Value

fn from(value: String) -> Self

Performs the conversion.

impl From<Value> for Value

fn from(value: JSONValue) -> Self

Performs the conversion.

impl<T> From<Vec<T>> for Value where
    T: Into<Value>, 

fn from(value: Vec<T>) -> Self

Performs the conversion.

impl From<bool> for Value

fn from(value: bool) -> Self

Performs the conversion.

impl From<char> for Value

fn from(value: char) -> Self

Performs the conversion.

impl From<f64> for Value

fn from(value: f64) -> Self

Performs the conversion.

impl From<i32> for Value

fn from(value: i32) -> Value

Performs the conversion.

impl From<usize> for Value

fn from(value: usize) -> Value

Performs the conversion.

impl Mul<Value> for Value

type Output = Self

The resulting type after applying the * operator.

fn mul(self, other: Self) -> Self

Performs the * operation.

impl Neg for Value

type Output = Self

The resulting type after applying the - operator.

fn neg(self) -> Self::Output

Performs the unary - operation.

impl Not for Value

type Output = Self

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl Rem<Value> for Value

type Output = Self

The resulting type after applying the % operator.

fn rem(self, other: Self) -> Self

Performs the % operation.

impl Shl<Value> for Value

type Output = Self

The resulting type after applying the << operator.

fn shl(self, other: Self) -> Self

Performs the << operation.

impl Shr<Value> for Value

type Output = Self

The resulting type after applying the >> operator.

fn shr(self, other: Self) -> Self

Performs the >> operation.

impl Sub<Value> for Value

type Output = Self

The resulting type after applying the - operator.

fn sub(self, other: Self) -> Self

Performs the - operation.

impl Trace for Value

unsafe fn trace(&self)

Marks all contained Gcs.

unsafe fn root(&self)

Increments the root-count of all contained Gcs.

unsafe fn unroot(&self)

Decrements the root-count of all contained Gcs.

fn finalize_glue(&self)

Runs Finalize::finalize() on this object and all contained subobjects

impl<'_> TryFrom<&'_ Value> for char

type Error = TryFromCharError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ Value> for BigInt

type Error = TryFromBigIntError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.

impl<'_> TryFrom<&'_ Value> for Object

type Error = TryFromObjectError

The type returned in the event of a conversion error.

fn try_from(value: &Value) -> Result<Self, Self::Error>

Performs the conversion.