Matrix Client-Server SDK for Rust
Go to file
Jonas Platte 9148eaaea1 sdk: Add a test for room update channels 2023-06-05 17:46:22 +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 chore: add the `--workspace` flag back in the documentation CI task 2023-05-09 10:21:48 +02:00
benchmarks Drop matrix-sdk-sled 2023-06-01 12:06:35 +02:00
bindings ui: Move gappy sync response handling out of FFI 2023-06-05 17:46:22 +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 sdk: Add a test for room update channels 2023-06-05 17:46:22 +02:00
examples Use the new VerificationRequest signalling in the emoji example 2023-05-23 16:10:05 +02:00
labs feat(labs): Remove `jack-in`. 2023-03-30 18:03:38 +02:00
testing sliding sync: infer the storage key from the loop id and user id (#2008) 2023-06-05 14:51:40 +00:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask chore(ci): Give `pushd`'s result a name so that it's not dropped. 2023-05-17 20:00:33 +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 Extended verification states 2023-03-15 18:16:31 +01:00
CONTRIBUTING.md chore: Add CONTRIBUTING.md 2022-12-05 14:58:33 +01:00
Cargo.lock ui: Deduplicate local and remote echo by event ID when it comes in late 2023-06-05 17:33:11 +02:00
Cargo.toml Temporarily use bnjbvr's repository for bump-event-types change in ruma 2023-06-01 18:51:53 +02:00
LICENSE
README.md chore: Fix our build badge 2022-12-22 11:26:29 +01:00
UPGRADING-0.5-to-0.6.md chore: fix typos in Upgrade guide 2022-09-28 17:07:37 +02:00
codecov.yaml Drop matrix-sdk-sled 2023-06-01 12:06:35 +02:00
tarpaulin.toml feat(labs): Remove `jack-in`. 2023-03-30 18:03:38 +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.65.

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