mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-19 14:19:06 -04:00
ad5761bfb5
A detached task was spawned to react upon session changes, and that task captured a clone of the current `Client`. This caused a leak of the `Client`, because that task would never get aborted, and would not stop by itself. The fix here consists in having `Client::set_delegate` return a task handle that needs to be stashed by the FFI users, and cancelled when the Client gets out of scope. This fixes the leak, by removing the last reference onto the Client. Then, when dropping the Client, we have to drop the Stores in it. These stores may be sqlite-based stores, which make use of deadpool. Deadpool has a sync wrapper that will call `block_on` in a `drop` method, and as such it requires to be in the scope of a tokio runtime to run properly. To avoid breaking all abstractions and giving access to the inners of the `Client`, the hack used here to properly be in a runtime when dropping the stores is to replace the inner sdk `Client` in the FFI `Client::drop` method (and replace it with a dummy client that is minimally configured and will use in-memory stores).
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.