Skip to main content

Crate wordval_core

Crate wordval_core 

Source
Expand description

§wordval-core

Wordval 框架核心:应用生命周期、插件系统、统一错误处理、API 响应类型。

§主要模块

  • api — 统一 API 响应类型(Res<T>)、错误码、分页
  • error — 框架错误类型与 Result 别名
  • error_registry — 可配置的错误消息注册表
  • plugin — 插件 trait 与 PluginManager
  • state — 插件生命周期状态机(PluginState / PluginTrigger)

§快速开始

ⓘ
use wordval_core::{Plugin, PluginManager, Res, Result};

// 创建插件管理器
let mgr = PluginManager::new();

// 返回统一响应
let res = Res::ok("Hello, Wordval!");

§插件系统

实现 Plugin trait 即可创建插件:

ⓘ
use wordval_core::{Plugin, Result};
use async_trait::async_trait;

struct MyPlugin;

#[async_trait]
impl Plugin for MyPlugin {
    fn name(&self) -> &str { "my-plugin" }
    fn priority(&self) -> i32 { 100 }
    async fn start(&self) -> Result<()> { Ok(()) }
    async fn stop(&self) -> Result<()> { Ok(()) }
}

Re-exports§

pub use api::codes;
pub use api::ApiError;
pub use api::PageData;
pub use api::PageQuery;
pub use api::Res;
pub use api::ResResult;
pub use error::Error;
pub use error::Result;
pub use error_registry::error_message;
pub use error_registry::error_message_of;
pub use error_registry::register as register_error_message;
pub use error_registry::register_all as register_error_messages;
pub use error_registry::ErrorCode;
pub use plugin::Plugin;
pub use plugin::PluginManager;
pub use state::PluginState;
pub use state::PluginTrigger;

Modules§

api
框架核心 API 类型:响应体、错误、分页数据、错误码
error
error_registry
错误标识与消息注册表
plugin
state
插件生命周期状态机

Macros§

trace_error
错误位置追踪宏 —— 自动捕获 file!() / line!() / column!() 写入 ApiError