Facilitating high-level interactions between Wasm modules and JavaScript
Go to file
Alex Crichton cda71757d3 Tweak ArrayBuffer IDL type expansion slightly
A few small changes here:

* `ArrayBufferView` and `BufferSource` are expanded to themselves plus
  `Uint8ArrayMut` instead of `Object` to ensure we keep the original type.
* Generating an argument type for `ArrayBufferView`, `BufferSource`, and
  `Object` all now generate shared references instead of owned objects, which is
  a little more consistent with the other interface types.
2018-09-06 10:09:03 -07:00
.cargo Don't run the test runner in release mode 2018-08-04 08:22:47 -07:00
crates Tweak ArrayBuffer IDL type expansion slightly 2018-09-06 10:09:03 -07:00
examples Gate web-sys APIs on activated features (#790) 2018-09-05 12:55:30 -07:00
guide Gate web-sys APIs on activated features (#790) 2018-09-05 12:55:30 -07:00
releases Add a template for release announcements 2018-06-19 12:05:52 -07:00
src Add an accessor for wasm's own memory as a JS object 2018-08-27 11:05:55 -07:00
tests Add docs and remove typecheck from variadic attribute 2018-09-01 13:55:35 +01:00
.appveyor.yml Gate web-sys APIs on activated features (#790) 2018-09-05 12:55:30 -07:00
.eslintignore Applied eslint from main .eslintrc to examples (#418) 2018-07-08 01:02:10 -05:00
.eslintrc Create the web-sys crate mechanically from WebIDL (#409) 2018-07-09 16:35:25 -07:00
.gitattributes add .gitattributes to mark WebIDL as vendored 2018-07-11 18:48:51 -04:00
.gitignore Bump to 0.2.18 2018-08-27 13:37:55 -07:00
.travis.yml Gate web-sys APIs on activated features (#790) 2018-09-05 12:55:30 -07:00
build.rs Add links section to Cargo.toml 2018-08-30 13:04:27 -07:00
Cargo.toml Provide docs.rs metadata for generating docs 2018-09-05 12:57:36 -07:00
CHANGELOG.md Update CHANGELOG for 0.2.19 2018-08-27 13:49:34 -07:00
CONTRIBUTING.md Point to the guide's contributing section instead of CONTRIBUTING.md 2018-06-19 12:05:52 -07:00
LICENSE-APACHE Add license texts 2017-12-18 14:45:06 -08:00
LICENSE-MIT Add license texts 2017-12-18 14:45:06 -08:00
package.json Bump webpack-dev-server from 3.1.5 to 3.1.6 2018-08-27 08:13:19 +00:00
publish.rs Bump to 0.2.18 2018-08-27 13:37:55 -07:00
README.md README: Make the link to the guide bold 2018-09-05 15:00:08 -07:00

wasm-bindgen

Facilitating high-level interactions between wasm modules and JavaScript.

Build Status Build status API Documentation on docs.rs

Import JavaScript things into Rust and export Rust things to JavaScript.

extern crate wasm_bindgen;
use wasm_bindgen::prelude::*;

// Import the `window.alert` function from the Web.
#[wasm_bindgen]
extern {
    fn alert(s: &str);
}

// Export a `greet` function from Rust to JavaScript, that alerts a
// hello message.
#[wasm_bindgen]
pub fn greet(name: &str) {
    alert(&format!("Hello, {}!", name));
}

Use exported Rust things from JavaScript with ECMAScript modules!

import { greet } from "./hello_world";

greet("World!");

Features

  • Lightweight. Only pay for what you use. wasm-bindgen only generates bindings and glue for the JavaScript imports you actually use and Rust functionality that you export. For example, importing and using the document.querySelector method doesn't cause Node.prototype.appendChild or window.alert to be included in the bindings as well.

  • ECMAScript modules. Just import WebAssembly modules the same way you would import JavaScript modules. Future compatible with WebAssembly modules and ECMAScript modules integration.

  • Designed with the "host bindings" proposal in mind. Eventually, there won't be any JavaScript shims between Rust-generated wasm functions and native DOM methods. Because the wasm functions are statically type checked, some of those native methods' dynamic type checks should become unnecessary, promising to unlock even-faster-than-JavaScript DOM access.

Guide

📚 Read the wasm-bindgen guide here! 📚

License

This project is licensed under either of

at your option.

Contribution

See the "Contributing" section of the guide for information on hacking on wasm-bindgen!

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this project by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.