Matrix Client-Server SDK for Rust
Go to file
Kévin Commaille 1e1e0d7e6d ci: Make sure all rendered docs examples are compiling
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
2023-03-15 14:42:12 +01: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 ci: Make sure all rendered docs examples are compiling 2023-03-15 14:42:12 +01:00
benchmarks chore(deps): bump tokio from 1.24.1 to 1.24.2 2023-02-04 08:27:50 +01:00
bindings ffi: Put CreateRoomParameters back into the UDL file 2023-03-15 13:09:54 +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 sdk: Fix generate_image_thumbnail example in docs 2023-03-15 14:42:12 +01:00
examples examples: Also handle SSO login in the login example 2023-03-07 15:12:33 +01:00
labs Upgrade eyeball to 0.4.0 2023-03-11 13:13:50 +01:00
testing base: Rename RoomType to RoomState 2023-03-13 13:17:15 +01: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
.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 fix(sdk): Rewrite decryption retrying to fix invalid index bug 2023-02-22 12:44:11 +01:00
CONTRIBUTING.md chore: Add CONTRIBUTING.md 2022-12-05 14:58:33 +01:00
Cargo.lock sdk: Add get_media_file function 2023-03-15 09:22:53 +00:00
Cargo.toml sdk: Fix timeline highlight test 2023-03-14 14:02:01 +01:00
LICENSE
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
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