Struct Iterator

pub struct Iterator { /* private fields */ }

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

MDN documentation

Implementations

impl Iterator

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

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 as_f64(&self) -> Option<f64>

Returns the f64 value of this JS value if it’s an instance of a number.

If this JS value is not an instance of a number then this returns None.

pub fn is_string(&self) -> bool

Tests whether this JS value is a JS string.

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

If this JS value is a string value, this function copies the JS string value into Wasm linear memory, encoded as UTF-8, and returns it as a Rust String.

To avoid the copying and re-encoding, consider the JsString::try_from() function from js-sys instead.

If this JS value is not an instance of a string or if it’s not valid utf-8 then this returns None.

UTF-16 vs UTF-8

JavaScript strings in general are encoded as UTF-16, but Rust strings are encoded as UTF-8. This can cause the Rust string to look a bit different than the JS string sometimes. For more details see the documentation about the str type which contains a few caveats about the encodings.

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

Returns the bool value of this JS value if it’s an instance of a boolean.

If this JS value is not an instance of a boolean then this returns None.

pub fn is_null(&self) -> bool

Tests whether this JS value is null

pub fn is_undefined(&self) -> bool

Tests whether this JS value is undefined

pub fn is_symbol(&self) -> bool

Tests whether the type of this JS value is symbol

pub fn is_object(&self) -> bool

Tests whether typeof self == "object" && self !== null.

pub fn is_array(&self) -> bool

Tests whether this JS value is an instance of Array.

pub fn is_function(&self) -> bool

Tests whether the type of this JS value is function.

pub fn is_bigint(&self) -> bool

Tests whether the type of this JS value is bigint.

pub fn js_typeof(&self) -> JsValue

Applies the unary typeof JS operator on a JsValue.

MDN documentation

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

Applies the binary in JS operator on the two JsValues.

MDN documentation

pub fn is_truthy(&self) -> bool

Tests whether the value is “truthy”.

pub fn is_falsy(&self) -> bool

Tests whether the value is “falsy”.

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

Compare two JsValues for equality, using the == operator in JS.

MDN documentation

pub fn bit_not(&self) -> JsValue

Applies the unary ~ JS operator on a JsValue.

MDN documentation

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

Applies the binary >>> JS operator on the two JsValues.

MDN documentation

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

Applies the binary / JS operator on two JsValues, catching and returning any RangeError thrown.

MDN documentation

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

Applies the binary ** JS operator on the two JsValues.

MDN documentation

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

Applies the binary < JS operator on the two JsValues.

MDN documentation

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

Applies the binary <= JS operator on the two JsValues.

MDN documentation

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

Applies the binary >= JS operator on the two JsValues.

MDN documentation

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

Applies the binary > JS operator on the two JsValues.

MDN documentation

pub fn unchecked_into_f64(&self) -> f64

Applies the unary + JS operator on a JsValue. Can throw.

MDN documentation

Trait Implementations

impl AsRef<Iterator> for Iterator

fn as_ref(&self) -> &Iterator

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

impl AsRef<JsValue> for Iterator

fn as_ref(&self) -> &JsValue

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

impl Clone for Iterator

fn clone(&self) -> Iterator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Iterator

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

Formats the value using the given formatter.

impl Deref for Iterator

type Target = JsValue

The resulting type after dereferencing.

fn deref(&self) -> &JsValue

Dereferences the value.

impl From<Iterator> for JsValue

fn from(obj: Iterator) -> JsValue

Converts to this type from the input type.

impl From<JsValue> for Iterator

fn from(obj: JsValue) -> Iterator

Converts to this type from the input type.

impl FromWasmAbi for Iterator

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: <Iterator as FromWasmAbi>::Abi) -> Iterator

Recover a Self from Self::Abi.

impl<'a> IntoIterator for &'a Iterator

type Item = Result<JsValue, JsValue>

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

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

Creates an iterator from a value.

impl IntoIterator for Iterator

type Item = Result<JsValue, JsValue>

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> IntoIter

Creates an iterator from a value.

impl<'a> IntoWasmAbi for &'a Iterator

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

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

fn into_abi(self) -> <&'a Iterator as IntoWasmAbi>::Abi

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

impl IntoWasmAbi for Iterator

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <Iterator as IntoWasmAbi>::Abi

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

impl JsCast for Iterator

fn instanceof(val: &JsValue) -> bool

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

fn is_type_of(val: &JsValue) -> bool

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

fn unchecked_from_js(val: JsValue) -> Iterator

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

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

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

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,

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.

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

where T: JsCast,

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

impl LongRefFromWasmAbi for Iterator

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = Iterator

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <Iterator as LongRefFromWasmAbi>::Abi, ) -> <Iterator as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for Iterator

fn is_none(abi: &<Iterator as FromWasmAbi>::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<'a> OptionIntoWasmAbi for &'a Iterator

fn none() -> <&'a Iterator as IntoWasmAbi>::Abi

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

impl OptionIntoWasmAbi for Iterator

fn none() -> <Iterator as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for Iterator

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<Iterator>

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: <Iterator as RefFromWasmAbi>::Abi, ) -> <Iterator as RefFromWasmAbi>::Anchor

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