Fork of github.com/matrix-org/matrix-rust-sdk
fa0a22b090
High-level summary of changes: - Rewrite the disambiguation algorithm to simplify it. - Fixes to state tracking, e.g. use `state_key` instead of `user_id` when determining which member an event is acting on. - Changes to `RoomMember`: * Make `RoomMember` "dumber" and don't let it mutate itself. This came about primarily because `update_profile` cannot live on `RoomMember` because it needs some information from `Room`. The other few mutating methods then looked odd so it seemed best to move them to `Room` so that the room takes care of updating its members. * Each `RoomMember` now contains all information to calculate its set of names: + `.name()` (short/ergonomic but potentially ambiguous), + `.unique_name()` (unique but may be contain MXID when not necessary), + `.disambiguated_name()` (shortest possible while being unique). - Add some logging using the `tracing` crate. - Improvements to `EventBuilder`: * Add a docstring. * Make it clear itself when building a sync response so the same builder can be reused for later sync responses. - A few tests. |
||
---|---|---|
matrix_sdk | ||
matrix_sdk_base | ||
matrix_sdk_common | ||
matrix_sdk_common_macros | ||
matrix_sdk_crypto | ||
matrix_sdk_test | ||
matrix_sdk_test_macros | ||
.gitignore | ||
.pre-commit-config.yaml | ||
.travis.yml | ||
Cargo.toml | ||
design.md | ||
LICENSE | ||
Makefile | ||
README.md |
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.
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.