Fork of github.com/matrix-org/matrix-rust-sdk
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Charlotte Som d83d8b959c fix(sdk): Implement SyncEvent for SyncRedactionEvent 1 month ago
.cargo Use rustdoc-map to link to external crates in master docs 4 months ago
.github/workflows chore: Rename the crate folders to use dashes instead of underscores 1 month ago
contrib/mitmproxy contrib: Make the failures mitmproxy script a bit smarter. 8 months ago
crates fix(sdk): Implement SyncEvent for SyncRedactionEvent 1 month ago
.gitignore matrix_sdk_crypto: Fix clippy warnings add wasm emscripten to .gitignore 1 year ago
.pre-commit-config.yaml nio-rust: Add a pre-commit config. 2 years ago
.rustfmt.toml Add cargo fmt to ci using nightly 5 months ago
Cargo.toml chore: Sort the deps in our Cargo.toml files 1 month ago
LICENSE rust-sdk: Switch the license to Apache 2.0. 2 years ago
README.md README: Add a badge that points to the latest master docs 8 months ago
tarpaulin.toml tarpaulin: Disable tarpaulin debugging. 1 year ago

README.md

Build Status codecov License #matrix-rust-sdk Docs - Master Docs - Stable

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