Struct sauron::prelude::js_sys::AsyncIterator [−][src]
#[repr(transparent)]pub struct AsyncIterator { /* fields omitted */ }
Expand description
Any object that conforms to the JS async iterator protocol. For example,
something returned by myObject[Symbol.asyncIterator]()
.
Implementations
The next()
method always has to return a Promise which resolves to 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>
Invokes JSON.stringify
on this value and then parses the resulting
JSON into an arbitrary Rust value.
This function will first call JSON.stringify
on the JsValue
itself.
The resulting string is then passed into Rust which then parses it as
JSON into the resulting value.
Usage of this API requires activating the serde-serialize
feature of
the wasm-bindgen
crate.
Errors
Returns any error encountered when parsing the JSON into a T
.
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
.
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.
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
.
Tests whether this JS value is undefined
Tests whether the type of this JS value is function
.
Trait Implementations
Performs the conversion.
Performs the conversion.
Performs the conversion.
Performs a dynamic instanceof
check to see whether the JsValue
provided is an instance of this type. Read more
Performs a dynamic check to see whether the JsValue
provided
is a value of this type. Read more
Performs a zero-cost unchecked conversion from a JsValue
into an
instance of Self
Read more
Performs a zero-cost unchecked conversion from a &JsValue
into an
instance of &Self
. Read more
Test whether this JS value has a type T
. Read more
Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
Performs a zero-cost unchecked cast into the specified type. Read more
Performs a zero-cost unchecked cast into a reference to the specified type. Read more
Test whether this JS value is an instance of the type T
. Read more
Tests whether the argument is a “none” instance. If so it will be
deserialized as None
, and otherwise it will be passed to
FromWasmAbi
. Read more
Returns an ABI instance indicating “none”, which JS will interpret as
the None
branch of this option. Read more
Returns an ABI instance indicating “none”, which JS will interpret as
the None
branch of this option. Read more
type Abi = <JsValue as RefFromWasmAbi>::Abi
type Abi = <JsValue as RefFromWasmAbi>::Abi
The wasm ABI type references to Self
are recovered from.
type Anchor = ManuallyDrop<AsyncIterator>
type Anchor = ManuallyDrop<AsyncIterator>
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. Read more
pub unsafe fn ref_from_abi(
js: <AsyncIterator as RefFromWasmAbi>::Abi
) -> <AsyncIterator as RefFromWasmAbi>::Anchor
pub unsafe fn ref_from_abi(
js: <AsyncIterator as RefFromWasmAbi>::Abi
) -> <AsyncIterator as RefFromWasmAbi>::Anchor
Recover a Self::Anchor
from Self::Abi
. Read more
Auto Trait Implementations
impl RefUnwindSafe for AsyncIterator
impl !Send for AsyncIterator
impl !Sync for AsyncIterator
impl Unpin for AsyncIterator
impl UnwindSafe for AsyncIterator
Blanket Implementations
Mutably borrows from an owned value. Read more
type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
Same as IntoWasmAbi::Abi
Same as IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
. Read more