API リファレンス
ワークスペース内のすべての公開型に対する完全な rustdoc であり、各型、関数、モジュールの /// コメントから自動生成されます。構造体の正確な構造、トレイトのメソッド、または関数の戻り値を知る必要があるときにこれを使用してください。生成されたリファレンスが文章よりもうまく公開している情報すべてに対応します。
操作方法
- rustdoc インデックスには、ワークスペース内のすべてのクレートが一覧表示されます。共有トレイトのコントラクトと境界型を確認するには、
zeroclaw-apiを開いてください。 - 公開名を見つけるには、rustdoc の検索ボックス、キーボード検索、または All Items を使用してください。ブラウザーの検索では、現在レンダリングされているページだけが検索されます。
- トレイトをクリックすると、そのメソッドと既知の実装者が表示されます。
コントラクト境界
zeroclaw-api は共有境界型とトレイト定義を所有します。具体的な実装はそれぞれのケイパビリティクレートに配置し、そのサーフェスにある既存の構築境界を介して接続します。コンシューマーは具体型ではなく、該当するトレイトに依存します。
trait 定義は、メソッド、デフォルト、および型の正確な仕様に関する正式な情報源です。生成された rustdoc は、それらを基に構築されたナビゲーション可能なリファレンスです。選定された拡張ファミリーについては Architecture → Overview を、承認された trait 主導の境界に関する決定については ADR-002 を参照してください。
クレートのインデックス
| クレート | 公開される内容 |
|---|---|
zeroclaw | 再エクスポートを含むトップレベルの umbrella |
zeroclaw-api | 共有境界型とファーストパーティ拡張トレイト |
zeroclaw-config | 設定スキーマ、自律性タイプ、シークレット |
zeroclaw-runtime | エージェントループ、セキュリティ、標準運用手順（SOP）、オンボーディング |
zeroclaw-providers | すべてのLLMプロバイダー実装 |
zeroclaw-channels | メッセージング統合 |
zeroclaw-gateway | HTTP/WebSocket ゲートウェイ |
zeroclaw-tools | エージェントが呼び出せるツール |
zeroclaw-memory | 会話の記憶、埋め込み |
zeroclaw-plugins | WASM プラグインホスト |
zeroclaw-hardware | GPIO / I2C / SPI / USB |
zeroclaw-log | ワークスペースのロギングとオブザーバビリティの統合 |
zeroclaw-infra | チャネルセッションのバックエンド、デバウンス、ストールウォッチドッグ |
各クレートがどのように連携しているかの平易な説明については、アーキテクチャ → クレート を参照してください。
APIリファレンスを再生成中
rustdoc はすべてのドキュメントデプロイに含まれています。ローカルビルドの場合:
sh
cargo mdbook refs # CLI + 設定リファレンス + rustdoc を生成
cargo mdbook build # rustdocブリッジを含む完全な本を再構築する
Maintainers → Docs & Translations を参照してください。