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
7,646 Commits 96 Branches 93 Tags 94 MiB
Rust 99.8%
Go to file
Benjamin Bouvier f6501e585a crypto: put the enabling of backup and recovery in the background (#2795) 2023-10-31 12:38:50 +01:00
.cargo ci: Improve caching for matrix-rust-components-swift and tarpaulin 2023-09-01 10:43:52 +02:00
.config test(ci): Exponential backoff when retrying flaky tests. 2023-09-07 09:12:29 +02:00
.github Bump synapse image version in integration testing 2023-10-23 14:56:11 +02:00
benchmarks chore(auth): prefix `Session` data structures with the auth kind 2023-09-15 13:03:11 +02:00
bindings Expose the recovery thing in the bindings 2023-10-31 12:38:50 +01:00
contrib chore(contrib): Mitmproxy 9 has removed the HTTP prefix from the Response type 2022-11-17 12:43:56 +01:00
crates crypto: put the enabling of backup and recovery in the background (#2795) 2023-10-31 12:38:50 +01:00
examples Display the recovery state in the emoji example 2023-10-31 12:38:50 +01:00
labs Remove the sqlite-lock binary from the main repo 2023-06-19 15:42:58 +02:00
testing sdk: Make transaction_id truly optional for send and send_raw 2023-10-31 11:13:25 +01:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask Enable backups in the crypto crate by default 2023-10-31 12:26:41 +01:00
.editorconfig build: Adding .editorconfig 2022-08-01 14:33:05 +02:00
.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 crypto: Detect and fix 'sign'-related typos 2023-10-06 11:38:32 +02:00
CONTRIBUTING.md chore: Add CONTRIBUTING.md 2022-12-05 14:58:33 +01:00
Cargo.lock Add an example for the recovery stuff 2023-10-31 12:38:50 +01:00
Cargo.toml Backup support 2023-10-31 12:29:51 +01:00
LICENSE rust-sdk: Switch the license to Apache 2.0. 2020-02-21 16:54:05 +01:00
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-appservice 2023-09-05 15:40:38 +02:00
tarpaulin.toml test: Merge the two integration test suites into a single one 2023-10-23 13:55:42 +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