Fork of github.com/matrix-org/matrix-rust-sdk
 
 
Go to file
Damir Jelić 137fa9619f matrix-sdk: Add the ability to stop the sync loop and rename the sync methods.
This renames our sync methods so it's clearer which one the main one is.
Syncing should be done with the sync method, if one wishes to sync only
once the sync_method is provided.

If one wishes to have a callback called with every sync the
sync_with_callback method exists, the callback now returns a boolean
that signals if the loop should be aborted. This does not mean that the
current sync request will abort, a cancelable future is still needed for
this.
2020-10-06 11:37:29 +02:00
matrix_sdk matrix-sdk: Add the ability to stop the sync loop and rename the sync methods. 2020-10-06 11:37:29 +02:00
matrix_sdk_base Export "unstable-synapse-quirks" feature from ruma 2020-09-22 21:03:12 +02:00
matrix_sdk_common Export "unstable-synapse-quirks" feature from ruma 2020-09-22 21:03:12 +02:00
matrix_sdk_common_macros matrix-sdk: Expose the import/export keys methods. 2020-09-11 16:34:39 +02:00
matrix_sdk_crypto Merge branch 'crypto-improvements' into master 2020-09-23 11:07:49 +02:00
matrix_sdk_test matrix-sdk: Add a convenience method to get our own devices. 2020-09-05 18:04:15 +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 matrix_sdk_crypto: Fix clippy warnings add wasm emscripten to .gitignore 2020-08-04 20:02:09 -04:00
.pre-commit-config.yaml nio-rust: Add a pre-commit config. 2019-11-10 18:33:27 +01:00
.travis.yml Fix travis ci errors 2020-08-21 19:11:10 +02:00
Cargo.toml matrix-sdk: Upgrade our deps. 2020-08-11 16:54:58 +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
tarpaulin.toml tarpaulin: Disable tarpaulin debugging. 2020-08-11 10:55:10 +02: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