mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-04 05:58:11 -04:00
d03ed3063c
This patch introduces the new `EncryptionState` to represent the 3 possible states: `Encrypted`, `NotEncrypted` or `Unknown`. All the `is_encrypted` methods have been replaced by `encryption_state`. The most noticable change is in `matrix_sdk::Room` where `async fn is_encrypted(&self) -> Result<bool>` has been replaced by `fn fn encryption_state(&self) -> EncryptionState`. However, a new `async fn latest_encryption_state(&self) -> Result<EncryptionState>` method “restores” the previous behaviour by calling `request_encryption_state` if necessary. The idea is that the caller is now responsible to call `request_encryption_state` if desired, or use `latest_encryption_state` to automate the call if necessary. `encryption_state` is now non-async and infallible everywhere. `matrix-sdk-ffi` has been updated but no methods have been added for the moment.
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.
Status
The library is considered production ready and backs multiple client implementations such as Element X [1] [2] and Fractal. Client developers should feel confident to build upon it.
Development of the SDK has been primarily sponsored by Element though accepts contributions from all.
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.