gecko-dev/js/rust
Jeff Walden 67740b3d17 Bug 1491137 - Rename JS::CompileFunction that takes const char*/size_t for function text to JS::CompileFunctionUtf8 that asserts consistent |options.utf8|. r=jandem
--HG--
extra : rebase_source : b4c051e8d3c78d7c16c29c5d9f299ead08e479a6
2018-09-17 11:24:41 -07:00
..
etc Bug 1486577 - Move compilation and evaluation APIs into a new public js/CompilationAndEvaluation.h header. r=jandem 2018-08-24 14:55:28 -05:00
src Bug 1485066 - Part 1: Remove JSAutoByteString. r=Waldo 2018-09-05 02:25:42 -07:00
tests Bug 1485066 - Part 1: Remove JSAutoByteString. r=Waldo 2018-09-05 02:25:42 -07: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 1488172 - Update bindgen in js/rust as well. r=me 2018-09-03 14:13:36 +02:00
README.md
build.rs Bug 1491137 - Rename JS::CompileFunction that takes const char*/size_t for function text to JS::CompileFunctionUtf8 that asserts consistent |options.utf8|. r=jandem 2018-09-17 11:24:41 -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