Skip to content

README.md

Latest commit

 

History

History
127 lines (101 loc) · 3.5 KB

README.md

File metadata and controls

127 lines (101 loc) · 3.5 KB
Raw

aimux bindings

Multi-language bindings for aimux. All bindings share the same Rust core (aimux-core + aimux-providers), accessed via two paths:

                  ┌─ Native path ──→ aimux-core + aimux-providers (directly maps Rust types + async)
Binding layer ────┤
                  └─ C ABI path ──→ aimux-ffi (handles + JSON results + aimux_error_t * returned error)
Binding Path Tool Status Directory
Node.js Native napi-rs v3 ✅ Available node/
Python Native PyO3 + maturin ✅ Available python/
Swift C ABI Swift Package (module.modulemap) ✅ PoC swift/
Kotlin C ABI JNA ✅ PoC kotlin/
Flutter C ABI dart:ffi handwritten ✅ PoC flutter/
Go C ABI cgo (static linking libaimux_ffi.a) ✅ PoC go/
Java C ABI JNA ✅ PoC java/
C / C++ C ABI direct link to aimux-ffi.h ✅ PoC c/

Build

Node.js

cd bindings/node
npm install
npx napi build --platform    # debug
npx napi build --platform --release  # release
npm test

Python

cd bindings/python
python -m venv .venv && source .venv/bin/activate
pip install maturin pytest
maturin develop
pytest tests/ -v

Swift

# First build the aimux-ffi dylib
cargo build -p aimux-ffi --release
cp target/release/libaimux_ffi.dylib /usr/local/lib/

cd bindings/swift
swift build
swift test

Kotlin

# First build the aimux-ffi .so
cargo build -p aimux-ffi --release
mkdir -p bindings/kotlin/src/main/resources
cp target/release/libaimux_ffi.so bindings/kotlin/src/main/resources/

cd bindings/kotlin
export LD_LIBRARY_PATH="$PWD/src/main/resources:$LD_LIBRARY_PATH"
gradle test

Flutter

# First build the aimux-ffi .so
cargo build -p aimux-ffi --release

cd bindings/flutter
dart pub get
LD_LIBRARY_PATH=../../target/release dart test

C / C++

# First build aimux-ffi
cargo build -p aimux-ffi --release

# C
gcc -o example bindings/c/example.c \
    -I aimux-ffi -L target/release -laimux_ffi -lpthread -ldl -lm

# C++
g++ -std=c++17 -o example_cpp bindings/c/example.cpp \
    -I aimux-ffi -L target/release -laimux_ffi -lpthread -ldl -lm

Go

# First build aimux-ffi (requires the libaimux_ffi.a optimized with the release profile)
cargo build -p aimux-ffi --release

cd bindings/go
go test ./...

The Go binding statically links libaimux_ffi.a via cgo; the artifact is a single binary (the Rust core is compiled into the executable, no need to distribute .so). See RFC-0011 for details.

Java

# First build the aimux-ffi .so
cargo build -p aimux-ffi --release

cd bindings/java
export JAVA_HOME=...   # JDK 17 (any 9+ works; bytecode targets Java 8)
export LD_LIBRARY_PATH="$(pwd)/../../target/release:${LD_LIBRARY_PATH}"
gradle test

The Java binding uses JNA (no native toolchain needed at build time); the native library ships as per-platform classifier JARs. See RFC-0013 for details.

Contract Tests

Shared JSON fixtures drive all languages, ensuring wire format consistency:

# Rust side
cargo test -p aimux-core --test contract_test

# Node side
node --experimental-strip-types contract-tests/run-node.ts

The fixtures are located at contract-tests/fixtures/wire-format.json.