apr 0.4.5

Rust bindings for Apache Portable Runtime
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
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151

//! Improved error handling for APR operations
use crate::status::Status;
#[cfg(feature = "std")]
use alloc::boxed::Box;
use alloc::string::String;
use core::fmt;

/// High-level error type that wraps Status with additional context
#[derive(Debug)]
pub struct Error {
    status: Status,
    context: Option<String>,
    #[cfg(feature = "std")]
    source: Option<Box<dyn std::error::Error + Send + Sync>>,
}

impl Error {
    /// Create a new Error from a Status
    pub fn from_status(status: Status) -> Self {
        Error {
            status,
            context: None,
            #[cfg(feature = "std")]
            source: None,
        }
    }

    /// Add context to the error
    pub fn context<S: Into<String>>(mut self, ctx: S) -> Self {
        self.context = Some(ctx.into());
        self
    }

    /// Add a source error
    #[cfg(feature = "std")]
    pub fn with_source<E: std::error::Error + Send + Sync + 'static>(mut self, source: E) -> Self {
        self.source = Some(Box::new(source));
        self
    }

    /// Get the underlying Status
    pub fn status(&self) -> Status {
        self.status
    }
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        if let Some(context) = &self.context {
            write!(f, "{}: {}", context, self.status)
        } else {
            write!(f, "{}", self.status)
        }
    }
}

#[cfg(feature = "std")]
impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        self.source
            .as_ref()
            .map(|e| e.as_ref() as &(dyn std::error::Error + 'static))
    }
}

impl From<Status> for Error {
    fn from(status: Status) -> Self {
        Error::from_status(status)
    }
}

#[cfg(feature = "std")]
impl From<std::io::Error> for Error {
    fn from(err: std::io::Error) -> Self {
        Error::from_status(Status::General).with_source(err)
    }
}

impl From<core::ffi::c_str::FromBytesWithNulError> for Error {
    fn from(_err: core::ffi::c_str::FromBytesWithNulError) -> Self {
        Error::from_status(Status::BadArgument)
    }
}

impl From<core::str::Utf8Error> for Error {
    fn from(_err: core::str::Utf8Error) -> Self {
        Error::from_status(Status::BadArgument)
    }
}

/// Result type using the improved Error
pub type Result<T> = core::result::Result<T, Error>;

/// Extension trait to add context to Results
pub trait ErrorContext<T> {
    /// Add context to an error result
    fn context<S: Into<String>>(self, ctx: S) -> Result<T>;

    /// Add context using a closure (lazy evaluation)
    fn with_context<F, S>(self, f: F) -> Result<T>
    where
        F: FnOnce() -> S,
        S: Into<String>;
}

impl<T, E> ErrorContext<T> for core::result::Result<T, E>
where
    E: Into<Error>,
{
    fn context<S: Into<String>>(self, ctx: S) -> Result<T> {
        self.map_err(|e| e.into().context(ctx))
    }

    fn with_context<F, S>(self, f: F) -> Result<T>
    where
        F: FnOnce() -> S,
        S: Into<String>,
    {
        self.map_err(|e| e.into().context(f()))
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use alloc::format;

    #[test]
    fn test_error_from_status() {
        let err = Error::from_status(Status::NotFound);
        assert_eq!(err.status(), Status::NotFound);
        assert!(err.context.is_none());
    }

    #[test]
    fn test_error_with_context() {
        let err = Error::from_status(Status::NotFound).context("Failed to find config file");

        assert_eq!(err.status(), Status::NotFound);
        assert!(err.context.is_some());
        assert!(format!("{}", err).contains("Failed to find config file"));
    }

    #[test]
    fn test_error_context_trait() {
        let result: core::result::Result<(), Status> = Err(Status::NotFound);
        let err = result.context("File operation failed").unwrap_err();

        assert!(format!("{}", err).contains("File operation failed"));
    }
}