Struct Generator 

#[repr(transparent)]
pub struct Generator<T = JsValue> {
    pub obj: Object,
    pub generics: PhantomData<fn() -> (T,)>,
}

Fields

obj: Object

generics: PhantomData<fn() -> (T,)>

Implementations

impl<T> Generator<T>

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

where T: ErasableGenericBorrow<JsValue> + EncodeTypeDef, for<'__wry_bindgen> &'__wry_bindgen T: BinaryEncode,

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<T: FromWasmAbi> Generator<T>

pub fn next_iterator(&self, value: &T) -> Result<IteratorNext<T>, JsValue>

where T: ErasableGenericBorrow<JsValue> + EncodeTypeDef, for<'__wry_bindgen> &'__wry_bindgen T: BinaryEncode, Result<IteratorNext<T>, JsValue>: ErasableGenericOwn<Result<IteratorNext<JsValue>, JsValue>> + EncodeTypeDef + BatchableResult,

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

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

where T: ErasableGenericBorrow<JsValue> + EncodeTypeDef, for<'__wry_bindgen> &'__wry_bindgen T: BinaryEncode,

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

MDN documentation

impl<T: FromWasmAbi> Generator<T>

pub fn try_return(&self, value: &T) -> Result<IteratorNext<T>, JsValue>

where T: ErasableGenericBorrow<JsValue> + EncodeTypeDef, for<'__wry_bindgen> &'__wry_bindgen T: BinaryEncode, Result<IteratorNext<T>, JsValue>: ErasableGenericOwn<Result<IteratorNext<JsValue>, JsValue>> + EncodeTypeDef + BatchableResult,

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

MDN documentation

impl<T> Generator<T>

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

impl<T: FromWasmAbi> Generator<T>

pub fn throw_value(&self, error: &JsValue) -> Result<IteratorNext<T>, JsValue>

where Result<IteratorNext<T>, JsValue>: ErasableGenericOwn<Result<IteratorNext<JsValue>, JsValue>> + EncodeTypeDef + BatchableResult,

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

The constructor property returns a reference to the Object constructor function that created the instance object.

MDN documentation

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

👎Deprecated:

Use Object::hasOwn instead.

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

Methods from Deref<Target = JsValue>

pub const NULL: JsValue

pub const UNDEFINED: JsValue

pub const TRUE: JsValue

pub const FALSE: JsValue

pub fn id(&self) -> u64

Get the heap ID for this value.

This is used internally for encoding values to send to JS.

pub fn unchecked_into_f64(&self) -> f64

Returns the value as f64 without type checking. Used by serde-wasm-bindgen for numeric conversions.

pub fn has_type<T>(&self) -> bool

where T: JsCast,

Check if this value is an instance of a specific JS type.

pub fn checked_div(&self, rhs: &JsValue) -> JsValue

Checked division.

pub fn pow(&self, rhs: &JsValue) -> JsValue

Power operation.

pub fn bit_and(&self, rhs: &JsValue) -> JsValue

Bitwise AND.

pub fn bit_or(&self, rhs: &JsValue) -> JsValue

Bitwise OR.

pub fn bit_xor(&self, rhs: &JsValue) -> JsValue

Bitwise XOR.

pub fn bit_not(&self) -> JsValue

Bitwise NOT.

pub fn shl(&self, rhs: &JsValue) -> JsValue

Left shift.

pub fn shr(&self, rhs: &JsValue) -> JsValue

Signed right shift.

pub fn unsigned_shr(&self, rhs: &JsValue) -> u32

Unsigned right shift.

pub fn add(&self, rhs: &JsValue) -> JsValue

Add.

pub fn sub(&self, rhs: &JsValue) -> JsValue

Subtract.

pub fn mul(&self, rhs: &JsValue) -> JsValue

Multiply.

pub fn div(&self, rhs: &JsValue) -> JsValue

Divide.

pub fn rem(&self, rhs: &JsValue) -> JsValue

Remainder.

pub fn neg(&self) -> JsValue

Negate.

pub fn lt(&self, other: &JsValue) -> bool

Less than comparison.

pub fn le(&self, other: &JsValue) -> bool

Less than or equal comparison.

pub fn gt(&self, other: &JsValue) -> bool

Greater than comparison.

pub fn ge(&self, other: &JsValue) -> bool

Greater than or equal comparison.

pub fn loose_eq(&self, other: &JsValue) -> bool

Loose equality (==).

pub fn is_falsy(&self) -> bool

Check if this value is a falsy value in JavaScript.

pub fn is_truthy(&self) -> bool

Check if this value is a truthy value in JavaScript.

pub fn is_object(&self) -> bool

Check if this value is an object.

pub fn is_function(&self) -> bool

Check if this value is a function.

pub fn is_string(&self) -> bool

Check if this value is a string.

pub fn is_symbol(&self) -> bool

