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,841 Commits 101 Branches 93 Tags 93 MiB
Rust 99.8%
Go to file
Jonas Platte ce973b35e9 chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
.cargo chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
.config fix: Apply redactions to room state events in database, too (#917) 2022-09-27 09:24:53 +02:00
.github chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
benchmarks refactor: Use workspace dependencies for more crates 2023-01-10 10:19:02 +01:00
bindings chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +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 doc(sdk): Fix docs that refer to TimelineKey 2023-02-02 10:15:05 +01:00
examples chore(deps): bump tokio from 1.22.0 to 1.23.1 2023-01-07 14:06:32 +01:00
labs refactor(sdk): Expose event sending errors through timeline item 2023-02-02 10:14:23 +01:00
testing fix(sliding-sync): catching up on new count for full-sync views 2023-01-31 15:02:19 +00:00
uniffi-bindgen chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
xtask chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
.editorconfig build: Adding .editorconfig 2022-08-01 14:33:05 +02:00
.gitignore feat(bindings): Generate a Package.swift in xtask 2022-12-12 18:04:15 +01: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 docs: Add the `ffi` scope. 2023-01-27 14:58:54 +01:00
Cargo.lock chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
Cargo.toml chore: Upgrade uniffi to 0.23.0 2023-02-02 10:15:05 +01:00
LICENSE rust-sdk: Switch the license to Apache 2.0. 2020-02-21 16:54:05 +01:00
README.md chore: Fix our build badge 2022-12-22 11:26:29 +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