#wasm-module #stateroom #websocket

stateroom-wasm

A macro for building a Stateroom service as a WebAssembly module

10 releases

0.4.0 May 5, 2024
0.2.9 Apr 29, 2023
0.2.8 Feb 20, 2023
0.2.6 Sep 20, 2022
0.2.0 Jan 20, 2022

#554 in WebAssembly

Download history 1/week @ 2024-02-23 1/week @ 2024-03-01 24/week @ 2024-03-22 2/week @ 2024-03-29 107/week @ 2024-05-03 7/week @ 2024-05-10 4/week @ 2024-05-17 3/week @ 2024-05-24

121 downloads per month

MIT/Apache

24KB
267 lines

stateroom-wasm

stateroom-wasm is a companion crate to stateroom that helps you package and export services as WebAssembly modules.

#[stateroom_wasm] macro

WebAssembly modules must import and export certain named functions in order for the Stateroom server to understand them. stateroom_wasm provides the #[stateroom_wasm] module, which should be applied to an item (struct, enum, or type alias) that implements SimpleStateroomService.

A Stateroom-compatible WebAssembly module must contain exactly one service. If you need to generate multiple services for your application, currently the best approach is to make a crate for each service.

It's possible to generate bindings for a service that belongs to another module using a type alias:

use stateroom_wasm::stateroom_wasm;
use some_module::SomeService;

#[stateroom_wasm]
type Service = SomeService;

Execution model

Upon initialization, the generated model creates an instance of your SimpleStateroomService by calling its new(room_id, context) constructor. The context object that is passed in the constructor and subsequent function calls is a global static object that binds to functions imported from the host environment (like send_message).

Compiling

If you are using the Stateroom command-line interface, stateroom dev will build the current crate using the wasm32-wasi target, and then load and serve the generated WebAssembly module.

If you would like to build it manually, make sure you have the wasm32-wasi target installed and pass it as a target to cargo build:

$ rustup target add wasm32-wasi
$ cargo build --release --target=wasm32-wasi

Embedding

This crate has a counterpart, stateroom-wasm-host, which can take a module generated with this crate and expose it through a StateroomService interface.

Dependencies

~0.7–1.3MB
~30K SLoC