Matrix Client-Server SDK for Rust
Go to file
Valere ee1d1f42c9 fix(sdk-ffi) Authentication bootstraping twice workaround 2024-01-15 14:58:45 +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 Revert "Revert "matrix-sdk-indexeddb: make `matrix-sdk-base` an optional dependency"" 2024-01-11 15:20:38 +01:00
benchmarks Use workspace dependencies for matrix-sdk-test 2024-01-05 12:58:54 +01:00
bindings fix(sdk-ffi) Authentication bootstraping twice workaround 2024-01-15 14:58:45 +01:00
contrib Fix a typo 2024-01-04 09:53:17 +01:00
crates fix(sdk-ffi) Authentication bootstraping twice workaround 2024-01-15 14:58:45 +01:00
examples Clean up Cargo manifest formattting 2024-01-04 10:02:07 +01:00
labs Remove the sqlite-lock binary from the main repo 2023-06-19 15:42:58 +02:00
testing Fix: Registration-login-pattern leads to double devices (#2888) 2024-01-08 15:24:56 +01:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask Revert "Revert "matrix-sdk-indexeddb: make `matrix-sdk-base` an optional dependency"" 2024-01-11 15:20:38 +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 Typos please 2023-11-24 18:01:05 +01:00
CONTRIBUTING.md Apply suggestions from code review 2024-01-12 17:20:10 +01:00
Cargo.lock Upgrade aquamarine dependency 2024-01-14 11:20:12 +00:00
Cargo.toml Upgrade uniffi 2024-01-05 14:03:44 +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
RELEASE.md docs: explain how to release the SDK in RELEASE.md 2024-01-12 17:20:10 +01: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