gecko-dev/js/rust
Jon Coppeard ffe1421cf4 Bug 1441988 - Fix rust build bustage by adding Auto*Vector to list of opaque types r=me 2018-03-01 17:50:18 +00:00
..
etc
src Bug 1439063 - Part 1: Move several public headers from js/src to js/public. r=jandem. 2018-02-21 10:30:19 -06:00
tests Bug 1421056 - Changes to the js Rust crate needed for Starling. r=till 2017-11-27 15:58:00 -05:00
.gitignore
CMakeLists.txt
Cargo.lock Bug 1432134: Update bindgen. r=SimonSapin 2018-01-22 15:22:46 +01:00
Cargo.toml Bug 1432134: Update bindgen. r=SimonSapin 2018-01-22 15:22:46 +01:00
README.md
build.rs Bug 1441988 - Fix rust build bustage by adding Auto*Vector to list of opaque types r=me 2018-03-01 17:50:18 +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