Struct PromiseWithResolvers 

pub struct PromiseWithResolvers<T = JsValue, E = JsValue> { /* private fields */ }

The object returned by Promise::with_resolvers, bundling a pending promise with the functions that settle it.

T is the fulfilled value type and E the rejection reason type, both defaulting to JsValue. Unlike Promise<T, E> it is invariant in both: resolve and reject take a T and an E, so widening either would let the promise settle with a value its type rules out.

MDN documentation

Implementations

impl<E, T> PromiseWithResolvers<T, E>

pub fn promise(&self) -> Promise<T, E>

where Promise<T, E>: ErasableGenericOwn<Promise>,

The pending promise.

impl<E, T> PromiseWithResolvers<T, E>

pub fn resolve(&self) -> Function<fn(T) -> Undefined>

where Function<fn(T) -> Undefined>: ErasableGenericOwn<Function<fn(JsValue) -> Undefined>>,

The function that fulfills the promise with a value.

impl<E, T> PromiseWithResolvers<T, E>

pub fn reject(&self) -> Function<fn(E) -> Undefined>

where Function<fn(E) -> Undefined>: ErasableGenericOwn<Function<fn(JsValue) -> Undefined>>,

The function that rejects the promise with a reason.

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 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_null_or_undefined(&self) -> bool

Tests whether this JS value is null or 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<T, E> AsRef<JsValue> for PromiseWithResolvers<T, E>

fn as_ref(&self) -> &JsValue

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

impl<T, E> AsRef<Object> for PromiseWithResolvers<T, E>

fn as_ref(&self) -> &Object

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

impl<T, E> AsRef<PromiseWithResolvers<T, E>> for PromiseWithResolvers<T, E>

fn as_ref(&self) -> &PromiseWithResolvers<T, E>

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

impl<T, E> Clone for PromiseWithResolvers<T, E>

where T: Clone, E: Clone,

fn clone(&self) -> PromiseWithResolvers<T, E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T, E> Debug for PromiseWithResolvers<T, E>

where T: Debug, E: Debug,

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

Formats the value using the given formatter.

impl<T, E> Deref for PromiseWithResolvers<T, E>

type Target = Object

The resulting type after dereferencing.

fn deref(&self) -> &Object

Dereferences the value.

impl<T, E> Eq for PromiseWithResolvers<T, E>

impl<T, E> ErasableGeneric for PromiseWithResolvers<T, E>

type Repr = JsValue

The singular concrete type that all generic variants can be transmuted on.

impl From<JsValue> for PromiseWithResolvers

fn from(obj: JsValue) -> PromiseWithResolvers

Converts to this type from the input type.

impl<T, E> From<PromiseWithResolvers<T, E>> for JsValue

fn from(obj: PromiseWithResolvers<T, E>) -> JsValue

Converts to this type from the input type.

impl<T, E> From<PromiseWithResolvers<T, E>> for Object

fn from(obj: PromiseWithResolvers<T, E>) -> Object

Converts to this type from the input type.

impl<T, E> FromWasmAbi for PromiseWithResolvers<T, E>

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: <PromiseWithResolvers<T, E> as FromWasmAbi>::Abi, ) -> PromiseWithResolvers<T, E>

Recover a Self from Self::Abi.

impl<T, E> IntoJsGeneric for PromiseWithResolvers<T, E>

where PromiseWithResolvers<T, E>: JsGeneric,

type JsCanon = PromiseWithResolvers<T, E>

The canonical JsGeneric form of this type.

fn to_js(self) -> PromiseWithResolvers<T, E>

Produce the canonical JsGeneric value for self.

impl<T, E> IntoWasmAbi for PromiseWithResolvers<T, E>

type Abi = <JsValue as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <PromiseWithResolvers<T, E> as IntoWasmAbi>::Abi

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

impl<'__wbg_ref, T, E> IntoWasmAbi for &'__wbg_ref PromiseWithResolvers<T, E>

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

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