Check if this value is a symbol.

pub fn is_bigint(&self) -> bool

Check if this value is a bigint.

pub fn is_array(&self) -> bool

Check if this value is an Array.

pub fn is_undefined(&self) -> bool

Check if this value is undefined.

pub fn is_null(&self) -> bool

Check if this value is null.

pub fn is_null_or_undefined(&self) -> bool

Check if this value is null or undefined.

pub fn js_typeof(&self) -> JsValue

Get the typeof this value as a string.

pub fn js_in(&self, obj: &JsValue) -> bool

Check if this value has a property with the given name.

pub fn as_bool(&self) -> Option<bool>

Get the value as a bool.

pub fn as_f64(&self) -> Option<f64>

Get the value as an f64.

pub fn as_string(&self) -> Option<String>

Get the value as a string.

pub fn as_debug_string(&self) -> String

Get a debug string representation of the value.

Trait Implementations

impl<T> AsRef<Generator<T>> for Generator<T>

fn as_ref(&self) -> &Generator<T>

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

impl<T> AsRef<JsValue> for Generator<T>

fn as_ref(&self) -> &JsValue

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

impl<T> AsRef<Object> for Generator<T>

fn as_ref(&self) -> &Object

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

impl<T> BatchableResult for Generator<T>

fn try_placeholder(batch: &mut Runtime) -> Option<Self>

Returns Some(placeholder) for opaque types that can be batched, None for types that require flushing to get the actual value.

impl<T> BinaryDecode for Generator<T>

fn decode(decoder: &mut DecodedData<'_>) -> Result<Self, DecodeError>

impl<T> BinaryEncode for Generator<T>

fn encode(self, encoder: &mut EncodedData)

impl<T: Clone> Clone for Generator<T>

fn clone(&self) -> Generator<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Generator<T>

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

Formats the value using the given formatter.

impl<T> Deref for Generator<T>

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl<T> EncodeTypeDef for Generator<T>

fn encode_type_def(buf: &mut Vec<u8>)

Encode this type’s definition into the buffer. For primitives, this is just the TypeTag byte. For callbacks, this includes param count, param types, and return type.

impl<T> ErasableGeneric for Generator<T>

type Repr = JsValue

impl<T> From<Generator<T>> for JsValue

fn from(val: Generator<T>) -> Self

Converts to this type from the input type.

impl<T> From<Generator<T>> for Object

fn from(val: Generator<T>) -> Object

Converts to this type from the input type.

impl<T> From<JsValue> for Generator<T>

fn from(val: JsValue) -> Self

Converts to this type from the input type.

impl<T: 'static> IntoJsGeneric for Generator<T>

where Generator<T>: JsGeneric,

type JsCanon = Generator<T>

fn to_js(self) -> Self::JsCanon

impl<T: FromWasmAbi> Iterable for Generator<T>

type Item = T

The type of values yielded by this iterable.

impl<T> JsCast for Generator<T>

fn instanceof(__val: &JsValue) -> bool

Check if a JsValue is an instance of this type.

fn unchecked_from_js(val: JsValue) -> Self

Unchecked cast from JsValue to this type.

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

Unchecked cast from a JsValue reference to a reference of this type.

fn is_type_of(val: &JsValue) -> bool

Performs a dynamic type check to see whether the JsValue provided is a value of this type.

fn has_type<T>(&self) -> bool

where T: JsCast,

Test whether this JS value has a type T.

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

where T: JsCast,

Try to cast this value to type T.

fn dyn_ref<T>(&self) -> Option<&T>

where T: JsCast,

Try to get a reference to type T from this value.

fn is_instance_of<T>(&self) -> bool

where T: JsCast,

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

fn unchecked_into<T>(self) -> T

where T: JsCast,

Unchecked cast to another type.

fn unchecked_ref<T>(&self) -> &T

where T: JsCast,

Unchecked cast to a reference of another type.

impl<T: PartialEq> PartialEq for Generator<T>

fn eq(&self, other: &Generator<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Promising for Generator<T>

type Resolution = Generator<T>

impl<T: Eq> Eq for Generator<T>

impl<T> StructuralPartialEq for Generator<T>

impl<T, __WryUpcastTarget0> UpcastFrom<Generator<T>> for Generator<__WryUpcastTarget0>

where __WryUpcastTarget0: UpcastFrom<T>,

impl<T> UpcastFrom<Generator<T>> for JsOption<JsValue>

impl<T, __WryUpcastTarget0> UpcastFrom<Generator<T>> for JsOption<Generator<__WryUpcastTarget0>>

where __WryUpcastTarget0: UpcastFrom<T>,

impl<T> UpcastFrom<Generator<T>> for JsOption<Object>

impl<T> UpcastFrom<Generator<T>> for JsValue

impl<T> UpcastFrom<Generator<T>> for Object