Struct boa_engine::object::builtins::JsGenerator

impl JsGenerator

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

Creates a JsGenerator from a generator JsObject

pub fn next<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<JsValue>where T: Into<JsValue>,

Calls Generator.prototype.next()

This method returns an object with the properties done and value

pub fn return<T>( &self, value: T, context: &mut Context<'_> ) -> JsResult<JsValue>where T: Into<JsValue>,

Calls Generator.prototype.return()

This method returns the given value and finishes the generator

pub fn throw<T>(&self, value: T, context: &mut Context<'_>) -> JsResult<JsValue>where T: Into<JsValue>,

Calls Generator.prototype.throw()

This method resumes the execution of a generator by throwing an error and returning an an object with the properties done and value

Methods from Deref<Target = JsObject>§

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

Get the prototype of the object.

Panics

Panics if the object is currently mutably borrowed.

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

Set the prototype of the object.

Panics

Panics if the object is currently mutably borrowed

pub fn is_array(&self) -> bool

Checks if it’s an Array object.

pub fn is_data_view(&self) -> bool

Checks if it’s a DataView 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_array_buffer(&self) -> bool

Checks if it’s an ArrayBuffer object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_map(&self) -> bool

Checks if it is a Map object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_map_iterator(&self) -> bool

Checks if it’s a MapIterator object

Panics

Panics if the object is currently mutably borrowed.

pub fn is_set(&self) -> bool

Checks if it is a Set object

Panics

Panics if the object is currently mutably borrowed.

pub fn is_set_iterator(&self) -> bool

Checks if it is a SetIterator object

Panics

Panics if the object is currently mutably borrowed.

pub fn is_string(&self) -> bool

Checks if it’s a String object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_function(&self) -> bool

Checks if it’s a Function object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_generator(&self) -> bool

Checks if it’s a Generator object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_symbol(&self) -> bool

Checks if it’s a Symbol object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_error(&self) -> bool

Checks if it’s an Error object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_boolean(&self) -> bool

Checks if it’s a Boolean object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_number(&self) -> bool

Checks if it’s a Number object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_bigint(&self) -> bool

Checks if it’s a BigInt object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_date(&self) -> bool

Checks if it’s a Date object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_regexp(&self) -> bool

Checks if it’s a RegExp object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_array(&self) -> bool

Checks if it’s a TypedArray object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_uint8_array(&self) -> bool

Checks if it’s a Uint8Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_int8_array(&self) -> bool

Checks if it’s a Int8Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_uint16_array(&self) -> bool

Checks if it’s a Uint16Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_int16_array(&self) -> bool

Checks if it’s a Int16Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_uint32_array(&self) -> bool

Checks if it’s a Uint32Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_int32_array(&self) -> bool

Checks if it’s a Int32Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_float32_array(&self) -> bool

Checks if it’s a Float32Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_typed_float64_array(&self) -> bool

Checks if it’s a Float64Array object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_promise(&self) -> bool

Checks if it’s a Promise object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_ordinary(&self) -> bool

Checks if it’s an ordinary object.

Panics

Panics if the object is currently mutably borrowed.

pub fn is_proxy(&self) -> bool

Checks if it’s a proxy 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>

The abstract operation ToPropertyDescriptor.

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.25 CopyDataProperties ( target, source, excludedItems )

More information:

ECMAScript

pub fn insert_property<K, P>(&self, key: K, property: P) -> boolwhere 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_global(&self) -> bool

Returns true if the JsObject is the global for a Realm

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 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

Trait Implementations§

impl Clone for JsGenerator

fn clone(&self) -> JsGenerator

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

impl Debug for JsGenerator

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

Formats the value using the given formatter. Read more

impl Deref for JsGenerator

type Target = JsObject

The resulting type after dereferencing.

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

Dereferences the value.

impl Drop for JsGenerator

fn drop(&mut self)

Executes the destructor for this type. Read more

impl Finalize for JsGenerator

fn finalize(&self)

Cleanup logic for a type.

impl From<JsGenerator> for JsObject

fn from(o: JsGenerator) -> Self

Converts to this type from the input type.

impl From<JsGenerator> for JsValue

fn from(o: JsGenerator) -> Self

Converts to this type from the input type.

impl Trace for JsGenerator

unsafe fn trace(&self)

Marks all contained Gcs. Read more

unsafe fn root(&self)

Increments the root-count of all contained Gcs. Read more

unsafe fn unroot(&self)

Decrements the root-count of all contained Gcs. Read more

fn run_finalizer(&self)

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

impl TryFromJs for JsGenerator

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

This function tries to convert a JavaScript value into Self.

Auto Trait Implementations§

impl !UnwindSafe for JsGenerator

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<T> Conv for T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> NativeObject for Twhere T: Any + Trace,

fn as_any(&self) -> &(dyn Any + 'static)

Convert the Rust type which implements NativeObject to a &dyn Any.

fn as_mut_any(&mut self) -> &mut (dyn Any + 'static)

Convert the Rust type which implements NativeObject to a &mut dyn Any.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> Tap for T

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

Immutable access to a value. Read more

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

Mutable access to a value. Read more

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

Immutable access to the Borrow of a value. Read more

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

Mutable access to the BorrowMut of a value. Read more

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

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

fn vzip(self) -> V