Facilitating high-level interactions between Wasm modules and JavaScript
Go to file
Alex Crichton df8da56a6c Add PartialEq/Eq to many js-sys types
This commit adds `#[derive(PartialEq, Eq)]` to many types throughout
`js-sys`. These types are basically all based on `Object`, which means
that `Object.is` can be used for `PartialEq` and the `Eq` requirements
are upheld.

The macro has also been updated to internally store the deref target
instead of unconditionally storing `JsValue`, allowing `#[derive]` to
work a bit better in these situations.
2019-04-12 09:02:33 -07:00
.cargo Start running CI tests on Rust beta 2018-09-25 10:36:28 -07:00
ci Try to reduce spurious failures on Windows 2019-03-05 12:14:15 -08:00
crates Add PartialEq/Eq to many js-sys types 2019-04-12 09:02:33 -07:00
examples Bump to 0.2.42 2019-04-11 07:39:45 -07:00
guide Merge pull request #1416 from alexcrichton/js-string-valid-utf16 2019-04-05 10:12:32 -05:00
releases Add a template for release announcements 2018-06-19 12:05:52 -07:00
src Add an accessor for the function table 2019-04-08 10:40:46 -07:00
tests Add an accessor for the function table 2019-04-08 10:40:46 -07:00
_package.json Implement transitive support for NPM dependencies 2019-03-22 09:42:40 -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
azure-pipelines.yml Merge pull request #1358 from stevebob/book-linkcheck-pr 2019-03-27 08:04:49 -04:00
build.rs Implement AsRef<JsValue> for Closure<T> 2018-09-06 14:46:59 -07:00
Cargo.toml Bump to 0.2.42 2019-04-11 07:39:45 -07:00
CHANGELOG.md Bump to 0.2.42 2019-04-11 07:39:45 -07: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
publish.rs Bump to 0.2.39 2019-03-13 11:02:27 -07:00
README.md Update README.md 2019-03-07 15:17:28 -06:00

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.