Matrix Client-Server SDK for Rust
Go to file
Andy Balaam 82684d64d4
Merge pull request #3180 from matrix-org/jme/bump-uniffi-referenced-commit-so-android-works-again
ffi: bump the UniFFi referenced commit again
2024-03-01 13:27:53 +00: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 our nightly version for the CI and xtask 2024-02-07 13:57:07 +01:00
benchmarks Discard session API and bindings for `Room` (#2941) 2024-02-20 13:36:55 +01:00
bindings ffi: aggregate `RoomMember` fields early instead of requiring to call getters (#3172) 2024-02-29 17:27:21 +01:00
contrib Fix a typo 2024-01-04 09:53:17 +01:00
crates ffi: aggregate `RoomMember` fields early instead of requiring to call getters (#3172) 2024-02-29 17:27:21 +01:00
examples fix(examples): Fix typos in getting started example 2024-02-25 11:35:59 +01:00
labs event cache: have a single `EventCache` instance per `Client`, at most (#3136) 2024-02-19 12:39:31 +00:00
testing test: fix one potential race in `test_room_notification_count` 2024-02-22 18:01:53 +01:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask Bump our nightly version for the CI and xtask 2024-02-07 13:57:07 +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 indexeddb: Create a migrations directory 2024-02-05 15:57:07 +00:00
CONTRIBUTING.md docs: Clarify PR title guidelines. 2024-02-26 10:31:28 +01:00
Cargo.lock ffi: bump the UniFFi referenced commit again 2024-03-01 13:59:12 +01:00
Cargo.toml ffi: bump the UniFFi referenced commit again 2024-03-01 13:59:12 +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 RELEASE.md: remove spurious backticks 2024-01-18 10:31:36 +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