#nodejs #node #api-bindings #add-on #native #js #write

node_api

使用Node-API在Rust中编写Node.js本地插件

6个版本 (破坏性更新)

0.5.0 2022年2月27日
0.4.1 2022年2月24日
0.3.1 2021年6月24日
0.2.0 2021年6月23日
0.1.0 2021年6月16日

#18 in #add-on

MIT许可证

89KB
3K SLoC

node_api

此crate提供对Node-API C API的绑定,使得在Rust中编写Node本地插件变得容易。

示例

在Rust中编写您的本地插件

node_api::init!(init);

fn init(env: node_api::Env, exports: node_api::Value) -> Result<node_api:Value, String> {
  let exports = export.as_object();
  let key = node_api::String::new(env, "add")?;
  let value = node_api::Function::new(env, "add", add)?;
  exports.set(key, value);
  Ok(exports.value())
}

#[node_api::function]
fn add(a: u64, b: u64) -> Result<u64, String> {
  Ok(a + b)
}

然后在Node.js中加载它。

let native = require("./add.node");
assert(native.add(3, 4) === 7);

查看示例文件夹以获取完整示例。

Serde集成

为了使在Rust和Node.js之间移动数据结构变得容易,node_api crate支持与serde的集成。

#[derive(serde::Serialize, serde::Deserialize)]
struct Contact {
  name: String,
  email: String,
}

#[node_api::function]
fn contact(env: node_api::Env) -> node_api::Result<Contact> {
  Ok(Contact {
    name: "John Doe".to_owned(),
    email: "[email protected]".to_owned(),
  })
}
let contact = native.contact();
console.log("Contact name: " + contact.name);
console.log("Contact email: " + contact.email);

依赖项

~2MB
~46K SLoC