gecko-dev/js/rust
Matt Brubeck 4aa522320e Bug 1451825 - Update to env_logger 0.5. r=ted
MozReview-Commit-ID: CqKdONY1NMT

--HG--
extra : rebase_source : 29f9c7a40cf71847a6f5e5e3f33e8695e9bd0b64
2018-04-05 10:08:05 -07:00
..
etc
src Bug 1450311 - Update jsval.rs's glue code for JS::Value::layout going away and its former members being renamed. r=me on the dead-simple changes 2018-03-30 13:54:46 -07: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.toml Bug 1451825 - Update to env_logger 0.5. r=ted 2018-04-05 10:08:05 -07:00
README.md
build.rs Bug 1451825 - Update to env_logger 0.5. r=ted 2018-04-05 10:08:05 -07: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