gecko-dev/js/rust
Jason Orendorff fbc689a32a Bug 1448324 - Fix link in js/rust readme. r=jdm
Differential Revision: https://phabricator.services.mozilla.com/D49748

--HG--
extra : moz-landing-system : lando
2019-10-18 14:30:52 +00:00
..
etc Bug 1534967 - Part 2: Use RootedIdVector in rust binding. r=jonco,fitzgen 2019-04-08 10:46:58 +08:00
src Bug 1583251 - P6 - Apply the change to sc.rs; r=sfink 2019-10-23 07:21:05 +00:00
tests Bug 1573844 - Remove js::Class definition and alias JSClass to it r=tcampbell,mccr8 2019-08-15 08:32:22 +00:00
.gitignore
CMakeLists.txt
Cargo.toml Bug 1587368 - Stop using -oldsyn bindgen version now that we pull newer syn and proc_macro versions anyway. 2019-10-09 13:42:36 +02:00
README.md Bug 1448324 - Fix link in js/rust readme. r=jdm 2019-10-18 14:30:52 +00:00
build.rs Bug 1586683 - Remove flat strings from JSAPI. r=jwalden,bzbarsky 2019-10-14 09:32:07 +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