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,205 Commits 100 Branches 93 Tags 92 MiB
Rust 99.8%
Go to file
Benjamin Kampmann 91d1ee9f09 chore: fix typos in Upgrade guide 2022-09-28 17:07:37 +02: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 fix: Apply redactions to room state events in database, too (#917) 2022-09-27 09:24:53 +02:00
benchmarks chore: Version bump 2022-09-28 17:07:37 +02:00
bindings chore: Version bump 2022-09-28 17:07:37 +02:00
contrib Merge branch 'dkasak/key-sharing-algorithm-rendering' 2021-10-11 09:46:43 +02:00
crates chore: Version bump 2022-09-28 17:07:37 +02:00
examples chore: Version bump 2022-09-28 17:07:37 +02:00
labs chore: Version bump 2022-09-28 17:07:37 +02:00
testing chore: Version bump 2022-09-28 17:07:37 +02:00
xtask refactor!: Move JS-specific functionality behind a Cargo feature 2022-09-20 14:08:21 +02:00
.editorconfig build: Adding .editorconfig 2022-08-01 14:33:05 +02:00
.gitignore feat: implement " MSC 3575: sliding sync " behind a feature flag (#728) 2022-09-15 11:45:29 +00: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
CONVENTIONAL_COMMITS.md doc: Fix formatting. 2022-07-21 15:47:00 +02:00
Cargo.lock chore: Version bump 2022-09-28 17:07:37 +02:00
Cargo.toml refactor: move examples from crates/matrix-sdk into separate crates in examples/ 2022-08-02 15:06:04 +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
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 ci: Don't collect coverage for labs 2022-09-19 12:15:13 +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