Struct boa_engine::object::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:

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:

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

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:

source

pub fn is_constructor(&self) -> bool

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

More information:

source§

impl JsObject

source

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

Check if object is extensible.

More information:

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:

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:

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:

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:

source

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

Define property or throw.

More information:

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:

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:

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:

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:

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:

source

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

Make the object sealed or frozen.

More information:

source

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

Check if the object is sealed or frozen.

More information:

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§

impl<T: NativeObject + ?Sized> From<Gc<VTableObject<T>>> for JsObject<T>

source§

fn from(inner: Gc<VTableObject<T>>) -> Self

Converts to this type from the input type.
source§

impl From<JsArray> for JsObject

source§

fn from(o: JsArray) -> Self

Converts to this type from the input type.
source§

impl From<JsArrayBuffer> for JsObject

source§

fn from(o: JsArrayBuffer) -> Self

Converts to this type from the input type.
source§

impl From<JsArrayBuffer> for JsObject<ArrayBuffer>

source§

fn from(value: JsArrayBuffer) -> Self

Converts to this type from the input type.
source§

impl From<JsDataView> for JsObject

source§

fn from(o: JsDataView) -> Self

Converts to this type from the input type.
source§

impl From<JsDataView> for JsObject<DataView>

source§

fn from(value: JsDataView) -> Self

Converts to this type from the input type.
source§

impl From<JsDate> for JsObject

source§

fn from(o: JsDate) -> Self

Converts to this type from the input type.
source§

impl From<JsFloat32Array> for JsObject

source§

fn from(o: JsFloat32Array) -> Self

Converts to this type from the input type.
source§

impl From<JsFloat64Array> for JsObject

source§

fn from(o: JsFloat64Array) -> Self

Converts to this type from the input type.
source§

impl From<JsFunction> for JsObject

source§

fn from(o: JsFunction) -> Self

Converts to this type from the input type.
source§

impl From<JsGenerator> for JsObject

source§

fn from(o: JsGenerator) -> Self

Converts to this type from the input type.
source§

impl From<JsInt16Array> for JsObject

source§

fn from(o: JsInt16Array) -> Self

Converts to this type from the input type.
source§

impl From<JsInt32Array> for JsObject

source§

fn from(o: JsInt32Array) -> Self

Converts to this type from the input type.
source§

impl From<JsInt8Array> for JsObject

source§

fn from(o: JsInt8Array) -> Self

Converts to this type from the input type.
source§

impl From<JsMap> for JsObject

source§

fn from(o: JsMap) -> Self

Converts to this type from the input type.
source§

impl From<JsMapIterator> for JsObject

source§

fn from(o: JsMapIterator) -> Self

Converts to this type from the input type.
source§

impl From<JsObject<ArrayBuffer>> for JsArrayBuffer

source§

fn from(value: JsObject<ArrayBuffer>) -> Self

Converts to this type from the input type.
source§

impl From<JsObject<DataView>> for JsDataView

source§

fn from(value: JsObject<DataView>) -> Self

Converts to this type from the input type.
source§

impl From<JsObject<SharedArrayBuffer>> for JsSharedArrayBuffer

source§

fn from(value: JsObject<SharedArrayBuffer>) -> Self

Converts to this type from the input type.
source§

impl From<JsObject> for JsValue

source§

fn from(object: JsObject) -> Self

Converts to this type from the input type.
source§

impl From<JsPromise> for JsObject

source§

fn from(o: JsPromise) -> Self

Converts to this type from the input type.
source§

impl From<JsProxy> for JsObject

source§

fn from(o: JsProxy) -> Self

Converts to this type from the input type.
source§

impl From<JsRegExp> for JsObject

source§

fn from(o: JsRegExp) -> Self

Converts to this type from the input type.
source§

impl From<JsSet> for JsObject

source§

fn from(o: JsSet) -> Self

Converts to this type from the input type.
source§

impl From<JsSetIterator> for JsObject

source§

fn from(o: JsSetIterator) -> Self

Converts to this type from the input type.
source§

impl From<JsSharedArrayBuffer> for JsObject

source§

fn from(o: JsSharedArrayBuffer) -> Self

Converts to this type from the input type.
source§

impl From<JsSharedArrayBuffer> for JsObject<SharedArrayBuffer>

source§

fn from(value: JsSharedArrayBuffer) -> Self

Converts to this type from the input type.
source§

impl From<JsTypedArray> for JsObject

source§

fn from(o: JsTypedArray) -> Self

Converts to this type from the input type.
source§

impl From<JsUint16Array> for JsObject

source§

fn from(o: JsUint16Array) -> Self

Converts to this type from the input type.
source§

impl From<JsUint32Array> for JsObject

source§

fn from(o: JsUint32Array) -> Self

Converts to this type from the input type.
source§

impl From<JsUint8Array> for JsObject

source§

fn from(o: JsUint8Array) -> Self

Converts to this type from the input type.
source§

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

source§

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher. Read more
1.3.0 · source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl<T: NativeObject + ?Sized> Trace for JsObject<T>
where Gc<VTableObject<T>>: Trace,

source§

unsafe fn trace(&self, tracer: &mut Tracer)

Marks all contained Gcs. Read more
source§

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root. Read more
source§

fn run_finalizer(&self)

Runs Finalize::finalize on this object and all contained subobjects.
source§

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

Auto Trait Implementations§

§

impl<T = dyn NativeObject> !RefUnwindSafe for JsObject<T>

§

impl<T = dyn NativeObject> !Send for JsObject<T>

§

impl<T = dyn NativeObject> !Sync for JsObject<T>

§

impl<T: ?Sized> Unpin for JsObject<T>

§

impl<T = dyn NativeObject> !UnwindSafe for JsObject<T>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> Conv for T

source§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
source§

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

source§

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Pipe for T
where T: ?Sized,

source§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
source§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
source§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
source§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
source§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
source§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
source§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
source§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
source§

impl<T> Tap for T

source§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
source§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
source§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
source§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
source§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
source§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
source§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
source§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
source§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
source§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
source§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
source§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
source§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
source§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
source§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> TryConv for T

source§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> ErasedDestructor for T
where T: 'static,

source§

impl<T> MaybeSendSync for T