gecko-dev/js/rust
Jeff Walden 04d21ccac0 Bug 1451248. r=jorendorff, r=bz
--HG--
extra : rebase_source : e26439a5954162bdaf332fbd63d623a3810e19e0
2018-04-25 19:40:09 -07:00
..
etc
src Bug 1455071 tier 2 bustage followup - s/WriteBytes/AppendBytes/ 2018-04-19 00:37:58 -07:00
tests Bug 1454512 - Fix JS::Value's is_symbol predicate. r=sfink 2018-04-18 15:44:43 -04:00
.gitignore
build.rs Bug 1451248. r=jorendorff, r=bz 2018-04-25 19:40:09 -07:00
Cargo.toml Bug 1454512 - Fix JS::Value's is_symbol predicate. r=sfink 2018-04-18 15:44:43 -04:00
CMakeLists.txt Bug 1451931 - Enable C++14 for SpiderMonkey Rust Bindings. r=glandium 2018-04-13 07:17:45 +09: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