mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-09 16:34:32 -04:00
8a1ff1967f
This patch implements a new method: `RoomListService::sync_indicator`. It returns a `impl Stream<Item = SyncIndicator>` where `SyncIndicator` is a new enum with 2 variants: `Show` and `Hide`. `SyncIndicator` is the UI equivalent of a sync spinner/loader/toaster, that the app might want to show to the user to indicate when a _first_ request is sent and might be slow, i.e. the first response is taking a little bit of time to come. The term _first_ may be innapropriate as it covers the actual first sync request, but also the recovering sync request. It means that when a sync error happened, the sync indicator will be shown too, which is a pretty useful information for the user. It's not because a `SyncIndicator` should be shown that it must be send immediately onto the `Stream`. In case of a normal network conditions, without any delay, it can lead to a “blinking” visual effect. Some constants configure how long it takes to consider that a request is “slow”, and that the `SyncIndicator` is necessary to be shown (or hidden).
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.