gecko-dev/js/rust
Dragana Damjanovic 96b916ebe1 Bug 1682262 - Update neqo to 0.4.18 and bindgen to 0.56 r=necko-reviewers,emilio,valentin
Differential Revision: https://phabricator.services.mozilla.com/D99665
2020-12-14 18:38:49 +00:00
..
etc Bug 1663365 - Don't include "js/friend/ErrorMessages.h" in jsfriendapi.h. r=arai 2020-10-30 06:33:56 +00:00
src Bug 1679736 - Prohibit Rooted<void*> r=jonco 2020-12-03 23:05:29 +00:00
tests Bug 1673553 part 67 - Remove JS_NewObjectWithUniqueType. r=iain 2020-12-03 07:54:00 +00:00
.gitignore
CMakeLists.txt
Cargo.toml Bug 1682262 - Update neqo to 0.4.18 and bindgen to 0.56 r=necko-reviewers,emilio,valentin 2020-12-14 18:38:49 +00:00
README.md
build.rs Bug 1679736 - Prohibit Rooted<void*> r=jonco 2020-12-03 23:05:29 +00:00

README.md

The js Crate: Rust Bindings to SpiderMonkey

User Documentation

Building

To build a release version of SpiderMonkey and the Rust code with optimizations enabled:

$ cargo build --release

To build with SpiderMonkey's DEBUG checks and assertions:

$ cargo build --features debugmozjs

Raw FFI bindings to JSAPI are machine generated with rust-lang-nursery/rust-bindgen, and requires libclang >= 3.9. See ./build.rs for details.

Cargo Features

  • debugmozjs: Create a DEBUG build of SpiderMonkey with many extra assertions enabled. This is decoupled from whether the crate and its Rust code is built in debug or release mode.

  • promises: Enable SpiderMonkey native promises.

  • nonzero: Leverage the unstable NonZero type. Requires nightly Rust.

Testing

Make sure to test both with and without the debugmozjs feature because various structures have different sizes and get passed through functions differently at the ABI level! At minimum, you should test with debugmozjs to get extra assertions and checking.

$ cargo test
$ cargo test --features debugmozjs