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
4,517 Commits 100 Branches 93 Tags 92 MiB
Rust 99.8%
Go to file
Jonas Platte f92153757b chore: Add CONTRIBUTING.md 
… and move the testing section from README.md into it.
 		2022-12-05 14:58:33 +01:00
.cargo Enable rustdoc-map nightly feature via .cargo/config.toml 2022-06-13 14:30:10 +02:00
.config fix: Apply redactions to room state events in database, too (#917) 2022-09-27 09:24:53 +02:00
.github/workflows chore: Fix a typo, upgrade typo check action 2022-11-24 22:36:46 +01:00
benchmarks chore: Bump MSRV to 1.65 2022-11-15 14:57:46 +01:00
bindings fix(bindings): Change the is_syncing method to read the correct value 2022-12-05 14:16:01 +01:00
contrib chore(contrib): Mitmproxy 9 has removed the HTTP prefix from the Response type 2022-11-17 12:43:56 +01:00
crates chore: Fix a clippy warning 2022-12-05 14:16:01 +01:00
examples chore: Upgrade Ruma 2022-11-29 15:37:18 +01:00
labs feat(sliding-sync): Offline caching for Sliding Sync & session recovery (#1193) 2022-11-28 18:01:04 +00:00
testing doc: Hint towards test execution 2022-11-29 23:38:31 +01:00
xtask chore: Appease clippy 2022-11-24 13:43:09 +01:00
.editorconfig build: Adding .editorconfig 2022-08-01 14:33:05 +02:00
.gitignore chore: Ignore Swift's .build folder 2022-09-30 21:54:09 +02:00
.rustfmt.toml chore: Add rust.vim edition workaround 2022-09-22 10:38:17 +02:00
.typos.toml ci: Stop ignoring .lock files in typos config explicitly 2022-09-01 09:33:40 +02:00
CONTRIBUTING.md chore: Add CONTRIBUTING.md 2022-12-05 14:58:33 +01:00
CONVENTIONAL_COMMITS.md doc: Fix formatting. 2022-07-21 15:47:00 +02:00
Cargo.lock feat(indexeddb): Update to `indexed_db_futures` 0.3.0. 2022-12-05 14:16:01 +01:00
Cargo.toml chore: Upgrade Ruma 2022-11-29 15:37:18 +01:00
LICENSE rust-sdk: Switch the license to Apache 2.0. 2020-02-21 16:54:05 +01:00
README.md chore: Add CONTRIBUTING.md 2022-12-05 14:58:33 +01:00
UPGRADING-0.5-to-0.6.md chore: fix typos in Upgrade guide 2022-09-28 17:07:37 +02:00
codecov.yaml ci: update codecov config to exclude all testing crates 2022-08-02 10:59:18 +02:00
tarpaulin.toml chore: Exclude xtask from tarpaulin coverage collection 2022-10-17 15:38:42 +01: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.65.

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