mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-09 08:27:32 -04:00
7856dab56d
This introduces the `TimelineFocus`, a new enum to declare if the timeline is "live" aka looking at events from sync and displaying them as they come in, or focused on an event (e.g. after clicking a permalink). When in the second mode, the timeline can paginate forwards and backwards, without interacting with the event cache (as this would require some complicated reconciliation of known events with events received from pagination, with no guarantee that those events are event connected in whatever way). An event-focused timeline will also show edits/reactions/redactions in real-time (as the events are received from the sync), but will not show new timeline items, be they for local echoes or events received from the sync.
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.