Skip to content
Branch: master
Clone or download
Pull request Compare This branch is 59 commits behind rustwasm:master.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.cargo Start running CI tests on Rust beta Sep 25, 2018
ci Try to reduce spurious failures on Windows Mar 5, 2019
crates
examples Bring back accidentally deleted raytrace build script Mar 21, 2019
guide
releases
src
tests
.gitattributes add .gitattributes to mark WebIDL as vendored Jul 11, 2018
.gitignore Bump to 0.2.18 Aug 27, 2018
CHANGELOG.md
CONTRIBUTING.md
Cargo.toml
LICENSE-APACHE
LICENSE-MIT Add license texts Dec 18, 2017
README.md
azure-pipelines.yml
build.rs
package.json
publish.rs Bump to 0.2.39 Mar 13, 2019

README.md

wasm-bindgen

Facilitating high-level interactions between wasm modules and JavaScript.

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! 📚

You can find general documentation about Rust and WebAssembly 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.

You can’t perform that action at this time.