Struct boa::object::JsObject

pub struct JsObject(_);

Garbage collected Object.

Implementations

impl JsObject

pub fn new(object: Object) -> Self

Create a new GcObject from a Object.

pub fn borrow(&self) -> Ref<'_, Object>

Immutably borrows the Object.

The borrow lasts until the returned Ref exits scope. Multiple immutable borrows can be taken out at the same time.

Panics

Panics if the object is currently mutably borrowed.

pub fn borrow_mut(&self) -> RefMut<'_, Object, Object>

Mutably borrows the Object.

The borrow lasts until the returned RefMut exits scope. The object cannot be borrowed while this borrow is active.

Panics

Panics if the object is currently borrowed.

pub fn try_borrow(&self) -> StdResult<Ref<'_, Object>, BorrowError>

Immutably borrows the Object, returning an error if the value is currently mutably borrowed.

The borrow lasts until the returned GcCellRef exits scope. Multiple immutable borrows can be taken out at the same time.

This is the non-panicking variant of borrow.

pub fn try_borrow_mut(
    &self
) -> StdResult<RefMut<'_, Object, Object>, BorrowMutError>

Mutably borrows the object, returning an error if the value is currently borrowed.

The borrow lasts until the returned GcCellRefMut exits scope. The object be borrowed while this borrow is active.

This is the non-panicking variant of borrow_mut.

pub fn equals(lhs: &Self, rhs: &Self) -> bool

Checks if the garbage collected memory is the same.

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

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

Panics

Panics if the object is currently mutably borrowed.

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

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

Panics

Panics if the object is currently mutably borrowed.

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

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

Panics

Panics if the object is currently borrowed.

pub fn prototype_instance(&self) -> JsValue

Get the prototype of the object.

Panics

Panics if the object is currently mutably borrowed.

pub fn set_prototype_instance(&self, prototype: JsValue) -> bool

Set the prototype of the object.

Panics

Panics if the object is currently mutably borrowed or if th prototype is not an object or undefined.

pub fn is_array(&self) -> bool

Checks if it an Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_array_iterator(&self) -> bool

Checks if it is an ArrayIterator object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_map(&self) -> bool

Checks if it is a Map object.pub

Panics

Panics if the object is currently mutably borrowed.

pub fn is_string(&self) -> bool

Checks if it a String object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_function(&self) -> bool

Checks if it a Function object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_symbol(&self) -> bool

Checks if it a Symbol object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_error(&self) -> bool

Checks if it an Error object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_boolean(&self) -> bool

Checks if it a Boolean object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_number(&self) -> bool

Checks if it a Number object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_bigint(&self) -> bool

Checks if it a BigInt object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_regexp(&self) -> bool

Checks if it a RegExp object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_ordinary(&self) -> bool

Checks if it an ordinary object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_native_object(&self) -> bool

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

Panics

Panics if the object is currently mutably borrowed.

pub fn to_property_descriptor(
    &self,
    context: &mut Context
) -> JsResult<PropertyDescriptor>

pub fn copy_data_properties<K>(
    &mut self,
    source: &JsValue,
    excluded_keys: Vec<K>,
    context: &mut Context
) -> JsResult<()>where
    K: Into<PropertyKey>,

7.3.25 CopyDataProperties ( target, source, excludedItems )

More information:

• ECMAScript

pub fn insert_property<K, P>(
    &self,
    key: K,
    property: P
) -> Option<PropertyDescriptor>where
    K: Into<PropertyKey>,
    P: Into<PropertyDescriptor>,

Inserts a field in the object properties without checking if it’s writable.

If a field was already in the object with the same name that a Some is returned with that field, otherwise None is returned.

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

Returns true if the GcObject is the global for a Realm

impl JsObject

pub fn is_extensible(&self, context: &mut Context) -> JsResult<bool>

Cehck if object is extensible.

More information:

• ECMAScript reference

pub fn get<K>(&self, key: K, context: &mut Context) -> JsResult<JsValue>where
    K: Into<PropertyKey>,

Get property from object or throw.

More information:

• ECMAScript reference

pub fn set<K, V>(
    &self,
    key: K,
    value: V,
    throw: bool,
    context: &mut Context
) -> JsResult<bool>where
    K: Into<PropertyKey>,
    V: Into<JsValue>,

set property of object or throw if bool flag is passed.

More information:

• ECMAScript reference

pub fn create_data_property<K, V>(
    &self,
    key: K,
    value: V,
    context: &mut Context
) -> JsResult<bool>where
    K: Into<PropertyKey>,
    V: Into<JsValue>,

Create data property

More information:

• ECMAScript reference

pub fn create_data_property_or_throw<K, V>(
    &self,
    key: K,
    value: V,
    context: &mut Context
) -> JsResult<bool>where
    K: Into<PropertyKey>,
    V: Into<JsValue>,

Create data property or throw

More information:

• ECMAScript reference

pub fn define_property_or_throw<K, P>(
    &self,
    key: K,
    desc: P,
    context: &mut Context
) -> JsResult<bool>where
    K: Into<PropertyKey>,
    P: Into<PropertyDescriptor>,

Define property or throw.

More information:

• ECMAScript reference

pub fn delete_property_or_throw<K>(
    &self,
    key: K,
    context: &mut Context
) -> JsResult<bool>where
    K: Into<PropertyKey>,

Defines the property or throws a TypeError if the operation fails.

More information:

• EcmaScript reference

pub fn has_property<K>(&self, key: K, context: &mut Context) -> JsResult<bool>where
    K: Into<PropertyKey>,

Check if object has property.

More information:

• ECMAScript reference

pub fn has_own_property<K>(&self, key: K, context: &mut Context) -> JsResult<bool>where
    K: Into<PropertyKey>,

Check if object has an own property.

More information:

• ECMAScript reference

pub fn call(
    &self,
    this: &JsValue,
    args: &[JsValue],
    context: &mut Context
) -> JsResult<JsValue>

Call this object.

Panics

Panics if the object is currently mutably borrowed.

pub fn construct(
    &self,
    args: &[JsValue],
    new_target: &JsValue,
    context: &mut Context
) -> JsResult<JsValue>

Construct an instance of this object with the specified arguments.

Panics

Panics if the object is currently mutably borrowed.

pub fn set_integrity_level(
    &self,
    level: IntegrityLevel,
    context: &mut Context
) -> JsResult<bool>

Make the object sealed or frozen.

More information:

• ECMAScript reference

pub fn test_integrity_level(
    &self,
    level: IntegrityLevel,
    context: &mut Context
) -> JsResult<bool>

Check if the object is sealed or frozen.

More information:

• ECMAScript reference

Trait Implementations

impl AsRef<GcCell<Object>> for JsObject

fn as_ref(&self) -> &GcCell<Object>

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

impl Clone for JsObject

fn clone(&self) -> JsObject

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JsObject

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

Formats the value using the given formatter.

impl Default for JsObject

fn default() -> JsObject

Returns the “default value” for a type.

impl Drop for JsObject

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for JsObject

fn finalize(&self)

impl From<JsObject> for JsValue

fn from(object: JsObject) -> Self

Converts to this type from the input type.

impl Trace for JsObject

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