ruma

ruma – 你在 Matrix 中的家。

一组用于与 Matrix 聊天网络交互的 Rust 箱（库）。

网站 • 聊天 • 文档（不稳定）

入门

如果您想构建 Matrix 客户端或机器人，请查看matrix-rust-sdk。它建立在ruma的基础上，包括状态存储的处理、端到端加密和许多其他有用的东西。

对于家庭服务器、网桥和与 Matrix 配合使用的难以分类的软件，您来对地方了。首先，将ruma添加到您的依赖项中：

ruma = { version = "0.11.0", features = ["..."] } # git dependency ruma = { git = "https://github.com/ruma/ ruma ", branch = "main", features = ["..."] }">

 # crates.io release
ruma = { version = " 0.11.0 " , features = [ " ... " ] }
# git dependency
ruma = { git = " https://github.com/ruma/ ruma " , branch = " main " , features = [ " ... " ] }

ruma重新导出所有其他板条箱，因此您作为用户不必担心它们。查看 docs.rs 上的文档（如果您使用 git 依赖项，则查看ruma .dev 上的文档）。

您还可以在我们的专用示例存储库中找到少量示例。

地位

ruma 0.11.0 支持 Matrix 1.12 的所有事件和 REST 端点。

还实施了正在进行的或已完成的 MSC 的各种更改，这些更改位于unstable-mscXXXX （其中XXXX是 MSC 编号）Cargo 功能的后面。

一些不太正式的东西被隐藏在unstable-unspecified Cargo 功能后面。

贡献

请参阅 CONTRIBUTING.md。

最低 Rust 版本

ruma目前需要 Rust 1.75。一般来说，我们永远不会要求 crates.io 发布我们的 crate 时需要 beta 或 nightly，并且我们将尽量避免发布依赖于刚刚稳定的功能的 crate。

ruma -signatures是一个例外：它使用的加密库通常使用相对较新的功能，并且我们不想使用过时的版本。不过，它保证可以与最新的稳定版本一起使用。

执照

麻省理工学院