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,823 Commits 95 Branches 93 Tags 94 MiB
Rust 99.8%
Go to file
Mauro Romito 9c0e604247 Merge branch 'main' into mauroromito/ss_once 
# Conflicts:
#	crates/matrix-sdk/src/sliding_sync/mod.rs
 		2023-05-08 18:11:45 +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 sdk: Replace Sled with SQLite as defaut store 2023-05-08 12:11:10 +02:00
benchmarks benchmarks: Replace sled with SQLite 2023-05-08 12:11:10 +02:00
bindings Merge branch 'main' into mauroromito/ss_once 2023-05-08 18:11:45 +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 Merge branch 'main' into mauroromito/ss_once 2023-05-08 18:11:45 +02:00
examples sdk: Replace Sled with SQLite as defaut store 2023-05-08 12:11:10 +02:00
labs feat(labs): Remove `jack-in`. 2023-03-30 18:03:38 +02:00
testing Merge branch 'main' into feat-sdk-sliding-sync-cancellation-token 2023-05-08 14:11:20 +02:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask sdk: Replace Sled with SQLite as defaut store 2023-05-08 12:11:10 +02: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 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 ffi: Use SQLite state store 2023-05-08 12:11:10 +02:00
Cargo.toml Upgrade UniFFI 2023-05-03 11:42:50 +02:00
LICENSE rust-sdk: Switch the license to Apache 2.0. 2020-02-21 16:54:05 +01:00
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