v0.1.0-pre.071
This commit is contained in:
@@ -1,23 +1,37 @@
|
||||
<!-- file: kb-core/README.md -->
|
||||
<!-- version: 3 -->
|
||||
<!-- version: 4 -->
|
||||
|
||||
# kb-core
|
||||
|
||||
Ce crate fournit les types minimaux partagés, les erreurs communes et l'identité des modules.
|
||||
`kb-core` fournit les primitives minimales partagées par l’ensemble de `khadhroony-bot3`.
|
||||
|
||||
## Rôle dans l'écosystème
|
||||
## Responsabilités
|
||||
|
||||
Ce module fait partie du découpage strict de Khadhroony Bot2. Il doit conserver des dépendances limitées et ne pas contourner les interfaces communes du workspace.
|
||||
- type d’erreur explicite commun au workspace ;
|
||||
- alias `Result<T>` ;
|
||||
- identité stable des modules ;
|
||||
- classification des grandes familles de traitement.
|
||||
|
||||
## Règles locales
|
||||
La crate reste volontairement petite et ne dépend d’aucune couche fonctionnelle supérieure.
|
||||
|
||||
- Les commentaires de code restent en anglais.
|
||||
- La documentation Markdown reste en français.
|
||||
- Les exports publics sont contrôlés depuis `lib.rs` lorsque le crate expose une bibliothèque.
|
||||
- Les binaires utilisent `main.rs` avec les attributs Rust obligatoires.
|
||||
## API publique
|
||||
|
||||
## Erreurs communes
|
||||
- `Error` ;
|
||||
- `Result<T>` ;
|
||||
- `ModuleName` ;
|
||||
- `ModuleVersion` ;
|
||||
- `ModuleKind`.
|
||||
|
||||
`kb-core::Error` est l'enum d'erreur commune du workspace. Elle fournit des familles stables pour configuration, I/O, JSON, tracing, Tauri, HTTP, WebSocket, base de données, état invalide, client non connecté, fonctionnalité non implémentée et erreurs personnalisées.
|
||||
Voir [USAGE.md](USAGE.md) pour les exemples.
|
||||
|
||||
`kb-core::Error::new(code, message)` reste disponible comme compatibilité courte pendant que les domaines sont progressivement spécialisés.
|
||||
## Relations
|
||||
|
||||
`kb-core` est utilisée par toutes les crates qui ont besoin d’un contrat d’erreur ou d’une identité de module partagée. Elle ne contient ni configuration, ni transport, ni stockage, ni logique Solana.
|
||||
|
||||
## Documentation
|
||||
|
||||
- [USAGE.md](USAGE.md)
|
||||
- [TODO.md](TODO.md)
|
||||
- [CHANGELOG.md](CHANGELOG.md)
|
||||
- [Architecture générale](../docs/architecture/ARCHITECTURE.md)
|
||||
- [Carte des crates](../docs/architecture/CRATE_MAP.md)
|
||||
|
||||
Reference in New Issue
Block a user