mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-19 06:04:31 -04:00
5870dafe2e
This patch updates `Store::rooms` from a `Arc<StdRwLock<BTreeMap<OwnedRoomId, Room>>>` to a `Arc<StdRwLock<Rooms>>` where `Rooms` is a new type that mimics a `BTreeMap` but that is observable. It uses an `ObservableVector` for saving us the costs of writing a new `ObservableMap` type in `eyeball-im`. It would have too much implications that are clearly not necessary. The major one being that an `ObservableMap` must emit `MapDiff`, but we expect `VectorDiff` everywhere in the SDK where rooms are observable. It would break too many API and too many projects. The benchmark is coming, but here are the results (for 10'000 rooms, extreme case): * `get_rooms` and `get_rooms_filtered` are twice faster (in practise, it means 650µs is saved per call), * `get_room` and `get_or_create_room` are 10% slower (in practise, it means 8-10ns is lost per call). Overall, I believe these results are acceptable, and even an improvement for the first one.
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.