9daa11592a
This is a roundabout way to say that this addresses the last comment on #23, namely if you only use the `console` submodule from `web_sys` it doesn't actually link correctly! The problem here has to do with codegen units and the compiler. The compiler will create a codegen unit for each `mod` in the source code. If a codegen unit isn't actually used, then the codegen unit is removed from the final link step. This causes problems for web-sys where the JSON description of our program was part of the main CGU but not in each submodule, so when submodules were only used the descriptor program in the main CGU was not included. The fix in this commit is to instead generate a descriptor program in the submodule itself instead of leaving it in the main CGU. By removing the `Module` node in the AST this naturally happens as the descriptor is only generated in the same module as all other associated items. |
||
---|---|---|
.cargo | ||
crates | ||
examples | ||
guide | ||
releases | ||
src | ||
tests | ||
.appveyor.yml | ||
.eslintignore | ||
.eslintrc | ||
.gitattributes | ||
.gitignore | ||
.travis.yml | ||
build.rs | ||
Cargo.toml | ||
CHANGELOG.md | ||
CONTRIBUTING.md | ||
LICENSE-APACHE | ||
LICENSE-MIT | ||
package.json | ||
publish.rs | ||
README.md |
wasm-bindgen
Facilitating high-level interactions between wasm modules and JavaScript.
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 thedocument.querySelector
method doesn't causeNode.prototype.appendChild
orwindow.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
- Apache License, Version 2.0, (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
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.