mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-06 15:04:11 -04:00
c73aeef2ed
The SQLite crypto store uses rmp_serde to serialize all the data we're going to store. This works nicely for most things, one exception to this is the OutboundGroupSession type. The OutboundGroupSession type stores to-device requests to ensure that the session doesn't get used before it is shared with the whole group and to ensure that the to-device requests get restored if the session gets restored after an application restart. The to-device requests type critically contain `Raw<AnyToDeviceEvent>`, the `Raw` type here being the serde_json::Raw type. rmp_serde seems to serialize this just fine, but later deserialization fails. We're avoiding the issue by using serde_json to serialize the OutboundGroupSession.
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.