API 参考
工作区中每个公共类型的完整 rustdoc,由每个类型、函数和模块上的 /// 注释自动生成。当你需要了解某个结构体的确切形态、某个 trait 上的方法,或某个函数的返回值时,请使用此文档:凡是生成的参考资料比文字描述更能清晰呈现的内容,都可在此查阅。
如何导航它
- rustdoc 索引列出工作区中的每个 crate。打开
zeroclaw-api,浏览共享的 trait 契约和边界类型。 - 使用 rustdoc 的搜索框、键盘搜索或 所有项目 来查找公开名称。浏览器查找功能仅搜索当前呈现的页面。
- 点击某个 trait 可查看其方法和已知实现者。
契约边界
zeroclaw-api 负责共享边界类型和 trait 定义。具体实现位于负责相应能力的 crate 中,并通过该接口现有的构造边界接入。使用者依赖适用的 trait,而不是具体类型。
trait 定义是方法、默认值和类型的权威来源。生成的 rustdoc 是基于这些定义构建的可导航参考。请使用 架构 → 概览 查看经过整理的扩展系列,并使用 ADR-002 了解已采纳的 trait 驱动边界决策。
包索引
| 箱 | 它暴露了什么 |
|---|---|
zeroclaw | 顶层的伞形模块,包含重新导出的内容 |
zeroclaw-api | 共享边界类型和第一方扩展 trait |
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 | 通道会话后端、防抖和卡顿看门狗 |
有关各 crate 如何协同工作的详细说明,请参阅 架构 → Crates。
正在重新生成 API 参考文档
rustdoc 随每个文档部署一起提供。对于本地构建:
sh
cargo mdbook refs # 生成 CLI + 配置参考 + rustdoc
cargo mdbook build # 重建包含 rustdoc 桥接的完整书籍
请参阅 维护者 → 文档与翻译。