A set of Rust crates for interacting with the Matrix chat network.
If you want to build a Matrix client or bot, have a look at matrix-rust-sdk. It builds on Ruma and includes handling of state storage, end-to-end encryption and many other useful things.
For homeservers, bridges and harder-to-categorize software that works with Matrix, you're at the right place. To get started, add
rumato your dependencies (as a git dependency if you want all of the latest improvements), enable all Cargo features that seem relevant and run
cargo doc -p ruma --open. The
rumacrate re-exports all relevant things, except for
ruma-client, which you can use to make client-API calls to a Matrix homeserver¹.
If you use the crates through crates.io, make sure to choose versions of
ruma-clientthat depend on the same / compatible versions of the other crates (checking one, for example
ruma-common, is enough though). At the time of writing the latest versions are
ruma-client 0.5.0-alpha.1, which can be used together.
If you're using the crates through git, just use the same
branchif you want to control the exact version only through
Cargo.lock) for both.
This may seem a little convoluted, that's because it is. We're working on it.
¹ (better) support for the other APIs is planned
As of 2021-01-19, we support the vast majority of endpoints in all of the various Matrix APIs except the identity service API (if you want to help with that, have a look at the crate/ruma-identity-service-api label).
Ruma currently requires Rust 1.45. In general, we will never require beta or nightly for crates.io releases of our crates, and we will try to avoid releasing crates that depend on features that were only just stabilized.
There are two exceptions to this: