naskya/napi-rs
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge pull request #109 from Mike-Dax/threadsafe-function-documentation

Browse source 
Fixed documentation of threadsafe functions
This commit is contained in:
LongYinan 2020-07-26 17:18:46 +08:00 committed by GitHub
commit 64510ec90f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
napi/src/threadsafe_function.rs
View file

@ -45,12 +45,14 @@ pub trait ToJs: Copy + Clone {
///
/// impl ToJs for HandleNumber {
/// type Output = u8;
/// type JsValue = JsNumber;
///
/// fn resolve(&self, env: &mut Env, output: Self::Output) -> Result<(u64, Self::JsValue)> {
/// let argv: u64 = 1;
/// let value = env.create_uint32(output as u32)?;
/// Ok((argv, value))
/// fn resolve(&self, env: &mut Env, output: Self::Output) -> Result<Vec<JsUnknown>> {
/// let value = env.create_uint32(output as u32)?.into_unknown()?;
/// // The first argument in the NodeJS callback will be either a null or an error
/// // depending on the result returned by this function.
/// // If this Result is Ok, the first argument will be null.
/// // If this Result is Err, the first argument will be the error.
/// Ok(vec![value])
/// }
/// }
///
@ -202,7 +204,9 @@ unsafe extern "C" fn call_js_cb<T: ToJs>(
let status;
// Follow the convention of Node.js async callback.
// Follow async callback conventions: https://nodejs.org/en/knowledge/errors/what-are-the-error-conventions/
// Check if the Result is okay, if so, pass a null as the first (error) argument automatically.
// If the Result is an error, pass that as the first argument.
if ret.is_ok() {
let values = ret.unwrap();
let js_null = env.get_null().unwrap();