Subscribe Free

Join 2670+ others. No spamming.
I promise!

We are currently under high development. Follow us at github.


Looking for Python Tutorials?
Check these awesome tutorials



neon-bindings/neon

1236

neon-bindings / neon

Rust

A safe Rust abstraction layer for native Node.js modules.


READ ME

Neon

neon

Build Status

A safe Rust abstraction layer for native Node.js modules.

Neon protects all handles to the JavaScript heap, even when they're allocated on the Rust stack, ensuring that objects are always safely tracked by the garbage collector.

Getting started

Install neon-cli as a global npm package:

npm install -g neon-cli

To create a new Neon project, use neon new:

neon new my-project

This will ask you a few questions and then generate a project skeleton for you. Follow the instructions from there to build and run your project!

Requirements

Operating Systems

Linux macOS Windows
x x soon

For macOS, you'll need:

  • OS X 10.7 or later;
  • XCode.

Windows support is on the way. Follow #122 to track the progress.

Rust and Node

Node 4 Node 6 Node 7
Rust stable x x x
Rust beta x x x
Rust nightly

Although Neon is only tested on the latest stable Rust, it will likely work on a range of stable versions of Rust. It is known to require at least Rust 1.13.

Support for LTS versions of Node and current are expected. If you're using a different version of Node and believe it should be supported, let us know.

A Taste...

A Neon function takes a Call object and produces a Rust Result that's either a JS value or the Throw constant (meaning a JS exception was thrown). The Call object provides access to a memory management scope, which safely manages the rooting of handles to heap objects:

fn make_an_array(call: Call) -> JsResult<JsArray> {
    let scope = call.scope; // the current scope for rooting handles
    let array: Handle<JsArray> = JsArray::new(scope, 3);
    try!(array.set(0, JsInteger::new(scope, 9000)));
    try!(array.set(1, JsObject::new(scope)));
    try!(array.set(2, JsNumber::new(scope, 3.14159)));
    Ok(array)
}

For a more complete demonstration, try building a hello world with neon new, or check out the slightly bigger word count demo.

Get Involved

The Neon community is just getting started and there's tons of fun to be had. Come play! :)

The Rust Bindings community Slack is open to all; use the Slackin app to receive an invitation.

License

Licensed under either of

at your option.