Referencia de la API
Documentación rustdoc completa de cada tipo público en el workspace, generada automáticamente a partir de los comentarios /// de cada tipo, función y módulo. Úsala cuando necesites conocer la forma exacta de un struct, los métodos de un trait, o qué devuelve una función: cualquier cosa que la referencia generada exponga mejor de lo que puede hacerlo la prosa.
Cómo navegar por él
- El índice de rustdoc enumera todos los crates del espacio de trabajo. Abre
zeroclaw-apipara explorar los contratos de traits compartidos y los tipos de frontera. - Usa el cuadro de búsqueda de rustdoc, la búsqueda con el teclado o Todos los elementos para encontrar un nombre público. La búsqueda del navegador solo busca en la página renderizada actual.
- Haz clic en un rasgo para ver sus métodos y los implementadores conocidos.
Límites del contrato
zeroclaw-api contiene los tipos de frontera compartidos y las definiciones de traits. Las implementaciones concretas residen en el crate de la capacidad propietaria y se conectan mediante el límite de construcción existente de esa superficie. Los consumidores dependen de los traits aplicables en lugar de tipos concretos.
Las definiciones de los traits son la fuente de verdad para los métodos, valores predeterminados y tipos exactos. El rustdoc generado es la referencia navegable creada a partir de ellas. Usa Arquitectura → Descripción general para consultar las familias de extensiones seleccionadas y ADR-002 para consultar la decisión adoptada sobre los límites basados en traits.
Índice de la caja
| Caja | Lo que expone |
|---|---|
zeroclaw | Paraguas de nivel superior con reexportaciones |
zeroclaw-api | Tipos de frontera compartidos y traits de extensión propios |
zeroclaw-config | Esquema de configuración, tipos de autonomía, secretos |
zeroclaw-runtime | Bucle de agente, seguridad, SOP, incorporación |
zeroclaw-providers | Cada implementación de proveedor de LLM |
zeroclaw-channels | Integraciones de mensajería |
zeroclaw-gateway | Puerta de enlace HTTP/WebSocket |
zeroclaw-tools | Herramientas llamables por agentes |
zeroclaw-memory | Memoria de conversación, incrustaciones |
zeroclaw-plugins | Host del plugin WASM |
zeroclaw-hardware | GPIO / I2C / SPI / USB |
zeroclaw-log | Integración del registro y la observabilidad del espacio de trabajo |
zeroclaw-infra | Backends de sesiones de canal, antirrebote y vigilancia de bloqueos |
Consulta Arquitectura → Crates para obtener una descripción en lenguaje sencillo de cómo se integran los crates.
Regenerando la referencia de la API
rustdoc se incluye en cada despliegue de documentación. Para compilaciones locales:
sh
cargo mdbook refs # genera la referencia de CLI + configuración + rustdoc
cargo mdbook build # reconstruye el libro completo, incluyendo el puente de rustdoc
Consulta Maintainers → Docs & Translations.