mirror of
https://github.com/matrix-org/matrix-rust-sdk.git
synced 2026-05-14 11:05:32 -04:00
7f07ac52ef
The `OlmMachine` constructor now has 2 more optional arguments: `store_name` and `store_passphrase`, to use Indexed DB as the backend to store the Olm machine keys, rather than having an in-memory Olm machine. Node.js is used to test our binding. Indexed DB is absent of Node.js. So, firstly, we are using the `fake-indexeddb` JavaScript library to mimic the same API inside Node.js. And, secondly, we use our own fork of the `indexed_db_futures` Rust crate to provide add support for Node.js too ([PR is here](https://github.com/Alorel/rust-indexed-db/pull/11)). It basically looks in the Node.js global environment if the `indexedDB` getter is present, just like it is already done for `Window` on any browser, or `WorkerGlobalScope` for workers.
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.