wherr 0.1.7

Enhance Rust errors with file and line details using the `#[wherr]` macro for clearer debugging.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! `wherr` crate provides a way to enhance Rust errors with file and line number information.
//!
//! The main struct `Wherr` represents an error containing additional metadata about where it originated from.
//!
//! The `wherr` attribute macro, defined in the `wherr_macro` crate, is re-exported here for ease of use.

use std::fmt;

// Re-export the procedural macro from the `wherr_macro` crate.
pub use wherr_macro::wherr;

#[cfg(feature = "anyhow")]
use anyhow::Error as AnyhowError;

#[cfg(feature = "anyhow")]
type Wherror = AnyhowError;
#[cfg(not(feature = "anyhow"))]
type Wherror = Box<dyn std::error::Error>;

/// Represents an error that includes file and line number metadata.
///
/// This error struct wraps around any error and provides a consistent interface to access the original error
/// and the file and line where it originated from.
pub struct Wherr {
    pub inner: Wherror,
    pub file: &'static str,
    pub line: u32,
}

impl Wherr {
    /// Create a new `Wherr` error from the given error, file, and line.
    ///
    /// # Parameters
    /// * `err`: The original error to wrap.
    /// * `file`: The file where the error occurred.
    /// * `line`: The line number where the error occurred.
    pub fn new(err: Wherror, file: &'static str, line: u32) -> Self {
        Wherr {
            inner: err,
            file,
            line,
        }
    }
}

impl fmt::Display for Wherr {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}\nerror at {}:{}",
            self.inner, self.file, self.line
        )
    }
}

impl fmt::Debug for Wherr {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{:?}\nerror at {}:{}",
            self.inner, self.file, self.line
        )
    }
}

impl std::error::Error for Wherr {}

/// Utility function to wrap the given error into a `Wherr` struct, adding file and line number details.
///
/// # Parameters
/// * `result`: The result containing the error to wrap.
/// * `file`: The file where the error occurred.
/// * `line`: The line number where the error occurred.
///
/// # Returns
/// If the original error is already of type `Wherr`, it is returned as is.
/// Otherwise, the original error is wrapped inside a `Wherr` and returned.
pub fn wherrapper<T, E>(
    result: Result<T, E>,
    file: &'static str,
    line: u32,
) -> Result<T, Wherror>
where
    E: Into<Wherror>,
{
    match result {
        Ok(val) => Ok(val),
        Err(err) => {
            let error: Wherror = err.into();
            if error.is::<Wherr>() {
                Err(error)
            } else {
                Err(Wherr::new(error, file, line).into())
            }
        }
    }
}