Struct JsObject

Source

pub struct JsObject<T: NativeObject + ?Sized = dyn NativeObject> { /* private fields */ }

Expand description

Garbage collected Object.

Implementations§

Source §

impl JsObject

Source

pub fn with_object_proto(intrinsics: &Intrinsics) -> Self

Creates a new ordinary object with its prototype set to the Object prototype.

This is equivalent to calling the specification’s abstract operation OrdinaryObjectCreate(%Object.prototype%).

Source

pub fn with_null_proto() -> Self

Creates a new ordinary object, with its prototype set to null.

This is equivalent to calling the specification’s abstract operation OrdinaryObjectCreate(null).

Source

pub fn from_proto_and_data<O: Into<Option<Self>>, T: NativeObject>( prototype: O, data: T, ) -> Self

Creates a new object with the provided prototype and object data.

This is equivalent to calling the specification’s abstract operation OrdinaryObjectCreate, with the difference that the additionalInternalSlotsList parameter is determined by the provided data.

Source

pub fn downcast<T: NativeObject>(self) -> Result<JsObject<T>, Self>

Downcasts the object’s inner data if the object is of type T.

§Panics

Panics if the object is currently mutably borrowed.

Source

pub unsafe fn downcast_unchecked<T: NativeObject>(self) -> JsObject<T>

Downcasts the object’s inner data to T without verifying the inner type of T.

§Safety

For this cast to be sound, self must contain an instance of T inside its inner data.

Source

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

Downcasts a reference to the object, if the object is of type T.

§Panics

Panics if the object is currently mutably borrowed.

Source

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

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

§Panics

Panics if the object is currently borrowed.

Source

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

Checks if this object is an instance of a certain NativeObject.

§Panics

Panics if the object is currently mutably borrowed.

Source

pub fn is_ordinary(&self) -> bool

Checks if it’s an ordinary object.

§Panics

Panics if the object is currently mutably borrowed.

Source

pub fn is_array(&self) -> bool

Checks if it’s an Array object.

Source

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

The abstract operation ToPropertyDescriptor.

More information:

ECMAScript reference

Source

pub fn copy_data_properties<K>( &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

Source §

impl<T: NativeObject + ?Sized> JsObject<T>

Source

pub fn new<O: Into<Option<JsObject>>>( root_shape: &RootShape, prototype: O, data: T, ) -> Self
where T: Sized,

Creates a new JsObject from its root shape, prototype, and data.

Note that the returned object will not be erased to be convertible to a JsValue. To erase the pointer, call JsObject::upcast.

Source

pub fn new_unique<O: Into<Option<JsObject>>>(prototype: O, data: T) -> Self
where T: Sized,

Creates a new JsObject from prototype, and data.

Note that the returned object will not be erased to be convertible to a JsValue. To erase the pointer, call JsObject::upcast.

Source

pub fn upcast(self) -> JsObject
where T: Sized,

Upcasts this object’s inner data from a specific type T to an erased type dyn NativeObject.

Source

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

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.

Source

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

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.

Source

pub fn try_borrow(&self) -> StdResult<Ref<'_, Object<T>>, 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.

Source

pub fn try_borrow_mut( &self, ) -> StdResult<RefMut<'_, Object<T>, Object<T>>, 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.

Source

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

Checks if the garbage collected memory is the same.

Source

pub fn prototype(&self) -> JsPrototype

Get the prototype of the object.

§Panics

Panics if the object is currently mutably borrowed.

Source

pub fn set_prototype(&self, prototype: JsPrototype) -> bool

Set the prototype of the object.

§Panics

Panics if the object is currently mutably borrowed

Source

pub fn insert_property<K, P>(&self, key: K, property: P) -> bool
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, than true is returned with that field, otherwise false is returned.

Source

pub fn is_callable(&self) -> bool

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

More information:

ECMAScript reference

Source

pub fn is_constructor(&self) -> bool

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

More information:

ECMAScript reference

Source §

impl JsObject

Source

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

Check if object is extensible.

More information:

ECMAScript reference

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

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

Source

pub fn own_property_keys( &self, context: &mut Context, ) -> JsResult<Vec<PropertyKey>>

Get all the keys of the properties of this object.

More information:

ECMAScript reference

Source

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

Call ( F, V [ , argumentsList ] )

§Panics

Panics if the object is currently mutably borrowed.

More information:

ECMAScript reference

Source

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

Construct ( F [ , argumentsList [ , newTarget ] ] )

Construct an instance of this object with the specified arguments.

§Panics

Panics if the object is currently mutably borrowed.

More information:

ECMAScript reference

Source

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

Make the object sealed or frozen.

More information:

ECMAScript reference

Source

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§

Source §

impl<T: NativeObject + ?Sized> AsRef<GcRefCell<Object<T>>> for JsObject<T>

Source §

fn as_ref(&self) -> &GcRefCell<Object<T>>

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

Source §

impl<T: NativeObject + ?Sized> Clone for JsObject<T>

Source §

fn clone(&self) -> Self

Returns a copy of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Source §

impl<T: NativeObject + ?Sized> Debug for JsObject<T>

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Default for JsObject

Source §

fn default() -> Self

Returns the “default value” for a type. Read more

Source §

impl<T: NativeObject + ?Sized> Finalize for JsObject<T>

Source §

fn finalize(&self)

Cleanup logic for a type.

Source §