mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-15 11:36:07 -04:00
3db72101f3
* sdk: Allow to update notification settings * Add an event listener for push rule events * Fix: simplify insertion and deletion of rules * Fix: Limit rules cloning * Fix: Unit tests * Fix: set_room_notification_mode * Fix: potential race condition when updating the local ruleset * Refactor RuleCommands * RuleCommands Unit Tests * Fix: limit lock usage * nit: use expression assignment by default * nit: pass Ruleset by ownership in RuleCommands' ctor * a few nits: use to_owned() for &str -> String; use free function for notify actions; use clone() where it's more obvious and use explicit variants so we know we have to consider this match if we were to add a new variant later * nit: rename RuleCommands::set_enabled to set_enabled_internal * nit: test modules don't need to be publicized * tidy tests * nit: pass an owned RuleCommands in Rules::apply * add comments/questions in Rules tests * nit: no need to publicize the tests module * tweak NotificationSettings tests too * rustfmt --------- Co-authored-by: Benjamin Bouvier <public@benj.me>
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.