Matrix Client-Server SDK for Rust
Go to file
Damir Jelić 6aff4fc2c0
Update the bindings to use the SAS signalling (#1300)
* feat(bindings): Expose support for manually starting SAS verifications

Co-authored-by: Stefan Ceriu <stefanc@matrix.org>
2023-01-06 10:20:40 +01:00
.cargo
.config fix: Apply redactions to room state events in database, too (#917) 2022-09-27 09:24:53 +02:00
.github ci: Specify which version of wasm-pack we want 2022-12-22 16:06:48 +01:00
benchmarks refactor(sled)!: Rename SledCryptoStore::{open_with_passphrase => open} 2022-12-07 11:16:25 +01:00
bindings Update the bindings to use the SAS signalling (#1300) 2023-01-06 10:20:40 +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 feat(sdk): Add pagination loading indicator as a virtual timeline item 2023-01-06 09:48:44 +01:00
examples feat(sdk): Implement IntoFuture for LoginBuilder and SsoLoginBuilder 2022-12-07 11:13:44 +01:00
labs Updated jack-in README.md for full-sync-mode lowercase options 2023-01-04 12:38:54 +01:00
testing refactor: Don't reserialize member events before storing them 2022-12-15 18:19:35 +01:00
xtask feat(bindings): Generate a Package.swift in xtask 2022-12-12 18:04:15 +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 doc: Fix formatting. 2022-07-21 15:47:00 +02:00
Cargo.lock chore(labs): Use clap instead of structopt for jack-in 2023-01-04 12:49:50 +01:00
Cargo.toml fix(sdk): Handle to-device sliding sync extension correctly 2023-01-02 18:00:38 +00:00
LICENSE
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