abi-adapter 0.1.3

Mechanical slot-based ABI adapter for wasm boundaries
Documentation
  • Coverage
  • 100%
    6 out of 6 items documented4 out of 4 items with examples
  • Size
  • Source code size: 116.7 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 162.2 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 2s Average build duration of successful builds.
  • all releases: 3s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • vhexl/abi-adapter
    0 0 0
  • crates.io
  • Dependencies
    • —
  • Versions
  • Owners
  • vhexl

abi-adapter

CI codecov crates.io docs.rs MSRV License

English | 简体中文

Generate wasm interfaces for ordinary Rust functions. abi! converts arguments according to a declaration, calls the target, and converts its result. No third-party dependencies; supports no_std. Requires Rust 1.85+.

Quick start

Add the crate to your project:

cargo add abi-adapter

To use unreleased changes from main, depend on the Git repository instead:

cargo add abi-adapter --git https://github.com/vhexl/abi-adapter

use abi_adapter::abi;

fn double(value: u32) -> u32 {
    value * 2
}

abi! { host pub fn double_abi([value]) -> 1 => crate::double; }

fn main() {
    assert_eq!(double_abi(21), 42);
}

host generates a regular Rust function; guest("double.v1") generates a wasm export. Each bracketed group maps to one target argument. Slots are Rust u32 values and wasm i32 values; wrappers directly return zero or one slot. Custom types use FromSlots<N> and IntoSlots<N>. For a complete wasm example, see examples/guest.rs.

Users define runtime registration, memory protocols, and error codes. Panics from conversions and target functions are not caught; guest exports trap.

Documentation

The following guides are in Chinese:

  • Usage guide: custom conversions, ctx, wasm exports, and common problems.
  • Buffer example: multi-slot results and memory conventions.
  • Architecture: modules, execution flow, and design decisions.

Development

node scripts/check.cjs runs fmt, clippy, test, doctest, doc, node, wasm, and package in order. doctest tests documentation examples; doc generates documentation. wasm builds and verifies the example. Requires Rust 1.85+ (with rustfmt, Clippy, and the wasm32-unknown-unknown target) and Node.js 22+.

node scripts/check.cjs --list
node scripts/check.cjs --only wasm
node scripts/check.cjs --skip doc --continue
node scripts/check.cjs --toolchain 1.85.0 --compatibility

--only/--skip accept comma-separated names and repeated flags; --list only lists steps. Checks stop on the first failure by default. --continue runs remaining independent checks, summarizes failures, and returns a nonzero exit code if any failed. Cargo checks use --locked, permitting downloads without lockfile changes. --toolchain selects an installed Rust version; use 1.85.0 above to check MSRV. --compatibility skips fmt and clippy.

CI reuses this script for the Linux/Windows test matrix and the MSRV job, whose version is read from Cargo.toml. Dependency auditing (cargo-deny) and coverage remain separate CI jobs; a weekly scheduled workflow also checks beta Rust and new advisories.

Releasing

This project uses release-plz to automate releases:

  1. Every push to main triggers release-plz to open/update a Release PR with the correct version bumps and a changelog derived from Conventional Commits.
  2. Merge the Release PR when ready — release-plz will then:
    • Create the git tag (v<version>)
    • Publish to crates.io
    • Create a GitHub release with release notes

Publishing waits for the push CI run on the merged commit to succeed. If that CI run is re-run manually after a failure, re-run the Release-plz workflow as well; no further push is required.

Publishing uses crates.io Trusted Publishing, so no registry token is stored; setup notes are in release-plz.yml.

License

Licensed under either of

at your option.