Struct boa::object::Object

pub struct Object {
    pub data: ObjectData,
    // some fields omitted
}

The internal representation of an JavaScript object.

Fields

data: ObjectData

The type of the object.

Implementations

impl Object

pub fn has_property(&self, property_key: &PropertyKey) -> bool

Check if object has property.

More information:

• ECMAScript reference

pub fn is_extensible(&self) -> bool

Check if it is extensible.

More information:

• ECMAScript reference

pub fn prevent_extensions(&mut self) -> bool

Disable extensibility.

More information:

• ECMAScript reference

pub fn delete(&mut self, property_key: &PropertyKey) -> bool

Delete property.

pub fn get(&self, property_key: &PropertyKey) -> Value

[[Get]] https://tc39.es/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots-get-p-receiver

pub fn set(&mut self, property_key: PropertyKey, val: Value) -> bool

[[Set]] https://tc39.es/ecma262/#sec-ordinary-object-internal-methods-and-internal-slots-set-p-v-receiver

pub fn define_own_property<K>(&mut self, key: K, desc: Property) -> bool where
    K: Into<PropertyKey>, 

Define an own property.

More information:

• ECMAScript reference

pub fn get_own_property(&self, key: &PropertyKey) -> Property

The specification returns a Property Descriptor or Undefined.

These are 2 separate types and we can't do that here.

More information:

• ECMAScript reference

pub fn get_prototype_of(&self) -> Value

Returns either the prototype or null

More information:

• ECMAScript reference
• [MDN documentation][mdn]

impl Object

pub fn iter(&self) -> Iter<'_>

An iterator visiting all key-value pairs in arbitrary order. The iterator element type is (PropertyKey, &'a Property).

This iterator does not recurse down the prototype chain.

pub fn keys(&self) -> Keys<'_>

An iterator visiting all keys in arbitrary order. The iterator element type is PropertyKey.

This iterator does not recurse down the prototype chain.

pub fn values(&self) -> Values<'_>

An iterator visiting all values in arbitrary order. The iterator element type is &'a Property.

This iterator does not recurse down the prototype chain.

pub fn symbol_properties(&self) -> SymbolProperties<'_>

An iterator visiting all symbol key-value pairs in arbitrary order. The iterator element type is (&'a RcSymbol, &'a Property).

This iterator does not recurse down the prototype chain.

pub fn symbol_property_keys(&self) -> SymbolPropertyKeys<'_>

An iterator visiting all symbol keys in arbitrary order. The iterator element type is &'a RcSymbol.

This iterator does not recurse down the prototype chain.

pub fn symbol_property_values(&self) -> SymbolPropertyValues<'_>

An iterator visiting all symbol values in arbitrary order. The iterator element type is &'a Property.

This iterator does not recurse down the prototype chain.

pub fn index_properties(&self) -> IndexProperties<'_>

An iterator visiting all indexed key-value pairs in arbitrary order. The iterator element type is (&'a u32, &'a Property).

This iterator does not recurse down the prototype chain.

pub fn index_property_keys(&self) -> IndexPropertyKeys<'_>

An iterator visiting all index keys in arbitrary order. The iterator element type is &'a u32.

This iterator does not recurse down the prototype chain.

pub fn index_property_values(&self) -> IndexPropertyValues<'_>

An iterator visiting all index values in arbitrary order. The iterator element type is &'a Property.

This iterator does not recurse down the prototype chain.

pub fn string_properties(&self) -> StringProperties<'_>

An iterator visiting all string key-value pairs in arbitrary order. The iterator element type is (&'a RcString, &'a Property).

This iterator does not recurse down the prototype chain.

pub fn string_property_keys(&self) -> StringPropertyKeys<'_>

An iterator visiting all string keys in arbitrary order. The iterator element type is &'a RcString.

This iterator does not recurse down the prototype chain.

pub fn string_property_values(&self) -> StringPropertyValues<'_>

An iterator visiting all string values in arbitrary order. The iterator element type is &'a Property.

This iterator does not recurse down the prototype chain.

impl Object

pub fn new() -> Self

pub fn function(function: Function, prototype: Value) -> Self

Return a new ObjectData struct, with kind set to Ordinary

pub fn create(proto: Value) -> Self

ObjectCreate is used to specify the runtime creation of new ordinary objects.

More information:

• ECMAScript reference

pub fn boolean(value: bool) -> Self

Return a new Boolean object whose [[BooleanData]] internal slot is set to argument.

pub fn number(value: f64) -> Self

Return a new Number object whose [[NumberData]] internal slot is set to argument.

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

Return a new String object whose [[StringData]] internal slot is set to argument.

pub fn bigint(value: RcBigInt) -> Self

Return a new BigInt object whose [[BigIntData]] internal slot is set to argument.

pub fn native_object<T>(value: T) -> Self where
    T: NativeObject, 

Create a new native object of type T.

pub fn is_callable(&self) -> bool

It determines if Object is a callable function with a [[Call]] internal method.

More information:

• EcmaScript reference

pub fn is_constructable(&self) -> bool

It determines if Object is a function object with a [[Construct]] internal method.

More information:

• EcmaScript reference

pub fn is_array(&self) -> bool

Checks if it an Array object.

pub fn as_array(&self) -> Option<()>

pub fn is_map(&self) -> bool

Checks if it is a Map object.pub

pub fn as_map_ref(&self) -> Option<&OrderedMap<Value, Value>>

pub fn as_map_mut(&mut self) -> Option<&mut OrderedMap<Value, Value>>

pub fn is_string(&self) -> bool

Checks if it a String object.

pub fn as_string(&self) -> Option<RcString>

pub fn is_function(&self) -> bool

Checks if it a Function object.

pub fn as_function(&self) -> Option<&Function>

pub fn is_symbol(&self) -> bool

Checks if it a Symbol object.

pub fn as_symbol(&self) -> Option<RcSymbol>

pub fn is_error(&self) -> bool

Checks if it an Error object.

pub fn as_error(&self) -> Option<()>

pub fn is_boolean(&self) -> bool

Checks if it a Boolean object.

pub fn as_boolean(&self) -> Option<bool>

pub fn is_number(&self) -> bool

Checks if it a Number object.

pub fn as_number(&self) -> Option<f64>

pub fn is_bigint(&self) -> bool

Checks if it a BigInt object.

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

pub fn is_regexp(&self) -> bool

Checks if it a RegExp object.

pub fn as_regexp(&self) -> Option<&RegExp>

pub fn is_ordinary(&self) -> bool

Checks if it an ordinary object.

pub fn prototype_instance(&self) -> &Value

pub fn set_prototype_instance(&mut self, prototype: Value)

pub fn with_prototype(proto: Value, data: ObjectData) -> Object

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

pub fn is_native_object(&self) -> bool

Returns true if it holds an Rust type that implements NativeObject.

pub fn is<T>(&self) -> bool where
    T: NativeObject, 

Reeturn true if it is a native object and the native type is T.

pub fn downcast_ref<T>(&self) -> Option<&T> where
    T: NativeObject, 

Downcast a reference to the object, if the object is type native object type T.

pub fn downcast_mut<T>(&mut self) -> Option<&mut T> where
    T: NativeObject, 

Downcast a mutable reference to the object, if the object is type native object type T.

Trait Implementations

impl Debug for Object

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

Formats the value using the given formatter.

impl Default for Object

fn default() -> Self

Return a new ObjectData struct, with kind set to Ordinary

impl Drop for Object

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for Object

fn finalize(&self)

impl From<Object> for Value

fn from(object: Object) -> Self

Performs the conversion.

impl Trace for Object

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