gecko-dev/js/rust
Jan de Mooij 7a68d5cb68 Bug 1466128 part 2 - Rename AutoCompartment to AutoRealm. r=jdm
Differential Revision: https://phabricator.services.mozilla.com/D3325

--HG--
extra : rebase_source : 961707f473d4c6664736f5f2e266be949a9ac700
extra : source : a4262ccfec7a662f672138f856cd7779ebd8e824
2018-08-14 14:25:48 +02:00
..
etc Bug 1033916 followup - Fix SpiderMonkey Rust bindings by including jsapi.h in wrapper.hpp instead of relying on jsfriendapi.h doing it. r=me 2018-08-21 09:53:23 +02:00
src Bug 1466128 part 2 - Rename AutoCompartment to AutoRealm. r=jdm 2018-08-14 14:25:48 +02:00
tests Bug 1466128 part 2 - Rename AutoCompartment to AutoRealm. r=jdm 2018-08-14 14:25:48 +02:00
.gitignore
CMakeLists.txt Bug 1451931 - Enable C++14 for SpiderMonkey Rust Bindings. r=glandium 2018-04-13 07:17:45 +09:00
Cargo.toml Bug 1472538: Update bindgen. r=xidorn 2018-07-01 16:04:49 +02:00
README.md
build.rs Bug 1472973 part 16 - Remove js::GetGlobalForObjectCrossCompartment. r=luke 2018-08-02 09:15:42 +02: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