Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/second-state/rustwasmc
Tool for building Rust functions for Node.js. Combine the performance of Rust, safety and portability of WebAssembly, and ease of use of JavaScript.
https://github.com/second-state/rustwasmc
javascript node-js nodejs rust rust-functions rust-lang second-state wasm wasmedge webassembly
Last synced: 5 days ago
JSON representation
Tool for building Rust functions for Node.js. Combine the performance of Rust, safety and portability of WebAssembly, and ease of use of JavaScript.
- Host: GitHub
- URL: https://github.com/second-state/rustwasmc
- Owner: second-state
- License: apache-2.0
- Archived: true
- Created: 2020-03-17T12:46:23.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-03-27T22:43:12.000Z (over 1 year ago)
- Last Synced: 2024-04-26T08:03:04.683Z (2 months ago)
- Topics: javascript, node-js, nodejs, rust, rust-functions, rust-lang, second-state, wasm, wasmedge, webassembly
- Language: Rust
- Homepage: https://www.secondstate.io/articles/rustwasmc/
- Size: 333 KB
- Stars: 129
- Watchers: 4
- Forks: 10
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
- Code of conduct: CODE_OF_CONDUCT.md
Lists
- awesome-stars - rustwasmc - state | 129 | (Rust)
README
rustwasmc
Rust compiler toolkit for WebAssembly apps in the WasmEdge Runtime
Developers: Getting started with the [Second State Functions](https://www.secondstate.io/articles/getting-started-with-function-as-a-service-in-rust/) (a serverless FaaS service), [Tencent Serverless Functions for AI inference](https://github.com/second-state/tencent-tensorflow-scf/blob/main/README-en.md), or [your own Node.js server](https://www.secondstate.io/articles/getting-started-with-rust-function/).
## About
A one-stop tool for building Rust functions into WebAssembly for deployment on the [WasmEdge Runtime](https://github.com/WasmEdge/WasmEdge).
## Prerequisite
You will need to install the Rust compiler in order to use `rustwasmc`. Currently, we support up to Rust 1.50.0.
```
$ curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
$ source $HOME/.cargo/env
```
## Install
From Linux command line
```
$ curl https://raw.githubusercontent.com/second-state/rustwasmc/master/installer/init.sh -sSf | sh
```
From NPM and Node.js
```
$ npm install -g rustwasmc # Append --unsafe-perm if permission denied
```
## Usage
To build [Rust functions for Node.js](https://www.secondstate.io/articles/getting-started-with-rust-function/) applications, use the following command. See a [template application](https://github.com/second-state/wasmedge-nodejs-starter). The `rustwasmc` compiles and generates the wasm file, and the corresponding JavaScript file to call wasm functions from JavaScript. If the rust package contains only binary crate(s) and there are no library crate, the build command will only generate a `wasm-wasi` file for running as a standalone command program in the WasmEdge VM.
```
$ rustwasmc build
```
In most cases, you will want to enable AOT optimization in order to improve performance.
```
$ rustwasmc build --enable-aot
```
If you would like to use WasmEdge's extended APIs including Tensorflow, enable the extensions. Make sure that you install the `wasmedge-extensions` NPM module in this case.
```
$ rustwasmc build --enable-aot --enable-ext
```
To build Rust functions for Deno applications, use the following command. See a [template application](https://github.com/second-state/ssvm-deno-starter).
```
$ rustwasmc build --target deno
```
By default, rustwasmc will generate a directory for it's build output called pkg. If you'd like to customize this you can use the --out-dir flag.
```
$ rustwasmc build --out-dir out
```
Use clean subcommand to remove pkg and target directories.
```
$ rustwasmc clean
```
## Logging
`rustwasmc` uses [`env_logger`] to produce logs when `rustwasmc` runs.
To configure your log level, use the `RUST_LOG` environment variable. For example:
```
$ RUST_LOG=info rustwasmc build
```
[`env_logger`]: https://crates.io/crates/env_logger
## Known issues
For Rust version 1.51 and above, `rustwasmc` generates bytecode without WASI support. That means programs that access the file system, date and time, environment variables, and command line arguments would *fail* on Rust 1.50+. This should not affect most application use cases. We are working on a solution.
## Acknowledgment
This project is derived from the open source [wasm-pack].
[wasm-pack]: https://github.com/rustwasm/wasm-pack