fn into_abi( self, ) -> <&'__wbg_ref PromiseWithResolvers<T, E> as IntoWasmAbi>::Abi

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

impl<T, E> JsCast for PromiseWithResolvers<T, E>

fn instanceof(val: &JsValue) -> bool

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

fn unchecked_from_js(val: JsValue) -> PromiseWithResolvers<T, E>

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

fn unchecked_from_js_ref(val: &JsValue) -> &PromiseWithResolvers<T, E>

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.

fn is_type_of(val: &JsValue) -> bool

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

impl<T, E> LongRefFromWasmAbi for PromiseWithResolvers<T, E>

type Abi = <JsValue as LongRefFromWasmAbi>::Abi

Same as RefFromWasmAbi::Abi

type Anchor = PromiseWithResolvers<T, E>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <PromiseWithResolvers<T, E> as LongRefFromWasmAbi>::Abi, ) -> <PromiseWithResolvers<T, E> as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl<T, E> NullableFromWasmAbi for PromiseWithResolvers<T, E>

fn is_null( abi: &<PromiseWithResolvers<T, E> as MaybeFromWasmAbi>::MaybeAbi, ) -> bool

Tests the ABI value for Nullable::Null.

impl<T, E> NullableIntoWasmAbi for PromiseWithResolvers<T, E>

fn null() -> <PromiseWithResolvers<T, E> as MaybeIntoWasmAbi>::MaybeAbi

Returns the ABI value for Nullable::Null, which JS reads as null.

impl<'__wbg_ref, T, E> NullableIntoWasmAbi for &'__wbg_ref PromiseWithResolvers<T, E>

fn null() -> <&'__wbg_ref PromiseWithResolvers<T, E> as MaybeIntoWasmAbi>::MaybeAbi

Returns the ABI value for Nullable::Null, which JS reads as null.

impl<T, E> OptionFromWasmAbi for PromiseWithResolvers<T, E>

fn is_none(abi: &<PromiseWithResolvers<T, E> 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<T, E> OptionIntoWasmAbi for PromiseWithResolvers<T, E>

fn none() -> <PromiseWithResolvers<T, E> as IntoWasmAbi>::Abi

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

impl<'__wbg_ref, T, E> OptionIntoWasmAbi for &'__wbg_ref PromiseWithResolvers<T, E>

fn none() -> <&'__wbg_ref PromiseWithResolvers<T, E> as IntoWasmAbi>::Abi

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

impl<T, E> PartialEq for PromiseWithResolvers<T, E>

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

Equality operator ==.

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

Inequality operator !=.

impl<T, E> Promising for PromiseWithResolvers<T, E>

type Resolution = PromiseWithResolvers<T, E>

The type that this value resolves to.

impl<T, E> RefFromWasmAbi for PromiseWithResolvers<T, E>

type Abi = <JsValue as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = ManuallyDrop<PromiseWithResolvers<T, E>>

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: <PromiseWithResolvers<T, E> as RefFromWasmAbi>::Abi, ) -> <PromiseWithResolvers<T, E> as RefFromWasmAbi>::Anchor

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

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for PromiseWithResolvers<T, E>

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for JsOption<PromiseWithResolvers<T, E>>

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for JsNullable<PromiseWithResolvers<T, E>>

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for JsValue

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for JsOption

impl<T, E, Target> UpcastFrom<PromiseWithResolvers<T, E>> for Option<Target>

where Target: UpcastFrom<PromiseWithResolvers<T, E>>,

impl<T, E, Target> UpcastFrom<PromiseWithResolvers<T, E>> for Nullable<Target>

where Target: UpcastFrom<PromiseWithResolvers<T, E>>,

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for JsNullable

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for Object

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for JsOption<Object>

impl<T, E> UpcastFrom<PromiseWithResolvers<T, E>> for JsNullable<Object>

impl<T, E> VectorRefIntoWasmAbi for PromiseWithResolvers<T, E>

fn slice_into_abi(slice: &[PromiseWithResolvers<T, E>]) -> WasmSlice