napi 3.8.5

N-API bindings
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101

use std::{
  cell::Cell,
  convert::identity,
  future,
  pin::Pin,
  rc::Rc,
  task::{Context, Poll},
};

use futures::channel::oneshot::{channel, Receiver};

use crate::{sys, Error, Result, Status};

use super::{CallbackContext, FromNapiValue, PromiseRaw, TypeName, Unknown, ValidateNapiValue};

/// The JavaScript Promise object representation
///
/// This `Promise<T>` can be awaited in the Rust
/// This `Promise<T>` can also be passed from `#[napi]` fn
///
/// example:
///
/// ```no_run
/// #[napi]
/// pub fn await_promise_in_rust(promise: Promise<u32>) {
///   let value = promise.await.unwrap();
///
///   println!("{value}");
/// }
/// ```
///
/// But this `Promise<T>` can not be pass back to `JavaScript`.
/// If you want to use raw JavaScript `Promise` API, you can use the [`PromiseRaw`](./PromiseRaw) instead.
pub struct Promise<T: 'static + FromNapiValue> {
  value: Pin<Box<Receiver<Result<T>>>>,
}

impl<T: FromNapiValue> TypeName for Promise<T> {
  fn type_name() -> &'static str {
    "Promise"
  }

  fn value_type() -> crate::ValueType {
    crate::ValueType::Object
  }
}

impl<T: FromNapiValue> ValidateNapiValue for Promise<T> {
  unsafe fn validate(
    env: crate::sys::napi_env,
    napi_val: crate::sys::napi_value,
  ) -> Result<sys::napi_value> {
    use super::validate_promise;

    validate_promise(env, napi_val)
  }
}

unsafe impl<T: FromNapiValue + Send> Send for Promise<T> {}

impl<T: FromNapiValue> FromNapiValue for Promise<T> {
  unsafe fn from_napi_value(env: sys::napi_env, napi_val: sys::napi_value) -> crate::Result<Self> {
    let (tx, rx) = channel();
    let promise_object = unsafe { PromiseRaw::<T>::from_napi_value(env, napi_val)? };
    let tx_box = Rc::new(Cell::new(Some(tx)));
    let tx_in_catch = tx_box.clone();
    promise_object
      .then(move |ctx| {
        if let Some(sender) = tx_box.replace(None) {
          // no need to handle the send error here, the receiver has been dropped
          let _ = sender.send(Ok(ctx.value));
        }
        Ok(())
      })?
      .catch(move |ctx: CallbackContext<Unknown>| {
        if let Some(sender) = tx_in_catch.replace(None) {
          // no need to handle the send error here, the receiver has been dropped
          let _ = sender.send(Err(ctx.value.into()));
        }
        Ok(())
      })?;

    Ok(Promise {
      value: Box::pin(rx),
    })
  }
}

impl<T: FromNapiValue> future::Future for Promise<T> {
  type Output = Result<T>;

  fn poll(mut self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output> {
    match self.value.as_mut().poll(cx) {
      Poll::Pending => Poll::Pending,
      Poll::Ready(v) => Poll::Ready(
        v.map_err(|e| Error::new(Status::GenericFailure, format!("{e}")))
          .and_then(identity),
      ),
    }
  }
}