Struct JsGeneratorFunction 

pub struct JsGeneratorFunction { /* private fields */ }

JsGeneratorFunction provides a wrapper for Boa’s implementation of the ECMAScript GeneratorFunction builtin object.

Implementations

impl JsGeneratorFunction

pub fn from_object(object: JsObject) -> JsResult<Self>

Creates a JsGeneratorFunction from a generator function JsObject.

More information:

• MDN documentation

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

Calls the generator function and returns a new JsGenerator object.

More information:

• MDN documentation

Methods from Deref<Target = JsObject>

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.

Examples

#[derive(Debug, Trace, Finalize, JsData)]
struct CustomStruct;

let obj = JsObject::from_proto_and_data(None, OrdinaryObject);

// Downcast ref succeeds for the correct type.
assert!(obj.downcast_ref::<OrdinaryObject>().is_some());

// Returns `None` for a wrong type.
assert!(obj.downcast_ref::<CustomStruct>().is_none());

pub fn downcast_mut<T: NativeObject>(&self) -> Option<RefMut<'_, 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.

Examples

#[derive(Debug, Trace, Finalize, JsData)]
struct CustomStruct;

let obj = JsObject::from_proto_and_data(None, OrdinaryObject);

// Downcast mut succeeds for the correct type.
assert!(obj.downcast_mut::<OrdinaryObject>().is_some());

// Returns `None` for a wrong type.
assert!(obj.downcast_mut::<CustomStruct>().is_none());

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.

Examples

#[derive(Debug, Trace, Finalize, JsData)]
struct CustomStruct;

let obj = JsObject::from_proto_and_data(None, OrdinaryObject);

assert!(obj.is::<OrdinaryObject>());
assert!(!obj.is::<CustomStruct>());

pub fn is_ordinary(&self) -> bool

Checks if it’s an ordinary object.

Panics

Panics if the object is currently mutably borrowed.

Examples

let context = &mut Context::default();
let obj = JsObject::with_object_proto(context.intrinsics());

assert!(obj.is_ordinary());

pub fn is_array(&self) -> bool

Checks if it’s an Array object.

Examples

let context = &mut Context::default();

let array = JsArray::new(context)?;
// A JsArray's inner JsObject is an array.
assert!(JsObject::from(array).is_array());

// An ordinary object is not an array.
let obj = JsObject::with_object_proto(context.intrinsics());
assert!(!obj.is_array());

pub fn to_primitive( &self, context: &mut Context, preferred_type: PreferredType, ) -> JsResult<JsValue>

The abstract operation ToPrimitive takes an input argument and an optional argument PreferredType.

https://tc39.es/ecma262/#sec-toprimitive

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

The abstract operation ToPropertyDescriptor.

More information:

• ECMAScript reference

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.

Examples

let obj = JsObject::from_proto_and_data(None, OrdinaryObject);

// Multiple immutable borrows are allowed.
let borrowed = obj.borrow();
assert!(borrowed.prototype().is_none());

pub fn borrow_mut(&self) -> RefMut<'_, 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.

Examples

let context = &mut Context::default();
let obj = JsObject::from_proto_and_data(
    context.intrinsics().constructors().object().prototype(),
    OrdinaryObject,
);

// Set the prototype to `None` via a mutable borrow.
obj.borrow_mut().set_prototype(None);
assert!(obj.prototype().is_none());

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.

Examples

let obj = JsObject::from_proto_and_data(None, OrdinaryObject);

// Non-panicking immutable borrow.
let result = obj.try_borrow();
assert!(result.is_ok());

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

Examples

let obj = JsObject::from_proto_and_data(None, OrdinaryObject);

// Non-panicking mutable borrow.
let result = obj.try_borrow_mut();
assert!(result.is_ok());

pub fn prototype(&self) -> JsPrototype

Get the prototype of the object.

Panics

Panics if the object is currently mutably borrowed.

Examples

let context = &mut Context::default();

let obj = JsObject::with_object_proto(context.intrinsics());
assert!(obj.prototype().is_some());

let null_obj = JsObject::with_null_proto();
assert!(null_obj.prototype().is_none());

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

Set the prototype of the object.

Panics

Panics if the object is currently mutably borrowed

Examples

let context = &mut Context::default();
let obj = JsObject::with_object_proto(context.intrinsics());

assert!(obj.prototype().is_some());

// Set the prototype to `None`.
obj.set_prototype(None);
assert!(obj.prototype().is_none());

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.

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

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

More information:

• ECMAScript reference

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

Check 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 own_property_keys( &self, context: &mut Context, ) -> JsResult<Vec<PropertyKey>>

Get all the keys of the properties of this object.

More information:

• ECMAScript reference

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

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

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

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

where K: Into<PropertyKey>,

7.3.26 CopyDataProperties ( target, source, excludedItems )

More information:

• ECMAScript reference

Trait Implementations

impl Clone for JsGeneratorFunction

fn clone(&self) -> JsGeneratorFunction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsGeneratorFunction

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

Formats the value using the given formatter.

impl Deref for JsGeneratorFunction

type Target = JsObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Drop for JsGeneratorFunction

fn drop(&mut self)

Executes the destructor for this type.

impl Finalize for JsGeneratorFunction

fn finalize(&self)

Cleanup logic for a type.

impl From<JsGeneratorFunction> for JsObject

fn from(o: JsGeneratorFunction) -> Self

Converts to this type from the input type.

impl From<JsGeneratorFunction> for JsValue

fn from(o: JsGeneratorFunction) -> Self

Converts to this type from the input type.

impl Trace for JsGeneratorFunction

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

Marks all contained Gcs.

unsafe fn trace_non_roots(&self)

Trace handles located in GC heap, and mark them as non root.

fn run_finalizer(&self)

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

impl TryFromJs for JsGeneratorFunction

fn try_from_js(value: &JsValue, _context: &mut Context) -> JsResult<Self>

This function tries to convert a JavaScript value into Self.