Matrix.RustSdk.Bindings 0.1.0

Matrix.RustSdk

An unofficial C# wrapper for matrix-rust-sdk, the Rust SDK for the Matrix protocol. This project is community-maintained and not affiliated with The Matrix.org Foundation.

Installation

The managed bindings and the native libraries are shipped in separate packages, so applications only download the platforms they need. Reference the native packages for the platforms the application runs on, they bring the matching Matrix.RustSdk.Bindings package:

<PackageReference Include="Matrix.RustSdk.Bindings.Native.Linux" Version="0.1.0" />
<PackageReference Include="Matrix.RustSdk.Bindings.Native.Windows" Version="0.1.0" />

The native libraries only work with the bindings of the exact same version, so the native packages depend on exactly that version of Matrix.RustSdk.Bindings. The glibc libraries require glibc 2.35 or newer (Ubuntu 22.04, Debian 12, RHEL 10), the musl libraries libgcc (installed with .NET on Alpine).

The packages contain matrix-rust-sdk and the Rust crates it depends on, their licenses and copyright notices are in THIRD-PARTY-NOTICES.txt in every package.

The bindings are generated from matrix-rust-sdk, the release notes of each package name the matrix-sdk-ffi release it was built from. The API follows the upstream SDK, which changes with almost every release, so minor versions of the packages contain breaking changes until 1.0.

Development

The development environment is managed with devenv, devenv shell provides Rust, .NET and uniffi-bindgen-cs.

git submodule update --init
devenv shell
./scripts/build-debug.sh  # builds matrix-sdk-ffi for the host and regenerates the C# bindings
dotnet test               # runs the tests against a tuwunel homeserver, requires docker

The uniffi version used by external/matrix-rust-sdk has to match the one uniffi-bindgen-cs is built for (UNIFFI_RS_VERSION in devenv.nix). When updating the submodule, pick a matrix-sdk-ffi/* tag whose uniffi version matches the latest uniffi-bindgen-cs release.

Releases

See RELEASING.md for versioning and the release process.

The Packages workflow builds the native libraries on native GitHub runners for every platform, tests them and packs the NuGet packages, the Publish NuGet package workflow publishes them. Pull requests run the same builds once the basic build and tests passed.

Each library is tested on its runner before it is packed. The Linux runners run all tests, the musl libraries are built and tested in Alpine containers. The Windows and macOS runners can't run the Linux homeserver container and only run the smoke tests that don't need a homeserver.