#derive #wasmbin

macro wasmbin-derive

Derive crate for the wasmbin library

5 releases

0.2.3 Feb 6, 2024
0.2.2 Mar 10, 2023
0.2.1 Mar 7, 2023
0.2.0 Mar 5, 2023
0.1.0 Oct 17, 2020

#1275 in Procedural macros

Download history 778/week @ 2023-10-31 1166/week @ 2023-11-07 882/week @ 2023-11-14 777/week @ 2023-11-21 956/week @ 2023-11-28 1152/week @ 2023-12-05 825/week @ 2023-12-12 522/week @ 2023-12-19 185/week @ 2023-12-26 735/week @ 2024-01-02 912/week @ 2024-01-09 1077/week @ 2024-01-16 1321/week @ 2024-01-23 836/week @ 2024-01-30 1437/week @ 2024-02-06 1788/week @ 2024-02-13

5,609 downloads per month
Used in 2 crates (via wasmbin)

Apache-2.0

14KB
285 lines

wasmbin

wasmbin is a library implementing low-level parsing and serialization of WebAssembly binaries.

Public API

The entry point is the Module object.

From there you can explore the module contents by simply looking up the nested fields. The structures map pretty much 1:1 to raw WebAssembly binary format, so you can also use the specification as a reference.

Supported feature extensions

Following WebAssembly proposals are supported in addition to the core spec and can be enabled via corresponding Cargo features:

Motivation

Original blog post explaining motivation and internals: wasmbin: a self-generating WebAssembly parser & serializer.

This crate intends to provide a low-level representation of the WebAssembly module that is fully described by Rust type system. It also leverages the said type system in conjunction with custom proc-macros to autogenerate parsing/serialization/visitation code for any complex types (structures and enums).

On the user's side this approach allows any type can be used independently to represent/parse/serialize only part of the module, while on the maintainers' side it makes adding and testing new WebAssembly features as quick and easy as adding new types, fields, and variants, without having to write any manual code at all.

One other notable feature is a Lazy<T> wrapper used in wasmbin whenever the spec permits efficiently skipping over some contents (e.g. function bodies). It allows minimally invasive, efficient, "zero-cost" editing of WebAssembly modules: during decoding anything that can be skipped, is skipped over lazily (the Lazy<...> container simply stores the raw bytes), and during encoding only the modified parts of the module are re-encoded, while any untouched parts are copied verbatim as raw bytes from the source.

Dependencies

~0.5–1MB
~20K SLoC