mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-15 03:25:46 -04:00
9411801245
This patch removes the `decode_image` (default) feature for this `matrix-sdk-qrcode` crate. First reason is that `rqrr` panics for some particular QR codes, and we don't want to panic. Second reason is that it's not a feature that is used. For Element on iOS and Android, it's very unlikely that every frame from the camera will be sent to `matrix-sdk-qrcode` to see if it can be decoded. So it's obvious that an external library is used to read the bytes from the QR code, that are then sent to `matrix-sdk-qrcode`. For Element on Web, it's basically the same argument. This feature is actually used only in our tests to ensure the generated QR code is valid, but it sometimes fails due to `rqrr` (cf. First reason).
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.60
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.