Fork of github.com/matrix-org/matrix-rust-sdk
 
 
Go to file
Denis Kasak eeebb43e32 Move mutating methods from RoomMember to Room.
The `update_profile` method cannot live in `RoomMember` since that
operation needs information which only exists in `Room` (for instance,
it needs other members in order to perform display name disambiguation).

Leaving other mutating methods on `RoomMember` (like `update_power` and
`update_presence`) then seemed illogical so they were all moved into
`Room`.

In addition, a small refactoring was done to remove
`did_update_presence` and `update_presence` since their existence
doesn't make much sense anymore and it saves us from repeating work.
Their function is now done in `receive_presence_event`.

Also, several docstrings were corrected and reworded.
2020-07-10 11:08:38 +02:00
matrix_sdk matrix-sdk: Remove an unused import. 2020-06-26 18:21:44 +02:00
matrix_sdk_base Move mutating methods from RoomMember to Room. 2020-07-10 11:08:38 +02:00
matrix_sdk_common matrix-sdk: Fix the author field in the cargo files. 2020-06-15 09:47:13 +02:00
matrix_sdk_common_macros Commit missing matrix_sdk_common_macros folder 2020-06-17 19:08:26 +02:00
matrix_sdk_crypto crypto: Simplify the group session pair creation. 2020-06-25 13:31:30 +02:00
matrix_sdk_test Add test and example event to ensure display name changes work correctly. 2020-07-03 15:35:54 +02:00
matrix_sdk_test_macros matrix-sdk: Add a bunch of readmes to the crates. 2020-05-26 19:33:13 +02:00
.gitignore Fix the gitignore file. 2019-11-24 22:44:28 +01:00
.pre-commit-config.yaml nio-rust: Add a pre-commit config. 2019-11-10 18:33:27 +01:00
.travis.yml travis: fail-fast for wasm target 2020-05-13 14:48:46 +02:00
Cargo.toml Do wasm sepcific changes: 2020-06-17 18:57:39 +02:00
LICENSE rust-sdk: Switch the license to Apache 2.0. 2020-02-21 16:54:05 +01:00
Makefile matrix-sdk: Split out the crypto part of the sdk into a separate crate. 2020-04-29 09:48:00 +02:00
README.md matrix-sdk: Add a bunch of readmes to the crates. 2020-05-26 19:33:13 +02:00
design.md state_store: clean up and add examples to docs 2020-04-26 17:13:55 -04:00

README.md

Build Status codecov License #matrix-rust-sdk

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.

License

Apache-2.0