browserify / rustify

Rust WebAssembly transform for Browserify
Apache License 2.0
495 stars 25 forks source link

rustify

npm version build status downloads js-standard-style

Rust WebAssembly transform for Browserify. Because this is an unstable rust feature, at the time of writing it relies on wasm-gc to be available from the command line. See Installation for instructions on how to install. Probably also doesn't work on Windows.

Because this feature is experimental in Rust, this module should be considered similarly.

Usage

$ browserify -t rustify index.js > bundle.js
// index.js
var rust = require('rustify')

var wasm = rust`
  #[no_mangle]
  pub fn add_one(x: i32) -> i32 {
    x + 1
  }
`

WebAssembly.instantiate(wasm, {})
  .then(function (res) {
    var addOne = res.instance.exports.add_one
    console.log(addOne(41))
    console.log(addOne(68))
  }).catch(function (e) {
    console.error('Creating WASM module failed', e)
  })

External

var rust = require('rustify')

var wasm = rust('./add-one.rs')

WebAssembly.instantiate(wasm, {})
  .then(function (res) {
    var addOne = res.instance.exports.add_one
    console.log(addOne(41))
    console.log(addOne(68))
  }).catch(function (e) {
    console.error('Creating WASM module failed', e)
  })

API

uint8Array = rust(filename)

Create a valid .rs file to a Uint8Array, ready to be passed to the WASM constructor.

uint8Array = rust#string

Create an inline rust template string to a Uint8Array, ready to be passed to the WASM constructor.

Installation

With rustup installed:

$ rustup update nightly
$ rustup target add wasm32-unknown-unknown --toolchain nightly
$ cargo install --git https://github.com/alexcrichton/wasm-gc
$ npm install rustify

License

Apache-2.0