matrix-org
/
matrix-rust-sdk
mirror of https://github.com/matrix-org/matrix-rust-sdk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Matrix Client-Server SDK for Rust
5,957 Commits 98 Branches 93 Tags 97 MiB
Rust 99.8%
Go to file
Jonas Platte 78838e67c1 Upgrade dependencies 2023-05-17 17:20:55 +02:00
.cargo chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
.config
…
.github chore: add the `--workspace` flag back in the documentation CI task 2023-05-09 10:21:48 +02:00
benchmarks bench: add benchmarks for encrypted stores too 2023-05-15 17:11:50 +02:00
bindings feat(sdk): `SlidingSyncMode` has richer variants 2023-05-17 17:10:26 +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 Upgrade dependencies 2023-05-17 17:20:55 +02:00
examples Upgrade dependencies 2023-05-17 17:20:55 +02:00
labs feat(labs): Remove `jack-in`. 2023-03-30 18:03:38 +02:00
testing Replace futures dependencies with futures-* dependencies 2023-05-17 17:20:55 +02:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask Move timeline API into a new crate 2023-05-17 09:58:31 +02:00
.editorconfig
…
.gitignore fix(bindings): More authentication service server name fixes 2023-03-14 14:40:19 +00:00
.rustfmt.toml
…
.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 Upgrade dependencies 2023-05-17 17:20:55 +02:00
Cargo.toml Upgrade dependencies 2023-05-17 17:20:55 +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 codecov: Add SQLite store as default crate 2023-05-08 12:11:10 +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