ruma

用于处理 Matrix 协议的类型和特质。

此 crate 从其他所有 ruma crate 中重新导出内容，因此您无需手动保持所有版本同步。

可以通过 cargo 特性配置要重新导出的 crate。根据您对 Matrix 的相关部分，激活以下特性

• client-api 用于客户端-服务器 API
• federation-api 用于服务器-服务器（联盟）API
• appservice-api 用于应用服务 API

lib.rs:

用于处理 Matrix 协议的类型和特质。

此 crate 从其他所有 ruma crate 中重新导出内容，因此您无需手动保持所有版本同步。

可以通过 cargo 特性配置要重新导出的 crate。

⚠ 由于 rustdoc 在处理重新导出时可能存在问题，因此可能需要参考其他 crate 的文档。

🛈 为了内部一致性，Ruma 使用美国英语拼写变量名。在序列化表示中，名称可能不同，因为 Matrix 规范中混合了英国英语和美国英语。

API 特性

根据您对 Matrix 的相关部分，激活以下特性

• appservice-api -- 应用服务 API。
• client-api -- 客户端-服务器 API。
• federation-api -- 服务器-服务器（联盟）API。
• identity-service-api -- 身份服务 API。
• push-gateway-api -- 推送网关 API。

这些特性有 client- 和 server-优化的变体，分别通过 -c 和 -s 后缀启用。例如

• client-api-c -- 优化客户端的客户端-服务器API。
• client-api-s -- 优化服务端客户端-服务器API。

兼容性功能

• compat -- 以偏离规范为代价，增加与Matrix生态系统其他部分的兼容性。

便利功能

这些功能只有在需要使用它们的方法时才有用

• rand -- 生成随机标识符。
• markdown -- 解析Markdown以构建消息。
• html -- 解析HTML以净化它或导航其树。
  • html-matrix -- 启用ruma-html中的matrix功能，按照Matrix规范将HTML元素数据解析为类型化数据。

不稳定功能

使用这些功能意味着您放弃Ruma提供的一切semver保证

• unstable-exhaustive-types -- Ruma中的大多数类型都被标记为非穷尽，以避免在规范中添加新字段时造成破坏性变化。此功能将所有类型编译为穷尽。
• unstable-mscXXXX，其中XXXX是MSC编号 -- 可能会发生变化或删除的即将到来的Matrix功能。
• unstable-unspecified -- 可能会发生变化或删除的未记录的Matrix功能。

常用功能

这些子模块通常在需要时由API功能激活

• api
• events
• signatures

ruma-client功能

当激活client功能时，ruma::client，并且client-ext-client-api激活ruma-client的client-api功能。所有其他不带client前缀的client-*功能激活相同的特征。有关这些功能的效果，请参阅文档。