atagen

matrix-rust-sdk

public
Star0
Fork0
Watch0
macltok
View all branches and tags →
4
ssh://brewery@pls.lobotomise.me:33/atagen/matrix-rust-sdk.git
61 commits4 branches0 tags0 releases16.6 MiB

Recent commits

  1. atagenb9c68844ca91event-cache: hold off rooms nobody views while a room restores or fills…2w ago
  2. atagen19e9256c1d96sliding-sync: save pos behind the sync loop, without rewinding the live connection…2w ago
  3. atagena0e7d274a279room-list: let the sync service set the growing batch size of the all rooms list…2w ago

Files

  1. .cargo2w ago
  2. .config2w ago
  3. .github2w ago
  4. benchmarks2w ago
  5. bindings2w ago
  6. contrib2w ago
  7. crates2w ago
  8. examples2w ago
  9. labs2w ago
  10. testing2w ago
  11. uniffi-bindgen2w ago
  12. xtask2w ago
  13. .deny.toml1.3 KiB2w ago
  14. .editorconfig117 B2w ago
  15. .gitignore314 B2w ago
  16. .rumdl.toml2.3 KiB2w ago
  17. .rustfmt.toml302 B2w ago
  18. .typos.toml1.3 KiB2w ago
  19. .zizmor.yml43 B2w ago
  20. ARCHITECTURE.md4.2 KiB2w ago
  21. Cargo.lock192.1 KiB2w ago
  22. Cargo.toml11.5 KiB2w ago
  23. codecov.yaml956 B2w ago
  24. CONTRIBUTING.md14.7 KiB2w ago
  25. LICENSE9.9 KiB2w ago
  26. README.md4.5 KiB2w ago
  27. release.toml449 B2w ago
  28. RELEASING.md1.6 KiB2w ago
  29. tarpaulin.toml683 B2w ago
  30. towncrier.toml722 B2w ago
README

Matrix Rust SDK

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 build Matrix clients in Rust.



<picture> <source srcset="contrib/element-logo-light.png" media="(prefers-color-scheme: dark)"> <source srcset="contrib/element-logo-dark.png" media="(prefers-color-scheme: light)"> Element logo </picture>



Development of the SDK is proudly sponsored and maintained by Element. Element uses the SDK in their next-generation mobile apps Element X on iOS and Android 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.

Purpose

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. Whether you’re writing a small bot, a desktop client, or something in between, the SDK is designed to be flexible, async-friendly, and ready to use out of the box.

Project structure

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

  • matrix-sdk-ui – A high-level client library that makes it easy to build full-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, custom clients, or higher-level abstractions. You can find example usage in the examples 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 the crypto tutorial for a step-by-step introduction.

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

Status

The library is considered production ready and backs multiple client implementations such as Element X 1(https://github.com/element-hq/element-x-ios) 2(https://github.com/element-hq/element-x-android), Fractal and iamb. Client developers should feel confident to build upon it.

Bindings

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

License

Apache-2.0