deno_bindgen
This tool aims to simplify glue code generation for Deno FFI libraries written in Rust.
Annotate on top of Rust fn, struct and enum to make them available to Deno.
```rust // add.rs use denobindgen::denobindgen;
pub struct Input { a: i32, b: i32, }
fn add(input: Input) -> i32 { input.a + input.b } ```
Invoke the CLI to compile and generate bindings:
shell
$ deno_bindgen
And finally import the generated bindings in your JS
```typescript // add.ts import { add } from "./bindings/bindings.ts";
add({ a: 1, b: 2 }); // 3 ```
deno_bindgen CLI with Deno.shell
deno install -Afrq -n deno_bindgen https://deno.land/x/deno_bindgen/cli.ts
Add the following dependencies to your crate.
```toml
[dependencies] deno_bindgen = "0.8.0" serde = { version = "1", features = ["derive"] } ```
Change your crate-type to cdylib and set your package name as well.
toml
[lib]
name = "___"
crate-type = ["cdylib"]
Put #[deno_bindgen] on top of a "serde-deriavable" struct, enum or fn.
struct (named fields)These transform into Typescript types.
```rust // lib.rs
pub struct A {
b: Vec
becomes:
typescript
// bindings/bindings.ts
export type A = {
b: Array<Array<string>>;
};
enumEnums become type unions in Typescript.
```rust
pub enum Event { Quit, MouseMove { x: i32, y: i32, } } ```
becomes:
typescript
export type Enum =
| "quit"
| {
mouse_move: {
x: number;
y: number;
};
};
fnFunctions are exposed through the FFI boundaries.
```rust
fn greet(name: &str) { println!("Hello, {}!", name); } ```
becomes:
typescript
export function greet(name: string) {
// ... glue code for calling the
// symbol.
}
Notes
Use #[deno_bindgen(non_blocking)] attribute to call symbol without blocking
JS event loop. Exposed as an async funtion from bindings.
Rust doc comments transform to JS docs. ```rust
pub struct Me {
/// My name...
/// ...it is
name: String,
}
becomes:
typescript
export type Me = {
/**
If the argument type of Rust is f32, the calculation result may be different.\
Number in Java Script is float64, when data is passed to Rust, it becomes
float32, so the number may change.\
e.g: 1.3 + 1.5 will be 2.799999952316284
The deno_bindgen CLI tool provides the following flags:
Pass --release to create a release build.
--release=URL will load library artifacts from a remote location. This is
useful for updating bindings for end users after a release:
shell
deno_bindgen --release=https://github.com/littledivy/deno_sdl2/releases/download/0.2-alpha.1
Under the hood this uses x/plug to fetch and
cache the artifact.
Artifacts must be following the remote asset naming scheme, as follows:
| OS | Arch | Naming | | ------- | ------ | ------------------- | | Windows | x8664 | name.dll | | Linux | x8664 | libname.so | | MacOS | x8664 | libname.dylib | | MacOS | arm64 | libnamearm64.dylib |
Flags after -- will be passed to cargo build. Example:
shell
deno_bindgen -- --features "cool_stuff"