rust-system-event-driven

Rust のイベント駆動システムに関するベストプラクティス

Rust でイベント駆動システムをプログラミングするための包括的なベストプラクティスガイドです。8 つのカテゴリにわたる 42 のルールが、影響度順にまとめられており、非同期ランタイムの使用、チャネル通信、スレッド処理、ネットワーク、ターミナルの処理に役立ちます。

適用する場面

次のような場合に、これらのガイドラインを参照してください。

• Tokio または async-std を使って非同期アプリケーションを構築する場合
• ネットワークサーバーまたはクライアントを実装する場合
• ターミナルユーザーインターフェース（TUI）を作成する場合
• 並行タスクと共有状態を管理する場合
• Unix シグナルとグレースフルシャットダウンを処理する場合

優先度別のルールカテゴリ

優先度	カテゴリ	影響度	プレフィックス
1	非同期ランタイムのパターン	CRITICAL	async-
2	チャネル通信	CRITICAL	chan-
3	スレッド処理と同期	HIGH	sync-
4	ソケットとネットワーク I/O	HIGH	net-
5	ターミナルと TTY の処理	MEDIUM-HIGH	term-
6	シグナルとプロセス制御	MEDIUM	sig-
7	ファイル I/O ストリーミング	MEDIUM	io-
8	イベントループのアーキテクチャ	LOW-MEDIUM	loop-

クイックリファレンス

1. 非同期ランタイムのパターン（CRITICAL）

• async-spawn-blocking - CPU バウンドの処理には spawn_blocking を使用する
• async-select-biased - 優先度を扱うには biased select を使用する
• async-no-std-block - 非同期コンテキストでは std のブロッキング呼び出しを避ける
• async-cancellation-safe - キャンセルセーフな非同期操作を設計する
• async-task-local - リクエストコンテキストにはタスクローカルストレージを使用する
• async-structured-concurrency - 構造化並行性には JoinSet を使用する

2. チャネル通信（CRITICAL）

• chan-bounded-backpressure - バックプレッシャーには有界チャネルを使用する
• chan-oneshot-response - リクエストとレスポンスには oneshot チャネルを使用する
• chan-broadcast-fanout - ファンアウトには broadcast チャネルを使用する
• chan-watch-state - 共有状態には watch チャネルを使用する
• chan-graceful-shutdown - グレースフルシャットダウンにはチャネルのクローズを使用する

3. スレッド処理と同期（HIGH）

• sync-arc-mutex-shared - 変更可能な共有状態には Arc を使用する
• sync-rwlock-read-heavy - 読み取り負荷の高いワークロードには RwLock を使用する
• sync-atomic-counters - 単純なカウンターとフラグにはアトミックを使用する
• sync-avoid-lock-await - await をまたいで std Mutex を保持しない
• sync-semaphore-limit - 並行性の制限には Semaphore を使用する
• sync-parking-lot - 競合の激しいロックには parking_lot を使用する

4. ソケットとネットワーク I/O（HIGH）

• net-split-reader-writer - ソケットを読み取り側と書き込み側に分割する
• net-framing-codec - メッセージベースのプロトコルにはフレーミングを使用する
• net-connection-pool - 接続を繰り返す場合はコネクションプールを使用する
• net-timeout-all-io - すべてのネットワーク操作にタイムアウトを設定する
• net-tcp-nodelay - 低レイテンシのプロトコルでは TCP_NODELAY を設定する
• net-graceful-disconnect - グレースフルな接続終了を実装する

5. ターミナルと TTY の処理（中〜高）

• term-raw-mode-restore - 終了時に必ずターミナルの状態を復元する
• term-alternate-screen - 全画面アプリでは代替画面を使用する
• term-async-event-stream - ターミナル入力には非同期イベントストリームを使用する
• term-buffered-output - パフォーマンス向上のため、ターミナル出力をバッファリングする
• term-handle-resize - ターミナルのサイズ変更イベントを処理する

6. シグナルとプロセス制御（中）

• sig-ctrl-c-graceful - Ctrl-C を処理して正常にシャットダウンする
• sig-unix-signals - Unix シグナルを非同期で処理する
• sig-child-reap - ゾンビプロセスを防ぐため、子プロセスを回収する
• sig-timeout-shutdown - 強制終了するためのシャットダウンタイムアウトを設定する

7. ファイル I/O ストリーミング（中）

• io-async-file-ops - 非同期コンテキストでは非同期ファイル操作を使用する
• io-stream-large-files - 大きなファイルはすべて読み込まず、ストリーミングする
• io-copy-bidirectional - プロキシ処理には copy_bidirectional を使用する
• io-pipe-communication - プロセス間通信にはパイプを使用する
• io-flush-before-read - 応答を待つ前に書き込みをフラッシュする

8. イベントループのアーキテクチャ（低〜中）

• loop-actor-model - 状態を持つコンポーネントにはアクターパターンを使用する
• loop-event-types - 動的ディスパッチではなく、型付きイベントを使用する
• loop-state-machine - プロトコルの状態を型安全なステートマシンとしてモデル化する
• loop-layered-architecture - I/O とビジネスロジックを分離する
• loop-cancellation-token - 協調的なシャットダウンには CancellationToken を使用する

使用方法

詳しい説明とコード例については、各リファレンスファイルを参照してください。

• セクションの定義 - カテゴリ構成と影響度
• ルールテンプレート - 新しいルールを追加するためのテンプレート

リファレンスファイル

ファイル	説明
references/_sections.md	カテゴリの定義と順序
assets/templates/_template.md	新しいルール用のテンプレート
metadata.json	バージョンとリファレンス情報