Skip to main content

wordval_core/
error.rs

1use std::fmt;
2
3/// 框架统一错误类型
4///
5/// 所有模块皆通过此类型返回错误,是 wordval 生态的错误"语言"。
6/// 支持从 `std::io::Error`、`String`、`&str`、`ApiError` 自动转换。
7///
8/// # 示例
9///
10/// ```ignore
11/// fn load_config() -> wordval_core::Result<AppConfig> {
12///     Err(wordval_core::Error::Config("config.toml 格式错误".into()))
13/// }
14/// ```
15#[derive(Debug)]
16pub enum Error {
17    /// 配置加载或解析错误(如 TOML 格式错误、必填字段缺失)
18    Config(String),
19    /// 插件生命周期错误(携带插件名和底层错误源)
20    Plugin {
21        /// 出错的插件名称
22        name: String,
23        /// 底层错误源
24        source: Box<dyn std::error::Error + Send + Sync>,
25    },
26    /// 服务器启动或运行失败(如端口被占用)
27    Server(String),
28    /// IO 操作错误(如文件读写失败、网络故障)
29    Io(std::io::Error),
30    /// 模板渲染错误
31    Template(String),
32    /// 通用业务错误消息
33    Msg(String),
34    /// API 层错误(保留完整 status/code,可无损下转回 ApiError)
35    Api(crate::api::ApiError),
36}
37
38impl fmt::Display for Error {
39    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
40        match self {
41            Error::Config(msg) => write!(f, "配置错误: {msg}"),
42            Error::Plugin { name, source } => write!(f, "插件 [{name}] 错误: {source}"),
43            Error::Server(msg) => write!(f, "服务器错误: {msg}"),
44            Error::Io(e) => write!(f, "IO 错误: {e}"),
45            Error::Template(msg) => write!(f, "模板错误: {msg}"),
46            Error::Msg(msg) => write!(f, "{msg}"),
47            Error::Api(e) => write!(f, "API 错误: {e}"),
48        }
49    }
50}
51
52impl std::error::Error for Error {
53    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
54        match self {
55            Error::Io(e) => Some(e),
56            Error::Plugin { source, .. } => Some(source.as_ref()),
57            Error::Api(e) => Some(e),
58            _ => None,
59        }
60    }
61}
62
63impl From<std::io::Error> for Error {
64    fn from(e: std::io::Error) -> Self {
65        Error::Io(e)
66    }
67}
68
69impl From<String> for Error {
70    fn from(s: String) -> Self {
71        Error::Msg(s)
72    }
73}
74
75impl From<&str> for Error {
76    fn from(s: &str) -> Self {
77        Error::Msg(s.to_string())
78    }
79}
80
81impl From<crate::api::ApiError> for Error {
82    fn from(e: crate::api::ApiError) -> Self {
83        // 保留完整错误信息(status/code/msg),下转回 ApiError 时不再丢失
84        Error::Api(e)
85    }
86}
87
88/// 框架统一 Result 类型
89///
90/// `Ok(T)` 表示成功,`Err(Error)` 表示框架内任意模块的错误。
91/// 所有公开 API 的返回值均使用此别名。
92///
93/// 第二类型参数带默认值:`Result<T>` 照常用(错误类型为 [`Error`]),
94/// 同时 `Result<T, E>` 双参写法合法——`use wordval::prelude::*` 后
95/// 自定义提取器写 `Result<Self, Self::Rejection>` 不会再被解析成
96/// 单参别名而报 E0107(anyhow::Result 的同款做法)。
97pub type Result<T, E = Error> = std::result::Result<T, E>;