mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-14 11:05:32 -04:00
3a25608a6e
A `SlidingSyncList` has a state, which can be either `NotLoaded`, `Preloaded`, `PartiallyLoaded`, or `FullyLoaded`. A `SlidingSyncList` can be reset, either manually when `SlidingSyncList::reset` is called, or when a range is updated for example. Resetting a list is modifying its state. Prior to this patch, the state was set to `NotLoaded`. However, it's not entirely true. This patch updates this behavior to the following rules: * When the state is `NotLoaded`, it's kept at this state as nothing has happened yet, * When the state is `Preloaded`, the list is restored from the cache, but nothing has happened yet too, so it's kept at this state, * When the state is `PartiallyLoaded` or `FullyLoaded`, it means some (or all) updates have been done, so the new state is `PartiallyLoaded` after the reset. The list' state is used mostly by the client to know whether a loader should be prompted to the users. The ranges are modified when the users scroll inside the room list for example: scrolling in the room list doesn't imply the state should go to `NotLoaded`. Some data have potentially be loaded, so changing the ranges should result in a `PartiallyLoaded` state. It seems more logical once explained like this.
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.