mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-07 23:44:53 -04:00
508f1bc976
The comments in the code should explain the general approach, but to give an overview: We assign a unique sequence number to each device-list-invalidation notice, and keep track of the sequence number at which each user was most recently invalidated. Then, when we build a `/keys/query` request, we take note of the current sequence number. Finally, when we get the response from that `/keys/query` request, we compare that sequence number with the most-recent-invalidation of each user that is now supposedly up-to-date. All of that means that we can see if the user has been invalidated *since* we built the `/keys/query` request, in which case our request may have raced against the new device, so we do not mark the user as up-to-date. To make that work, we need to keep track of the sequence number for in-flight `/keys/query` requests; we do that in the `IdentityManager`. Since there should only ever be at most one batch of requests in flight, that is relatively easy; however, we also record the request ids just to check that the application isn't doing something weird. There is no need to persist the sequence numbers to permanent storage: provided the `IdentityManager` and `Store` objects have a lifetime at least as long as an in-flight `/keys/query` request, it is sufficient just to retain the `dirty` bit in permanent storage, and then, when we reload the ephemeral `Store` cache, to treat everything with a `dirty` bit as a "new" invalidation. Fixes: #1386.
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.