pi_result 0.2.0

Thin, typed, and observable Result aliases and error interoperability utilities
Documentation
//! 统一错误输出格式辅助。
//!
//! 本模块不改变 `error-stack` 的输出语义,只是为项目代码提供更明确的
//! 入口函数,便于日志、测试与用户界面层统一使用。

use crate::Error;

/// 返回面向用户的简洁消息。
///
/// 等价于 `format!("{report}")`。
pub fn user_message(report: &Error) -> String {
    format!("{report}")
}

/// 返回包含完整 context 链的消息。
///
/// 等价于 `format!("{report:#}")`。
pub fn verbose_message(report: &Error) -> String {
    format!("{report:#}")
}

/// 返回调试友好的完整输出。
///
/// 等价于 `format!("{report:?}")`。
pub fn debug_message(report: &Error) -> String {
    format!("{report:?}")
}

#[cfg(test)]
mod tests {
    use super::{debug_message, user_message, verbose_message};
    use crate::{Error, ErrorKind, attachment::Operation};
    use error_stack::Report;

    #[test]
    fn test_user_message_matches_display_output() {
        let report: Error = Report::new(ErrorKind::Timeout);
        assert_eq!(user_message(&report), "timeout");
    }

    #[test]
    fn test_verbose_message_contains_context_chain() {
        let report: Error = Report::new(ErrorKind::Dependency)
            .attach(Operation("load_config"))
            .change_context(ErrorKind::Internal);

        let message = verbose_message(&report);
        assert!(message.contains("internal error"));
        assert!(message.contains("dependency failure"));
    }

    #[test]
    fn test_debug_message_contains_attachments_and_context() {
        let report: Error = Report::new(ErrorKind::Internal).attach(Operation("spawn_worker"));
        let message = debug_message(&report);

        assert!(message.contains("internal error"));
        assert!(message.contains("spawn_worker"));
    }
}