* Add a `feature = "compat"` workaround for Element failing on `GET /_matrix/client/r0/account/3pid` response if the optional `threepids` field is missing -----BEGIN PGP SIGNATURE----- iIwEABYIADQWIQSYRl0lv78dXawPPq7MFU3g4wt8ZwUCYUnGGxYcanBsYXR0ZStn aXRAcG9zdGVvLmRlAAoJEMwVTeDjC3xnXEAA/jR+Jn+XK1TFLY4OhLym8VN+4mxb YLTg0p5mAsyqSXB8AQCXGpCjyYzV1bBFYRx8J2KMTTt0zWwqYRbsCsrUyP2vDQ== =LUOM -----END PGP SIGNATURE----- gpgsig -----BEGIN PGP SIGNATURE----- iIwEABYIADQWIQSYRl0lv78dXawPPq7MFU3g4wt8ZwUCYUnHmxYcanBsYXR0ZStn aXRAcG9zdGVvLmRlAAoJEMwVTeDjC3xnn00A/04e0hPc/cnl5Lzb8Tvy6Xmzc/6W hmRfZdcABHGX0eV7AP4xO/LAeS5qVMfwCo8X0ypPLul+PK9faWgeR0O337ZjAw== =Skqn -----END PGP SIGNATURE----- Merge tag 'ruma-client-api-0.12.3' ruma-client-api 0.12.3 * Add a `feature = "compat"` workaround for Element failing on `GET /_matrix/client/r0/account/3pid` response if the optional `threepids` field is missing
Ruma – Your home in Matrix.
A set of Rust crates (libraries) for interacting with the Matrix chat network.
website • chat • documentation (unstable)
Getting started
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 ruma
to your
dependencies:
# crates.io release
ruma = { version = "0.3.0", features = [...] }
# git dependency (the next branch contains some breaking changes main doesn't)
ruma = { git = "https://github.com/ruma/ruma", branch = "next", features = [...] }
ruma
re-exports all of the other crates, so you don't have to worry about
them. Check out the documentation on docs.rs (or on
docs.ruma.io if you use use the git dependency).
Status
As of 2021-08-17, we support the entirety of the latest released versions of
the various Matrix APIs. Various popular MSCs are also implemented, gated behind
the unstable-pre-spec
Cargo feature.
Contributing
See CONTRIBUTING.md.
Minimum Rust version
Ruma currently requires Rust 1.50. 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.
ruma-signatures
is an exception: It uses cryptographic libraries that often
use relatively new features and that we don't want to use outdated versions of.
It is guarateed to work with whatever is the latest stable version though.