mirror of
https://github.com/denoland/deno.git
synced 2024-12-27 01:29:14 -05:00
d5634164cb
Closes https://github.com/denoland/deno/issues/2699 Closes https://github.com/denoland/deno/issues/2347 Uses unstable rustfmt features. Since dprint invokes `rustfmt` we do not need to switch the cargo toolchain to nightly. Do we care about formatting stability of our codebase across Rust versions? (I don't)
37 lines
1 KiB
Markdown
37 lines
1 KiB
Markdown
# napi_sym
|
|
|
|
A proc_macro for Deno's Node-API implementation. It does the following things:
|
|
|
|
- Marks the symbol as `#[no_mangle]` and rewrites it as `pub extern "C" $name`.
|
|
- Asserts that the function symbol is present in
|
|
[`symbol_exports.json`](./symbol_exports.json).
|
|
- Maps `deno_napi::Result` to raw `napi_result`.
|
|
|
|
```rust
|
|
use deno_napi::napi_value;
|
|
use deno_napi::Env;
|
|
use deno_napi::Error;
|
|
use deno_napi::Result;
|
|
|
|
#[napi_sym::napi_sym]
|
|
fn napi_get_boolean(
|
|
env: *mut Env,
|
|
value: bool,
|
|
result: *mut napi_value,
|
|
) -> Result {
|
|
let _env: &mut Env = env.as_mut().ok_or(Error::InvalidArg)?;
|
|
// *result = ...
|
|
Ok(())
|
|
}
|
|
```
|
|
|
|
### `symbol_exports.json`
|
|
|
|
A file containing the symbols that need to be put into the executable's dynamic
|
|
symbol table at link-time.
|
|
|
|
This is done using `/DEF:` on Windows, `-exported_symbol,_` on macOS and
|
|
`--export-dynamic-symbol=` on Linux. See [`cli/build.rs`](../build.rs).
|
|
|
|
On Windows, you need to generate the `.def` file by running
|
|
[`tools/napi/generate_symbols_lists.js`](../../tools/napi/generate_symbols_lists.js).
|