Facilitating high-level interactions between Wasm modules and JavaScript
Go to file
Nick Fitzgerald 222d5ca00d ci: build docs on stable
This avoids https://github.com/rust-lang/rust/issues/57628 and also generally
makes sense since wasm-bindgen buils on stable.
2019-01-17 14:56:52 -08:00
.cargo Start running CI tests on Rust beta 2018-09-25 10:36:28 -07:00
crates Merge pull request #1190 from sagan-software/issue-1186 2019-01-16 16:38:59 -08:00
examples Bump to 0.2.32 2019-01-16 13:11:13 -08:00
guide Remove separators that cause numbering jumps 2019-01-01 17:38:45 +01:00
releases Add a template for release announcements 2018-06-19 12:05:52 -07:00
src Fix tiny comment formatting issue in docs 2018-12-30 10:14:07 +01:00
tests Fix an issue where closure rewriting required class internals 2019-01-14 15:53:29 -08:00
.appveyor.yml Merge pull request #989 from alexcrichton/stable-ci 2018-10-28 14:14:49 -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 ci: build docs on stable 2019-01-17 14:56:52 -08:00
build.rs Implement AsRef<JsValue> for Closure<T> 2018-09-06 14:46:59 -07:00
Cargo.toml Bump to 0.2.32 2019-01-16 13:11:13 -08:00
CHANGELOG.md Add 0.2.32 entry to CHANGELOG.md 2019-01-16 13:06:17 -08:00
CONTRIBUTING.md Fix contributing URL 2018-09-20 17:37:04 -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 Try to fix CI examples build 2018-12-03 10:38:55 -08:00
publish.rs Don't use path dependencies in examples 2018-11-07 11:27:43 -08:00
README.md Consistently use extern "C" 2018-11-27 12:27:00 -08: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 "C" {
    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! 📚

API Docs

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.