Struct js_sys::AsyncIterator [−][src]
#[repr(transparent)]pub struct AsyncIterator { /* fields omitted */ }
Any object that conforms to the JS async iterator protocol. For example,
something returned by myObject[Symbol.asyncIterator]()
.
Implementations
impl AsyncIterator
[src]
impl AsyncIterator
[src]pub fn next(&self) -> Result<Promise, JsValue>
[src]
pub fn next(&self) -> Result<Promise, JsValue>
[src]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>
pub const NULL: JsValue
[src]
pub const UNDEFINED: JsValue
[src]
pub const TRUE: JsValue
[src]
pub const FALSE: JsValue
[src]
pub fn as_f64(&self) -> Option<f64>
[src]
pub fn as_f64(&self) -> Option<f64>
[src]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 as_string(&self) -> Option<String>
[src]
pub fn as_string(&self) -> Option<String>
[src]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>
[src]
pub fn as_bool(&self) -> Option<bool>
[src]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_undefined(&self) -> bool
[src]
pub fn is_undefined(&self) -> bool
[src]Tests whether this JS value is undefined
pub fn is_function(&self) -> bool
[src]
pub fn is_function(&self) -> bool
[src]Tests whether the type of this JS value is function
.
Trait Implementations
impl AsRef<AsyncIterator> for AsyncIterator
[src]
impl AsRef<AsyncIterator> for AsyncIterator
[src]fn as_ref(&self) -> &AsyncIterator
[src]
fn as_ref(&self) -> &AsyncIterator
[src]Performs the conversion.
impl Clone for AsyncIterator
[src]
impl Clone for AsyncIterator
[src]fn clone(&self) -> AsyncIterator
[src]
fn clone(&self) -> AsyncIterator
[src]Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
1.0.0[src]Performs copy-assignment from source
. Read more
impl Debug for AsyncIterator
[src]
impl Debug for AsyncIterator
[src]impl Deref for AsyncIterator
[src]
impl Deref for AsyncIterator
[src]impl From<AsyncIterator> for JsValue
[src]
impl From<AsyncIterator> for JsValue
[src]fn from(obj: AsyncIterator) -> JsValue
[src]
fn from(obj: AsyncIterator) -> JsValue
[src]Performs the conversion.
impl From<JsValue> for AsyncIterator
[src]
impl From<JsValue> for AsyncIterator
[src]fn from(obj: JsValue) -> AsyncIterator
[src]
fn from(obj: JsValue) -> AsyncIterator
[src]Performs the conversion.
impl FromWasmAbi for AsyncIterator
[src]
impl FromWasmAbi for AsyncIterator
[src]impl IntoWasmAbi for AsyncIterator
[src]
impl IntoWasmAbi for AsyncIterator
[src]impl<'a> IntoWasmAbi for &'a AsyncIterator
[src]
impl<'a> IntoWasmAbi for &'a AsyncIterator
[src]impl JsCast for AsyncIterator
[src]
impl JsCast for AsyncIterator
[src]fn instanceof(val: &JsValue) -> bool
[src]
fn instanceof(val: &JsValue) -> bool
[src]Performs a dynamic instanceof
check to see whether the JsValue
provided is an instance of this type. Read more
fn is_type_of(val: &JsValue) -> bool
[src]
fn is_type_of(val: &JsValue) -> bool
[src]Performs a dynamic check to see whether the JsValue
provided
is a value of this type. Read more
fn unchecked_from_js(val: JsValue) -> Self
[src]
fn unchecked_from_js(val: JsValue) -> Self
[src]Performs a zero-cost unchecked conversion from a JsValue
into an
instance of Self
Read more
fn unchecked_from_js_ref(val: &JsValue) -> &Self
[src]
fn unchecked_from_js_ref(val: &JsValue) -> &Self
[src]Performs a zero-cost unchecked conversion from a &JsValue
into an
instance of &Self
. Read more
fn has_type<T>(&self) -> bool where
T: JsCast,
[src]
fn has_type<T>(&self) -> bool where
T: JsCast,
[src]Test whether this JS value has a type T
. Read more
fn dyn_into<T>(self) -> Result<T, Self> where
T: JsCast,
[src]
fn dyn_into<T>(self) -> Result<T, Self> where
T: JsCast,
[src]Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
fn dyn_ref<T>(&self) -> Option<&T> where
T: JsCast,
[src]
fn dyn_ref<T>(&self) -> Option<&T> where
T: JsCast,
[src]Performs a dynamic cast (checked at runtime) of this value into the
target type T
. Read more
fn unchecked_into<T>(self) -> T where
T: JsCast,
[src]
fn unchecked_into<T>(self) -> T where
T: JsCast,
[src]Performs a zero-cost unchecked cast into the specified type. Read more
fn unchecked_ref<T>(&self) -> &T where
T: JsCast,
[src]
fn unchecked_ref<T>(&self) -> &T where
T: JsCast,
[src]Performs a zero-cost unchecked cast into a reference to the specified type. Read more
fn is_instance_of<T>(&self) -> bool where
T: JsCast,
[src]
fn is_instance_of<T>(&self) -> bool where
T: JsCast,
[src]Test whether this JS value is an instance of the type T
. Read more
impl OptionFromWasmAbi for AsyncIterator
[src]
impl OptionFromWasmAbi for AsyncIterator
[src]impl OptionIntoWasmAbi for AsyncIterator
[src]
impl OptionIntoWasmAbi for AsyncIterator
[src]impl<'a> OptionIntoWasmAbi for &'a AsyncIterator
[src]
impl<'a> OptionIntoWasmAbi for &'a AsyncIterator
[src]impl RefFromWasmAbi for AsyncIterator
[src]
impl RefFromWasmAbi for AsyncIterator
[src]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
unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor
[src]
unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor
[src]Recover a Self::Anchor
from Self::Abi
. Read more
impl WasmDescribe for AsyncIterator
[src]
impl WasmDescribe for AsyncIterator
[src]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
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]pub fn borrow_mut(&mut self) -> &mut T
[src]
pub fn borrow_mut(&mut self) -> &mut T
[src]Mutably borrows from an owned value. Read more
impl<T> ReturnWasmAbi for T where
T: IntoWasmAbi,
[src]
impl<T> ReturnWasmAbi for T where
T: IntoWasmAbi,
[src]type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
Same as IntoWasmAbi::Abi
pub fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
[src]
pub fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
[src]Same as IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
. Read more
impl<T> ToOwned for T where
T: Clone,
[src]
impl<T> ToOwned for T where
T: Clone,
[src]type Owned = T
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn to_owned(&self) -> T
[src]Creates owned data from borrowed data, usually by cloning. Read more
pub fn clone_into(&self, target: &mut T)
[src]
pub fn clone_into(&self, target: &mut T)
[src]🔬 This is a nightly-only experimental API. (toowned_clone_into
)
recently added
Uses borrowed data to replace owned data, usually by cloning. Read more