#matrix #chat #messaging #ruma


Procedural macros for creating Matrix identifiers

10 releases

new 0.19.2 Jun 10, 2021
0.19.1 May 16, 2021
0.19.0 Apr 13, 2021
0.18.1 Apr 3, 2021
0.17.1 Jul 29, 2020

#165 in Network programming

Download history 31/week @ 2021-02-19 28/week @ 2021-02-26 28/week @ 2021-03-05 17/week @ 2021-03-12 46/week @ 2021-03-19 33/week @ 2021-03-26 70/week @ 2021-04-02 72/week @ 2021-04-09 57/week @ 2021-04-16 66/week @ 2021-04-23 27/week @ 2021-04-30 11/week @ 2021-05-07 445/week @ 2021-05-14 999/week @ 2021-05-21 860/week @ 2021-05-28 1568/week @ 2021-06-04

1,419 downloads per month
Used in 23 crates (via ruma-identifiers)

MIT license

307 lines

Ruma – Your home in Matrix.

A set of Rust crates (libraries) for interacting with the Matrix chat network.

websitechatunstable documentation

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 (as a git dependency if you want all of the latest improvements).

ruma re-exports all of the other crates, so you don't have to worry about them. Check out docs.ruma.io for the latest documentation including which Cargo features you have to enable for the functionality you want. If you are using a released version from crates.io, you can also find versioned documentation on docs.rs.


As of 2021-05-06, we support the vast majority of endpoints in all of the various Matrix APIs, the notable exception being the identity service API, where a few endpoints are still missing.



Minimum Rust version

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:

  • ruma-signatures (and hence ruma with the federation-api feature) since it depends on ring, which is only guaranteed to work on the latest stable.
  • ruma-client depends on some I/O libraries (and also on ring, conditionally), so it is also only guaranteed to work on the latest stable.




~19K SLoC