ruma

ruma – マトリックスのあなたの家。

Matrix チャット ネットワークと対話するための Rust クレート (ライブラリ) のセット。

Web サイト、チャット、ドキュメント (不安定)

はじめる

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 ) のドキュメントを確認してください。

専用のサンプル リポジトリで少数のサンプルを見つけることもできます。

状態

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 リリースにベータ版やナイトリーを要求することは決してありません。また、安定したばかりの機能に依存するクレートのリリースは避けるように努めます。

ruma -signaturesは例外です。これは、比較的新しい機能を使用することが多く、古いバージョンを使用したくない暗号化ライブラリを使用します。ただし、最新の安定バージョンであれば動作することが保証されています。

ライセンス

マサチューセッツ工科大学