Skip to main content

wordval_core/
lib.rs

1//! # wordval-core
2//!
3//! Wordval 框架核心:应用生命周期、插件系统、统一错误处理、API 响应类型。
4//!
5//! ## 主要模块
6//!
7//! - [`api`] — 统一 API 响应类型(`Res<T>`)、错误码、分页
8//! - [`error`] — 框架错误类型与 `Result` 别名
9//! - [`error_registry`] — 可配置的错误消息注册表
10//! - [`plugin`] — 插件 trait 与 `PluginManager`
11//! - [`state`] — 插件生命周期状态机(`PluginState` / `PluginTrigger`)
12//!
13//! ## 快速开始
14//!
15//! ```ignore
16//! use wordval_core::{Plugin, PluginManager, Res, Result};
17//!
18//! // 创建插件管理器
19//! let mgr = PluginManager::new();
20//!
21//! // 返回统一响应
22//! let res = Res::ok("Hello, Wordval!");
23//! ```
24//!
25//! ## 插件系统
26//!
27//! 实现 [`Plugin`] trait 即可创建插件:
28//!
29//! ```ignore
30//! use wordval_core::{Plugin, Result};
31//! use async_trait::async_trait;
32//!
33//! struct MyPlugin;
34//!
35//! #[async_trait]
36//! impl Plugin for MyPlugin {
37//!     fn name(&self) -> &str { "my-plugin" }
38//!     fn priority(&self) -> i32 { 100 }
39//!     async fn start(&self) -> Result<()> { Ok(()) }
40//!     async fn stop(&self) -> Result<()> { Ok(()) }
41//! }
42//! ```
43pub mod api;
44pub mod error;
45pub mod error_registry;
46pub mod plugin;
47pub mod state;
48
49pub use api::{codes, ApiError, PageData, PageQuery, Res, ResResult};
50pub use error::{Error, Result};
51pub use error_registry::{
52    error_message, error_message_of, register as register_error_message,
53    register_all as register_error_messages, ErrorCode,
54};
55pub use plugin::{Plugin, PluginManager};
56pub use state::{PluginState, PluginTrigger};