gecko-dev/js/rust
Iain Ireland 29dc9fe2ea Bug 1559072: Revert Rust bindings to old boxing format r=djvj
Depends on D35547

Differential Revision: https://phabricator.services.mozilla.com/D35548

--HG--
extra : moz-landing-system : lando
2019-06-25 17:11:15 +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 1559072: Revert Rust bindings to old boxing format r=djvj 2019-06-25 17:11:15 +00:00
tests Bug 1549340 - Part 2: Use union instead of reinterpret_cast to initialize const char* with symbol for JSPropertySpec.name. r=jandem 2019-05-13 10:26:48 +00: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 1529681 - Update bindgen. r=bbouvier 2019-03-27 14:39:41 +00:00
README.md
build.rs Bug 1542184 - Use PersistentRooted for rooting vectors of GC things from rust code r=fitzgen? 2019-05-10 17:36:34 +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