Référence de l’API
Documentation rustdoc complète pour chaque type public de l’espace de travail, générée automatiquement à partir des commentaires /// de chaque type, fonction et module. Utilisez-la lorsque vous avez besoin de connaître la forme exacte d’une struct, les méthodes d’un trait, ou ce que retourne une fonction : tout ce que la référence générée expose mieux que la prose.
Comment le naviguer
- L’index rustdoc répertorie chaque crate de l’espace de travail. Ouvrez
zeroclaw-apipour parcourir les contrats de traits partagés et les types de frontière. - Utilisez la zone de recherche de rustdoc, la recherche au clavier ou Tous les éléments pour trouver un nom public. La fonction de recherche du navigateur ne porte que sur la page actuellement affichée.
- Cliquez sur un trait pour afficher ses méthodes et ses implémenteurs connus.
Limites du contrat
zeroclaw-api est propriétaire des types d’interface partagés et des définitions de traits. Les implémentations concrètes résident dans la crate de capacité qui les possède et s’intègrent via le point de construction existant de cette interface. Les consommateurs dépendent des traits applicables plutôt que des types concrets.
Les définitions des traits sont la source de vérité pour les méthodes exactes, les valeurs par défaut et les types. La rustdoc générée constitue la référence navigable qui en est dérivée. Consultez Architecture → Vue d’ensemble pour les familles d’extensions retenues et ADR-002 pour la décision acceptée concernant la frontière pilotée par les traits.
Index du crate
| Crate | Ce qu’il expose |
|---|---|
zeroclaw | Enveloppe de haut niveau avec des réexports |
zeroclaw-api | Types de frontière partagés et traits d’extension de première partie |
zeroclaw-config | Schéma de configuration, types d’autonomie, secrets |
zeroclaw-runtime | Boucle d’agent, sécurité, procédure opérationnelle standard (SOP), intégration |
zeroclaw-providers | Chaque implémentation de fournisseur de LLM |
zeroclaw-channels | Intégrations de messagerie |
zeroclaw-gateway | Passerelle HTTP/WebSocket |
zeroclaw-tools | Outils appelables par l’agent |
zeroclaw-memory | Mémoire de conversation, embeddings |
zeroclaw-plugins | Hôte de plugin WASM |
zeroclaw-hardware | GPIO / I2C / SPI / USB |
zeroclaw-log | Intégration de la journalisation et de l’observabilité de l’espace de travail |
zeroclaw-infra | Backends de session de canal, anti-rebond et surveillance des blocages |
Voir Architecture → Crates pour une description en anglais simple de la manière dont les crates sont organisées.
Régénération de la référence de l’API
rustdoc est livré avec chaque déploiement de documentation. Pour les builds locaux :
sh
cargo mdbook refs # génère la référence CLI + config + rustdoc
cargo mdbook build # reconstruit le livre complet, y compris le pont rustdoc