Repository files navigation

Your all-in-one toolkit for creating Matrix clients with Rust, from simple bots to full-featured apps.

---

The Matrix Rust SDK is a collection of libraries that make it easier to buildMatrix clients inRust.

Development of the SDK is proudly sponsored and maintained byElement. Element uses the SDK in their next-generation mobile apps Element X oniOS andAndroid and has plans to introduce it to the web and desktop clients as well.

The SDK is also the basis for multiple Matrix projects and we welcome contributions from all.

The SDK takes care of the low-level details like encryption,syncing, and room state, so you can focus on your app's logic and UI. Whetheryou're writing a small bot, a desktop client, or something in between, the SDKis designed to be flexible, async-friendly, and ready to use out of the box.

The Matrix Rust SDK is made up of several crates that build on top of eachother. The following crates are expected to be usable as direct dependencies:

• matrix-sdk-ui – A high-level client library that makes it easy to buildfull-featured UI clients with minimal setup. Check out our reference client,multiverse, for an example.
• matrix-sdk – A mid-level client library, ideal for building bots, customclients, or higher-level abstractions. You can find example usage in theexamples directory.
• matrix-sdk-crypto – A standalone encryption state machine with no network I/O,providing end-to-end encryption support for Matrix clients and libraries.See thecrypto tutorialfor a step-by-step introduction.

All other crates are effectively internal-only and only structured as cratesfor organizational purposes and to improve compilation times. Direct usage of them is discouraged.

The library is considered production ready and backs multiple clientimplementations such as Element X[1][2],Fractal andiamb. Client developers should feelconfident to build upon it.

The higher-level crates of the Matrix Rust SDK can be embedded in otherenvironments such as Swift, Kotlin, JavaScript, and Node.js. Check out thebindings/ directory to learn more about how to integrate the SDKinto your language of choice.

Apache-2.0