Matrix Client-Server SDK for Rust
Go to file
Jonas Platte 6d8764f4e7 Patch const_panic 2023-07-14 10:46:52 +02:00
.cargo chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
.config fix: Apply redactions to room state events in database, too (#917) 2022-09-27 09:24:53 +02:00
.github ci: Update actions/checkout in GitHub Actions workflows to v3 2023-07-14 10:22:55 +02:00
benchmarks Upgrade criterion, pprof 2023-07-03 18:08:01 +02:00
bindings ffi: Move more types out of UDL 2023-07-14 10:46:52 +02:00
contrib chore(contrib): Mitmproxy 9 has removed the HTTP prefix from the Response type 2022-11-17 12:43:56 +01:00
crates Fix some typos 2023-07-14 10:10:03 +02:00
examples Re-format with latest rustfmt 2023-07-03 18:57:05 +02:00
labs Remove the sqlite-lock binary from the main repo 2023-06-19 15:42:58 +02:00
testing test: Rename EventBuilder to SyncResponseBuilder 2023-07-12 10:29:29 +02:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask Remove matrix-sdk-crypto-js 2023-07-13 13:11:02 +02:00
.editorconfig
.gitignore fix(bindings): More authentication service server name fixes 2023-03-14 14:40:19 +00:00
.rustfmt.toml chore: Add rust.vim edition workaround 2022-09-22 10:38:17 +02:00
.typos.toml ci: Upgrade typos 2023-07-05 17:47:06 +02:00
CONTRIBUTING.md chore: Add CONTRIBUTING.md 2022-12-05 14:58:33 +01:00
Cargo.lock Patch const_panic 2023-07-14 10:46:52 +02:00
Cargo.toml Patch const_panic 2023-07-14 10:46:52 +02:00
LICENSE
README.md docs: updated readme - rust version (#2047) 2023-06-09 13:16:09 +00:00
UPGRADING-0.5-to-0.6.md Fix some typos 2023-07-14 10:10:03 +02:00
codecov.yaml Remove matrix-sdk-crypto-js 2023-07-13 13:11:02 +02:00
tarpaulin.toml Remove matrix-sdk-crypto-js 2023-07-13 13:11:02 +02:00

README.md

Build Status codecov License #matrix-rust-sdk Docs - Main Docs - Stable

matrix-rust-sdk

matrix-rust-sdk is an implementation of a Matrix client-server library in Rust.

Project structure

The rust-sdk consists of multiple crates that can be picked at your convenience:

  • matrix-sdk - High level client library, with batteries included, you're most likely interested in this.
  • matrix-sdk-base - No (network) IO client state machine that can be used to embed a Matrix client in your project or build a full fledged network enabled client lib on top of it.
  • matrix-sdk-crypto - No (network) IO encryption state machine that can be used to add Matrix E2EE support to your client or client library.

Minimum Supported Rust Version (MSRV)

These crates are built with the Rust language version 2021 and require a minimum compiler version of 1.70.

Status

The library is in an alpha state, things that are implemented generally work but the API will change in breaking ways.

If you are interested in using the matrix-sdk now is the time to try it out and provide feedback.

Bindings

Some crates of the matrix-rust-sdk can be embedded inside other environments, like Swift, Kotlin, JavaScript, Node.js etc. Please, explore the bindings/ directory to learn more.

License

Apache-2.0