Struct Iterator 

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

Any object that conforms to the JS iterator protocol. For example, something returned by myArray[Symbol.iterator]().

MDN documentation

Fields

obj: JsValue

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

Implementations

impl<T: FromWasmAbi> Iterator<T>

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

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

The next() method always has to return an object with appropriate properties including done and value. If a non-object value gets returned (such as false or undefined), a TypeError (“iterator.next() returned a non-object value”) will be thrown.

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<Iterator<T>> for Iterator<T>

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

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

impl<T> AsRef<JsValue> for Iterator<T>

fn as_ref(&self) -> &JsValue

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

impl<T> BatchableResult for Iterator<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 Iterator<T>

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

impl<T> BinaryEncode for Iterator<T>

fn encode(self, encoder: &mut EncodedData)

impl<T: Clone> Clone for Iterator<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Iterator<T>

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

Formats the value using the given formatter.

impl<T> Deref for Iterator<T>

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl<T> EncodeTypeDef for Iterator<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 Iterator<T>

type Repr = JsValue

impl<T> From<Iterator<T>> for JsValue

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

Converts to this type from the input type.

impl<T> From<JsValue> for Iterator<T>

fn from(val: JsValue) -> Self

Converts to this type from the input type.

impl<'a, T: FromWasmAbi + JsGeneric> IntoIterator for &'a Iterator<T>

type Item = Result<T, JsValue>

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Iter<'a, T>

Creates an iterator from a value.

impl<T: FromWasmAbi + JsGeneric> IntoIterator for Iterator<T>

type Item = Result<T, JsValue>

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter<T>

Creates an iterator from a value.

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

where Iterator<T>: JsGeneric,

type JsCanon = Iterator<T>

fn to_js(self) -> Self::JsCanon

impl<T> Iterable for Iterator<T>

type Item = T

The type of values yielded by this iterable.

impl<T> JsCast for Iterator<T>

fn instanceof(__val: &JsValue) -> bool

Check if a JsValue is an instance 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 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 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> Promising for Iterator<T>

type Resolution = Iterator<T>

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

where __WryUpcastTarget0: UpcastFrom<T>,

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

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

where __WryUpcastTarget0: UpcastFrom<T>,

impl<T> UpcastFrom<Iterator<T>> for JsValue

impl<T> UpcastFrom<Iterator<T>> for Object