Struct js_sys::Generator

#[repr(transparent)]
pub struct Generator { /* fields omitted */ }

Methods

impl Generator

pub fn next(&self, value: &JsValue) -> Result<JsValue, JsValue>

The next() method returns an object with two properties done and value. You can also provide a parameter to the next method to send a value to the generator.

MDN documentation

impl Generator

pub fn return_(&self, value: &JsValue) -> JsValue

The return() method returns the given value and finishes the generator.

MDN documentation

impl Generator

pub fn throw(&self, error: &Error) -> Result<JsValue, JsValue>

The throw() method resumes the execution of a generator by throwing an error into it and returns an object with two properties done and value.

MDN documentation

Methods from Deref<Target = Object>

pub fn has_own_property(&self, property: &JsValue) -> bool

The hasOwnProperty() method returns a boolean indicating whether the object has the specified property as its own property (as opposed to inheriting it).

MDN documentation

pub fn is_prototype_of(&self, value: &JsValue) -> bool

The isPrototypeOf() method checks if an object exists in another object's prototype chain.

MDN documentation

pub fn property_is_enumerable(&self, property: &JsValue) -> bool

The propertyIsEnumerable() method returns a Boolean indicating whether the specified property is enumerable.

MDN documentation

pub fn to_locale_string(&self) -> JsString

The toLocaleString() method returns a string representing the object. This method is meant to be overridden by derived objects for locale-specific purposes.

MDN documentation

pub fn to_string(&self) -> JsString

The toString() method returns a string representing the object.

MDN documentation

pub fn value_of(&self) -> Object

The valueOf() method returns the primitive value of the specified object.

MDN documentation

Trait Implementations

impl AsRef<JsValue> for Generator

fn as_ref(&self) -> &JsValue

Performs the conversion.

impl AsRef<Object> for Generator

fn as_ref(&self) -> &Object

Performs the conversion.

impl From<JsValue> for Generator

fn from(obj: JsValue) -> Generator

Performs the conversion.

impl From<Generator> for JsValue

fn from(obj: Generator) -> JsValue

Performs the conversion.

impl From<Generator> for Object

fn from(obj: Generator) -> Object

Performs the conversion.

impl Clone for Generator

fn clone(&self) -> Generator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Generator

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

Formats the value using the given formatter.

impl Deref for Generator

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl FromWasmAbi for Generator

type Abi = <JsValue as FromWasmAbi>::Abi

The wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for Generator

type Abi = <JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl<'a> IntoWasmAbi for &'a Generator

type Abi = <&'a JsValue as IntoWasmAbi>::Abi

The wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self, extra: &mut dyn Stack) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl WasmDescribe for Generator

fn describe()

impl OptionFromWasmAbi for Generator

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a "none" instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for Generator

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl<'a> OptionIntoWasmAbi for &'a Generator

fn none() -> Self::Abi

Returns an ABI instance indicating "none", which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for Generator

type Abi = <JsValue as RefFromWasmAbi>::Abi

The wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Generator>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don't persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi, extra: &mut dyn Stack) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl JsCast for Generator

fn instanceof(val: &JsValue) -> bool

Performs a dynamic instanceof check to see whether the JsValue provided is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Performs a zero-cost unchecked conversion from a JsValue into an instance of Self

fn unchecked_from_js_ref(val: &JsValue) -> &Self

Performs a zero-cost unchecked conversion from a &JsValue into an instance of &Self.

fn is_instance_of<T>(&self) -> bool where
    T: JsCast, 

Test whether this JS value is an instance of the type T.

fn dyn_into<T>(self) -> Result<T, Self> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn dyn_ref<T>(&self) -> Option<&T> where
    T: JsCast, 

Performs a dynamic cast (checked at runtime) of this value into the target type T.

fn unchecked_into<T>(self) -> T where
    T: JsCast, 

Performs a zero-cost unchecked cast into the specified type.

fn unchecked_ref<T>(&self) -> &T where
    T: JsCast, 

Performs a zero-cost unchecked cast into a reference to the specified type.