Struct nodex_api::value::JsPromise

source · [−]

pub struct JsPromise<L, R>(_, _, _, _);

Implementations

impl<L: NapiValueT + Copy + Clone, R: NapiValueT + Copy + Clone> JsPromise<L, R>

pub fn env(&self) -> NapiEnv

pub fn raw(&self) -> napi_value

pub fn value(&self) -> JsValue

pub fn new(env: NapiEnv) -> NapiResult<JsPromise<L, R>>

This API creates a deferred object and a JavaScript promise.

pub fn spawn<T>(
    env: NapiEnv,
    work: impl FnMut(&mut T),
    complete: impl FnMut(Self, NapiStatus, T) -> NapiResult<()>
) -> NapiResult<JsPromise<L, R>> where
    T: Default,

Spawn a busy task in the libuv pool.

pub fn resolve(&self, resolution: L) -> NapiResult<()>

This API resolves a JavaScript promise by way of the deferred object with which it is associated. Thus, it can only be used to resolve JavaScript promises for which the corresponding deferred object is available. This effectively means that the promise must have been created using napi_create_promise() and the deferred object returned from that call must have been retained in order to be passed to this API.

The deferred object is freed upon successful completion.

pub fn reject(&self, rejection: R) -> NapiResult<()>

This API rejects a JavaScript promise by way of the deferred object with which it is associated. Thus, it can only be used to reject JavaScript promises for which the corresponding deferred object is available. This effectively means that the promise must have been created using napi_create_promise() and the deferred object returned from that call must have been retained in order to be passed to this API.

The deferred object is freed upon successful completion.

Trait Implementations

impl<L: Clone, R: Clone> Clone for JsPromise<L, R>

fn clone(&self) -> JsPromise<L, R>

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl<L: Debug, R: Debug> Debug for JsPromise<L, R>

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

Formats the value using the given formatter. Read more

impl<L: Copy, R: Copy> Copy for JsPromise<L, R>

Auto Trait Implementations

impl<L, R> RefUnwindSafe for JsPromise<L, R> where
L: RefUnwindSafe,
R: RefUnwindSafe,

impl<L, R> !Send for JsPromise<L, R>

impl<L, R> !Sync for JsPromise<L, R>

impl<L, R> Unpin for JsPromise<L, R> where
L: Unpin,
R: Unpin,

impl<L, R> UnwindSafe for JsPromise<L, R> where
L: UnwindSafe,
R: UnwindSafe,

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Performs the conversion.

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

pub fn into(self) -> U

Performs the conversion.

impl<T> ToOwned for T where
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.