AppError

Struct AppError 

Source
pub struct AppError {
    pub code: String,
    pub message: String,
    pub message_detail: Option<String>,
    pub context: Value,
    pub source: Option<Error>,
}
Expand description

应用程序统一错误类型

提供结构化的错误处理,支持错误链、上下文信息和序列化。 设计用于替代简单的字符串错误,提供更丰富的错误信息。

§特性

  • 错误代码: 机器可读的错误标识符
  • 错误消息: 人类可读的错误描述
  • 详细信息: 可选的详细错误信息
  • 上下文: JSON 格式的上下文数据
  • 错误链: 支持原始异常和堆栈追踪

§示例

use knife_util::AppError;

let error = AppError::new("FILE_NOT_FOUND", "配置文件不存在")
    .with_message_detail("路径: /etc/app/config.toml")
    .with_attribute("file_path", "/etc/app/config.toml");

Fields§

§code: String

错误代码 - 机器可读的错误标识符

§message: String

错误消息 - 人类可读的错误描述

§message_detail: Option<String>

详细错误信息 - 可选的额外错误详情

§context: Value

上下文信息 - JSON 格式的上下文数据

§source: Option<Error>

原始异常和堆栈追踪 - 不参与序列化

Implementations§

Source§

impl AppError

Source

pub fn new(code: &str, message: &str) -> Self

创建新的错误实例

Source

pub fn code(&self) -> &str

获取错误代码

Source

pub fn message(&self) -> &str

获取错误消息

Source

pub fn message_detail(&self) -> Option<&str>

获取详细错误信息

Source

pub fn with_message_detail(self, detail: &str) -> Self

设置详细错误信息

Source

pub fn with_attribute(self, key: &str, value: impl Into<Value>) -> Self

添加上下文信息

Source

pub fn get_attribute(&self, key: &str) -> Option<&Value>

获取上下文信息

Source

pub fn with_context(self, context: Value) -> Self

设置完整的上下文信息

Source

pub fn source(&self) -> Option<&AnyhowError>

获取原始异常信息

Source

pub fn with_source(self, source: AnyhowError) -> Self

设置原始异常信息

Source

pub fn from_error<E: Error + Send + Sync + 'static>( code: &str, message: &str, err: E, ) -> Self

从其他错误类型创建AppError

Source

pub fn from_anyhow(code: &str, message: &str, err: AnyhowError) -> Self

从anyhow::Error创建AppError

Source

pub fn from_display<E: Display>(code: &str, message: &str, err: E) -> Self

从Display类型创建AppError

Source

pub fn from_display_with_source<E: Display + Error + Send + Sync + 'static>( code: &str, message: &str, err: E, ) -> Self

从Display类型创建AppError并保存原始错误

Source

pub fn get_cause(&self) -> Option<String>

获取完整的错误堆栈信息

Trait Implementations§

Source§

impl Clone for AppError

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for AppError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for AppError

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for AppError

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Error for AppError

1.30.0 · Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<AppError> for Error

Source§

fn from(err: AppError) -> Self

Converts to this type from the input type.
Source§

impl From<Error> for AppError

Source§

fn from(err: Error) -> Self

Converts to this type from the input type.
Source§

impl From<TryInitError> for AppError

Source§

fn from(err: TryInitError) -> Self

Converts to this type from the input type.
Source§

impl Serialize for AppError

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,