Struct rquickjs::Promise

pub struct Promise<'js>(/* private fields */);

A JavaScript promise.

Implementations

impl<'js> Promise<'js>

pub fn wrap_future<F, R>( ctx: &Ctx<'js>, future: F ) -> Result<Promise<'js>, Error>

where F: Future<Output = R> + 'js, R: IntoJs<'js>,

Available on crate feature futures only.

pub fn new( ctx: &Ctx<'js> ) -> Result<(Promise<'js>, Function<'js>, Function<'js>), Error>

Create a new JavaScript promise along with its resolve and reject functions.

pub fn state(&self) -> PromiseState

Returns the state of the promise, either pending,resolved or rejected.

pub fn then(&self) -> Result<Function<'js>, Error>

Returns the then function, used for chaining promises.

pub fn catch(&self) -> Result<Function<'js>, Error>

Returns the catch function, used for retrieving the result of a rejected promise.

pub fn result<T>(&self) -> Option<Result<T, Error>>

where T: FromJs<'js>,

Returns the result of the future if there is one.

Returns None if the promise has not yet been completed, Ok if the promise was resolved, and Error::Exception if the promise rejected with the rejected value as the thrown value retrievable via Ctx::catch.

pub fn finish<T>(&self) -> Result<T, Error>

where T: FromJs<'js>,

Runs the quickjs job queue until the promise is either rejected or resolved.

If blocking on the promise would result in blocking, i.e. when the job queue runs out of jobs before the promise can be resolved, this function returns Error::WouldBlock indicating that no more work can be done at the moment.

This function only drives the quickjs job queue, futures are not polled.

pub fn into_future<T>(self) -> PromiseFuture<'js, T>

where T: FromJs<'js>,

Available on crate feature futures only.

Wrap the promise into a struct which can be polled as a rust future.

impl<'js> Promise<'js>

pub fn as_value(&self) -> &Value<'js>

Reference to value

pub fn into_value(self) -> Value<'js>

Convert into value

pub fn into_inner(self) -> Object<'js>

Returns the underlying super type.

pub fn as_inner(&self) -> &Object<'js>

Returns a reference to the underlying super type.

pub fn ctx(&self) -> &Ctx<'js>

Returns the Ctx object associated with this value

pub fn from_value(value: Value<'js>) -> Result<Promise<'js>, Error>

Convert from value

Methods from Deref<Target = Object<'js>>

pub fn prop<K, V, P>(&self, key: K, prop: V) -> Result<(), Error>

where K: IntoAtom<'js>, V: AsProperty<'js, P>,

Available on crate feature properties only.

Define a property of an object

// Define readonly property without value
obj.prop("no_val", ()).unwrap();
// Define readonly property with value
obj.prop("ro_str", "Some const text").unwrap();
// Define readonly property with value and make it to be writable
obj.prop("ro_str2", Property::from("Some const text").writable()).unwrap();
// Define readonly property using getter and make it to be enumerable
obj.prop("ro_str_get", Accessor::from(|| "Some readable text").enumerable()).unwrap();
// Define readonly property using getter and setter
obj.prop("ro_str_get_set",
    Accessor::from(|| "Some text")
        .set(|new_val: String| { /* do something */ })
).unwrap();

pub fn get<K, V>(&self, k: K) -> Result<V, Error>

where K: IntoAtom<'js>, V: FromJs<'js>,

Get a new value

pub fn contains_key<K>(&self, k: K) -> Result<bool, Error>

where K: IntoAtom<'js>,

check whether the object contains a certain key.

pub fn set<K, V>(&self, key: K, value: V) -> Result<(), Error>

where K: IntoAtom<'js>, V: IntoJs<'js>,

Set a member of an object to a certain value

pub fn remove<K>(&self, key: K) -> Result<(), Error>

where K: IntoAtom<'js>,

Remove a member of an object

pub fn is_empty(&self) -> bool

Check the object for empty

pub fn len(&self) -> usize

Get the number of properties

pub fn keys<K>(&self) -> ObjectKeysIter<'js, K>

where K: FromAtom<'js>,

Get own string enumerable property names of an object

pub fn own_keys<K>(&self, filter: Filter) -> ObjectKeysIter<'js, K>

where K: FromAtom<'js>,

Get own property names of an object

pub fn props<K, V>(&self) -> ObjectIter<'js, K, V>

where K: FromAtom<'js>, V: FromJs<'js>,

Get own string enumerable properties of an object

pub fn own_props<K, V>(&self, filter: Filter) -> ObjectIter<'js, K, V>

where K: FromAtom<'js>, V: FromJs<'js>,

Get own properties of an object

pub fn values<K>(&self) -> ObjectValuesIter<'js, K>

where K: FromAtom<'js>,

Get own string enumerable property values of an object

pub fn own_values<K>(&self, filter: Filter) -> ObjectValuesIter<'js, K>

where K: FromAtom<'js>,

Get own property values of an object

pub fn get_prototype(&self) -> Option<Object<'js>>

Get an object prototype

Objects can have no prototype, in this case this function will return null.

pub fn set_prototype(&self, proto: Option<&Object<'js>>) -> Result<(), Error>

Set an object prototype

If called with None the function will set the prototype of the object to null.

This function will error if setting the prototype causes a cycle in the prototype chain.

pub fn is_instance_of(&self, class: impl AsRef<Value<'js>>) -> bool

Check instance of object

pub fn is_array_buffer(&self) -> bool

Returns whether the object is an instance of ArrayBuffer.

pub unsafe fn ref_array_buffer(&self) -> &ArrayBuffer<'_>

Interpret as ArrayBuffer

Safety

You should be sure that the object actually is the required type.

pub fn as_array_buffer(&self) -> Option<&ArrayBuffer<'_>>

Turn the object into an array buffer if the object is an instance of ArrayBuffer.

pub fn is_typed_array<T>(&self) -> bool

where T: TypedArrayItem,

pub unsafe fn ref_typed_array<'a, T>(&'a self) -> &'a TypedArray<'a, T>

where T: TypedArrayItem,

Interpret as TypedArray

Safety

You should be sure that the object actually is the required type.

pub fn as_typed_array<T>(&self) -> Option<&TypedArray<'_, T>>

where T: TypedArrayItem,

pub fn as_value(&self) -> &Value<'js>

Reference to value

pub fn as_inner(&self) -> &Value<'js>

Returns a reference to the underlying super type.

pub fn ctx(&self) -> &Ctx<'js>

Returns the Ctx object associated with this value

pub fn instance_of<C>(&self) -> bool

where C: JsClass<'js>,

Returns if the object is of a certain Rust class.

pub fn into_class<C>(&self) -> Result<Class<'js, C>, &Object<'js>>

where C: JsClass<'js>,

Turn the object into the class if it is an instance of that class.

pub fn as_class<C>(&self) -> Option<&Class<'js, C>>

where C: JsClass<'js>,

Turn the object into the class if it is an instance of that class.

Methods from Deref<Target = Value<'js>>

pub fn ctx(&self) -> &Ctx<'js>

Returns the Ctx object associated with this value.

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

Try get bool from value

pub fn as_int(&self) -> Option<i32>

Try get int from value

pub fn as_float(&self) -> Option<f64>

Try get float from value

pub fn as_number(&self) -> Option<f64>

Try get any number from value

pub fn is_null(&self) -> bool

Returns if the value is the JavaScript null value.

pub fn is_undefined(&self) -> bool

Returns if the value is the JavaScript undefined value.

pub fn is_bool(&self) -> bool

Check if the value is a bool

pub fn is_int(&self) -> bool

Check if the value is an int

pub fn is_float(&self) -> bool

Check if the value is a float

pub fn is_number(&self) -> bool

Check if the value is an any number

pub fn is_string(&self) -> bool

Check if the value is a string

pub fn is_symbol(&self) -> bool

Check if the value is a symbol

pub fn is_object(&self) -> bool

Check if the value is an object

pub fn is_module(&self) -> bool

Check if the value is a module

pub fn is_array(&self) -> bool

Check if the value is an array

pub fn is_function(&self) -> bool

Check if the value is a function

pub fn is_constructor(&self) -> bool

Check if the value is a constructor function

pub fn is_promise(&self) -> bool

Check if the value is a promise.

pub fn is_exception(&self) -> bool

Check if the value is an exception

pub fn is_error(&self) -> bool

Check if the value is an error

pub fn as_value(&self) -> &Value<'js>

Reference as value

pub fn get<T>(&self) -> Result<T, Error>

where T: FromJs<'js>,

Convert from value to specified type

pub fn as_raw(&self) -> JSValue

Returns the raw C library JavaScript value.

pub fn type_of(&self) -> Type

Get the type of value

pub fn type_name(&self) -> &'static str

Get the name of type

pub unsafe fn ref_string(&self) -> &String<'js>

Interpret as String

Safety

You should be sure that the value already is of required type before to do it.

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

Try reinterpret as String

pub unsafe fn ref_symbol(&self) -> &Symbol<'js>

Interpret as Symbol

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_symbol(&self) -> Option<&Symbol<'js>>

Try reinterpret as Symbol

pub unsafe fn ref_object(&self) -> &Object<'js>

Interpret as Object

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_object(&self) -> Option<&Object<'js>>

Try reinterpret as Object

pub unsafe fn ref_function(&self) -> &Function<'js>

Interpret as Function

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_function(&self) -> Option<&Function<'js>>

Try reinterpret as Function

pub unsafe fn ref_constructor(&self) -> &Constructor<'js>

Interpret as Constructor

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_constructor(&self) -> Option<&Constructor<'js>>

Try reinterpret as Constructor

pub unsafe fn ref_promise(&self) -> &Promise<'js>

Interpret as Promise

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_promise(&self) -> Option<&Promise<'js>>

Try reinterpret as Promise

pub unsafe fn ref_array(&self) -> &Array<'js>

Interpret as Array

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_array(&self) -> Option<&Array<'js>>

Try reinterpret as Array

pub unsafe fn ref_exception(&self) -> &Exception<'js>

Interpret as Exception

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_exception(&self) -> Option<&Exception<'js>>

Try reinterpret as Exception

pub unsafe fn ref_big_int(&self) -> &BigInt<'js>

Interpret as BigInt

Safety

You should be sure that the value already is of required type before to do it.

pub fn as_big_int(&self) -> Option<&BigInt<'js>>

Try reinterpret as BigInt

Trait Implementations

impl<'js> AsRef<Object<'js>> for Promise<'js>

fn as_ref(&self) -> &Object<'js>

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

impl<'js> AsRef<Value<'js>> for Promise<'js>

fn as_ref(&self) -> &Value<'js>

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

impl<'js> Clone for Promise<'js>

fn clone(&self) -> Promise<'js>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'js> Debug for Promise<'js>

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

Formats the value using the given formatter.

impl<'js> Deref for Promise<'js>

type Target = Object<'js>

The resulting type after dereferencing.

fn deref(&self) -> &<Promise<'js> as Deref>::Target

Dereferences the value.

impl<'js> From<Promise<'js>> for Value<'js>

fn from(value: Promise<'js>) -> Value<'js>

Converts to this type from the input type.

impl<'js> FromJs<'js> for Promise<'js>

fn from_js(_: &Ctx<'js>, value: Value<'js>) -> Result<Promise<'js>, Error>

impl<'js> Hash for Promise<'js>

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'js> IntoAtom<'js> for Promise<'js>

fn into_atom(self, ctx: &Ctx<'js>) -> Result<Atom<'js>, Error>

impl<'js> IntoJs<'js> for Promise<'js>

fn into_js(self, _ctx: &Ctx<'js>) -> Result<Value<'js>, Error>

impl<'js> Outlive<'js> for Promise<'js>

type Target<'to> = Promise<'to>

The target which has the same type as a Self but with another lifetime 't

impl<'js> PartialEq for Promise<'js>

fn eq(&self, other: &Promise<'js>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'js> Eq for Promise<'js>

impl<'js> StructuralPartialEq for Promise<'js>