mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-08 16:04:13 -04:00
8ea2cef55d
This patch is trying to resolve the following issue: When a local event is sent to the server, in case of an error, the `Timeline::send` method just returned the error but it wasn't reflected inside the `LocalEventTimelineItem` type itself. It's easy to loss this information. So now, there is a new enum: `LocalEventTimelineItemSendState` with 3 states: 1. `NotSentYet`, when the local event has not been sent yet, it's theorically the initial state, 2. `SendingFailed`, when the local event has been sent but it's failed! 3. `Sent`, when the local event has been sent successfully. Therefore, the `LocalEventTimelineItem` struct has a new field: `send_state`. The send state is managed by its `with_event_id` method which now receives an `Option<OwnedEventId>` (prev. `OwnedEventId` directly): * If it's `Some(_)`, then it means we got a successful response from the server after the sending, so the send state is set to `Sent`, * If it's `None`, then it means we got an error response from the server, so the send state is set to `SentFailed`. (A small change: The method `TimelineInner::add_event_id` has been renamed `TimelineInner::update_event_id_of_local_event`.) The `Timeline::send` still returns a `Result`, but the server's response is passed to a new method: `TimelinerInner::handle_local_event_send_response` (it's logically named after the `handle_local_event` method), which is responsible to call `TimelineInner:update_event_id_of_local_event` (which was previously called directly by `Timeline::send`). And `TimelineInner::update_event_id_of_local_event` was already calling `LocalEventTimelineItem::with_event_id`. So everything works like a charm here. The local send state is closely managed by `LocalEventTimelineItem`, I hope it will avoid state breakage as much as possible.
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.