Matrix Client-Server SDK for Rust
 
 
Go to file
Damir Jelić 03aba95e1e
Switch the FFI bindings to use the SQLite cryptostore
2023-03-29 11:44:33 +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 fix(sdk): Fix, test, and clean up `SlidingSyncListRequestGenerator` 2023-03-16 17:04:05 +01:00
benchmarks chore(deps): bump tokio from 1.24.1 to 1.24.2 2023-02-04 08:27:50 +01:00
bindings Switch the FFI bindings to use the SQLite cryptostore 2023-03-29 11:44:33 +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 Make tokio a workspace dependency 2023-03-28 21:08:57 +02:00
examples sdk: Use new filter constructor to enable room members lazy-loading 2023-03-25 21:12:09 +01:00
labs Make tokio a workspace dependency 2023-03-28 21:08:57 +02:00
testing Make tokio a workspace dependency 2023-03-28 21:08:57 +02:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask Allow room key forwarding to be enabled and disabled (#1365) 2023-03-14 18:23:39 +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 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 Switch the FFI bindings to use the SQLite cryptostore 2023-03-29 11:44:33 +02:00
Cargo.toml Make tokio a workspace dependency 2023-03-28 21:08:57 +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 ci: update codecov config to exclude all testing crates 2022-08-02 10:59:18 +02:00
tarpaulin.toml chore: Delete sled-state-inspector 2023-02-22 13:17:01 +01: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