matrix-org
/
matrix-rust-sdk
mirror of https://github.com/matrix-org/matrix-rust-sdk.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Matrix Client-Server SDK for Rust
3,792 Commits 95 Branches 93 Tags 94 MiB
Rust 99.8%
Go to file
Benjamin Kampmann a5875ff75d ci: update codecov config to exclude all testing crates 2022-08-02 10:59:18 +02:00
.cargo Enable rustdoc-map nightly feature via .cargo/config.toml 2022-06-13 14:30:10 +02:00
.github/workflows Merge remote-tracking branch 'origin/main' into gnunicorn/issue833 2022-08-02 10:32:09 +02:00
benchmarks Merge remote-tracking branch 'origin/main' into gnunicorn/issue833 2022-08-01 13:28:28 +02:00
bindings chore(bindings/ffi): Print each step when building XCFramework. 2022-07-28 13:37:02 +02:00
contrib Merge branch 'dkasak/key-sharing-algorithm-rendering' 2021-10-11 09:46:43 +02:00
crates fix: fix path to testing crate 2022-08-02 10:58:53 +02:00
labs Merge remote-tracking branch 'origin/main' into gnunicorn/issue756 2022-07-27 12:04:56 +02:00
testing Merge remote-tracking branch 'origin/main' into gnunicorn/issue833 2022-08-02 10:32:09 +02:00
xtask ci(xtask): bump wasm timeout to make the ci pass 2022-07-27 16:58:20 +02:00
.editorconfig build: Adding .editorconfig 2022-08-01 14:33:05 +02:00
.gitignore Add basic AuthenticationService to the FFI. 2022-07-04 16:55:50 +01:00
.pre-commit-config.yaml Apply suggestions from code review 2022-05-02 11:43:37 +02:00
.rustfmt.toml doc: Make rustfmt format code blocks in documentation 2022-07-28 20:06:12 +02:00
.typos.toml fix(crypto): Fix a bunch of typos 2021-11-17 13:01:58 +01:00
CONVENTIONAL_COMMITS.md doc: Fix formatting. 2022-07-21 15:47:00 +02:00
Cargo.toml Merge remote-tracking branch 'origin/main' into gnunicorn/issue833 2022-08-01 13:28:28 +02:00
LICENSE rust-sdk: Switch the license to Apache 2.0. 2020-02-21 16:54:05 +01:00
README.md doc(bindings): Mention bindings in the top `README.md` file. 2022-06-23 15:12:51 +02:00
RELEASE-NOTES-0.5.md docs: Adding release notes for 0.5.0 2022-05-11 18:16:44 +02:00
codecov.yaml ci: update codecov config to exclude all testing crates 2022-08-02 10:59:18 +02:00
tarpaulin.toml ci(coverage): Set the correct out format for CI coverage reports 2022-06-14 12:01:03 +02:00

README.md

Build Status codecov License #matrix-rust-sdk Docs - Main 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.

Minimum Supported Rust Version (MSRV)

These crates are built with the Rust language version 2021 and require a minimum compiler version of 1.60

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.

License

Apache-2.0