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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
use crate::error::DisplayError;

/// Helper making implementations shorter
pub trait IntoResult: Sized {
    type Value;
    type Error;

    /// No-op, just a hack to make impl shorter
    fn internal_into_result(self) -> Result<Self::Value, Self::Error>;

    /// A version of map_err that doesn't consume error
    fn with_err<F: FnOnce(&Self::Error)>(self, fun: F) -> Result<Self::Value, Self::Error> {
        self.internal_into_result().map_err(|error| { fun(&error); error })
    }
}

/// ResultExt that provides nicer error messages than unwrap/expect
///
/// Exits with exit code 2 to allow grep-like behavior
pub trait UnwrapOrExit: IntoResult {
    /// Another trick to shorten impl
    ///
    /// But you may find it useful too
    fn unwrap_or_exit_custom<F: FnOnce(Self::Error)>(self, printer: F) -> Self::Value {
        self.internal_into_result().unwrap_or_else(|error| {
            printer(error);
            std::process::exit(2);
        })
    }

    /// Formatting using std::error::Error
    ///
    /// Note that Error trait is special, this displays sources separated with `: `
    fn unwrap_or_exit(self) -> Self::Value where Self::Error: 'static + std::error::Error {
        self.unwrap_or_exit_custom(|error| {
            eprintln!("Error: {}", error.join_sources(": "));
        })
    }

    /// Formatting using Display
    fn unwrap_or_exit_display(self) -> Self::Value where Self::Error: std::fmt::Display {
        self.unwrap_or_exit_custom(|error| eprintln!("Error: {}", error))
    }

    /// Formatting using Debug
    fn unwrap_or_exit_debug(self) -> Self::Value where Self::Error: std::fmt::Debug {
        self.unwrap_or_exit_custom(|error| eprintln!("Error: {:?}", error))
    }

    /// Log error and exit
    fn unwrap_or_exit_log<L: LogOwned>(self, mut logger: L) -> Self::Value where Self::Error: 'static + std::error::Error {
        self.unwrap_or_exit_custom(|error| logger.log_error_owned("Error", error))
    }
}

impl<T, E> IntoResult for Result<T, E> {
    type Value = T;
    type Error = E;

    fn internal_into_result(self) -> Self {
        self
    }
}

impl<T, E> UnwrapOrExit for Result<T, E> {}

/// Result extension trait providing easy logging of errors
///
/// Supports `log` and `slog` (consuming only) crates - use appropriate features.
///
/// I'm too lazy to document each method, so read this:
///
/// * `log_${loglevel}()` - logs massage with error on error without changing the result
/// * `log_${loglevel}_and_replace() - log message and consume error, replacing it with parameter
/// * `log_${loglevel}_and_replace_with()` - log message and consume error but construct
///                                          the replacement using a reference to error before
///                                          consuming it.
///
/// If you're not sure what's the usefulness of the last one (or two), here's a real-life use case:
/// A HTTP server/application needs to log errors and also return more general responses (e.g. 404,
/// 500...). So we use `log_error_and_replace_with` to determine what kind of error response is
/// needed for given error. This converts all errors to a common error type, which itself can be
/// converted to HTTP response. (e.g. using `unwrap_or_else`)
///
/// This neatly separates business logic from logging and HTTP response handling.
pub trait LogResult: IntoResult where <Self as IntoResult>::Error: 'static + std::error::Error {
    /// Internal, helps with implementation
    fn convert_and_consume_err<E, ConvF, ConsF>(self, convert: ConvF, consume: ConsF) -> Result<Self::Value, E> where ConvF: FnOnce(&Self::Error) -> E, ConsF: FnOnce(Self::Error) {
        self.internal_into_result().map_err(|error| {
            let converted = convert(&error);
            consume(error);
            converted
        })
    }

    fn log_error<L: Log>(self, mut logger: L, message: &str) -> Result<Self::Value, Self::Error> {
        self.with_err(|error| logger.log_error(message, error))
    }

    fn log_warning<L: Log>(self, mut logger: L, message: &str) -> Result<Self::Value, Self::Error> {
        self.with_err(|error| logger.log_warning(message, error))
    }

    fn log_info<L: Log>(self, mut logger: L, message: &str) -> Result<Self::Value, Self::Error> {
        self.with_err(|error| logger.log_info(message, error))
    }

    fn log_debug<L: Log>(self, mut logger: L, message: &str) -> Result<Self::Value, Self::Error> {
        self.with_err(|error| logger.log_debug(message, error))
    }

    fn log_trace<L: Log>(self, mut logger: L, message: &str) -> Result<Self::Value, Self::Error> {
        self.with_err(|error| logger.log_trace(message, error))
    }

    fn log_error_and_replace<E, L: LogOwned>(self, logger: L, message: &str, replacement: E) -> Result<Self::Value, E> {
        self.log_error_and_replace_with(logger, message, move |_| replacement)
    }

    fn log_warning_and_replace<E, L: LogOwned>(self, logger: L, message: &str, replacement: E) -> Result<Self::Value, E> {
        self.log_warning_and_replace_with(logger, message, move |_| replacement)
    }

    fn log_info_and_replace<E, L: LogOwned>(self, logger: L, message: &str, replacement: E) -> Result<Self::Value, E> {
        self.log_info_and_replace_with(logger, message, move |_| replacement)
    }

    fn log_debug_and_replace<E, L: LogOwned>(self, logger: L, message: &str, replacement: E) -> Result<Self::Value, E> {
        self.log_debug_and_replace_with(logger, message, move |_| replacement)
    }

    fn log_trace_and_replace<E, L: LogOwned>(self, logger: L, message: &str, replacement: E) -> Result<Self::Value, E> {
        self.log_trace_and_replace_with(logger, message, move |_| replacement)
    }

    fn log_error_and_replace_with<E, F, L: LogOwned>(self, mut logger: L, message: &str, convert: F) -> Result<Self::Value, E> where F: FnOnce(&Self::Error) -> E {
        self.convert_and_consume_err(convert, |error| logger.log_error_owned(message, error))
    }

    fn log_warning_and_replace_with<E, F, L: LogOwned>(self, mut logger: L, message: &str, convert: F) -> Result<Self::Value, E> where F: FnOnce(&Self::Error) -> E {
        self.convert_and_consume_err(convert, |error| logger.log_warning_owned(message, error))
    }

    fn log_info_and_replace_with<E, F, L: LogOwned>(self, mut logger: L, message: &str, convert: F) -> Result<Self::Value, E> where F: FnOnce(&Self::Error) -> E {
        self.convert_and_consume_err(convert, |error| logger.log_info_owned(message, error))
    }

    fn log_debug_and_replace_with<E, F, L: LogOwned>(self, mut logger: L, message: &str, convert: F) -> Result<Self::Value, E> where F: FnOnce(&Self::Error) -> E {
        self.convert_and_consume_err(convert, |error| logger.log_debug_owned(message, error))
    }

    fn log_trace_and_replace_with<E, F, L: LogOwned>(self, mut logger: L, message: &str, convert: F) -> Result<Self::Value, E> where F: FnOnce(&Self::Error) -> E {
        self.convert_and_consume_err(convert, |error| logger.log_trace_owned(message, error))
    }
}

impl<T, E: 'static + std::error::Error> LogResult for Result<T, E> {}

/// Abstraction over loggers
///
/// This is for loggers that have to consume errors (e.g. because of sending them to another thread).
/// Loggers that don't have to consume errors must also implement this one anyway.
/// It is recommended to implement `Log` in such case and then use `impl_log_owned!(YourLogger)`.
/// In general, `log_${loglevel}` and `log_${loglevel}_owned` should have the same behavior when
/// observed by a user.
pub trait LogOwned {
    fn log_error_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E);
    fn log_warning_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E);
    fn log_info_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E);
    fn log_debug_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E);
    fn log_trace_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E);
}

/// Abstraction over loggers
///
/// This is for loggers that don't have to consume errors.
pub trait Log: LogOwned {
    fn log_error(&mut self, message: &str, error: &(dyn 'static + std::error::Error));
    fn log_warning(&mut self, message: &str, error: &(dyn 'static + std::error::Error));
    fn log_info(&mut self, message: &str, error: &(dyn 'static + std::error::Error));
    fn log_debug(&mut self, message: &str, error: &(dyn 'static + std::error::Error));
    fn log_trace(&mut self, message: &str, error: &(dyn 'static + std::error::Error));
}

impl<T: LogOwned> LogOwned for &mut T {
    fn log_error_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        (*self).log_error_owned(message, error);
    }

    fn log_warning_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        (*self).log_warning_owned(message, error);
    }

    fn log_info_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        (*self).log_info_owned(message, error);
    }

    fn log_debug_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        (*self).log_debug_owned(message, error);
    }

    fn log_trace_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        (*self).log_trace_owned(message, error);
    }
}

/// Implements LogOwned if you implemented Log manually
#[macro_export]
macro_rules! impl_log_owned {
    ($type:ty) => {
        impl LogOwned for $type {
            fn log_error_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
                $crate::result::Log::log_error(self, message, &error);
            }

            fn log_warning_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
                $crate::result::Log::log_warning(self, message, &error);
            }

            fn log_info_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
                $crate::result::Log::log_info(self, message, &error);
            }

            fn log_debug_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
                $crate::result::Log::log_debug(self, message, &error);
            }

            fn log_trace_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
                $crate::result::Log::log_trace(self, message, &error);
            }
        }
    }
}

impl<T: Log> Log for &mut T {
    fn log_error(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        (*self).log_error(message, error);
    }

    fn log_warning(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        (*self).log_warning(message, error);
    }
    fn log_info(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        (*self).log_info(message, error);
    }
    fn log_debug(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        (*self).log_debug(message, error);
    }
    fn log_trace(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        (*self).log_trace(message, error);
    }
}

/// Marker that uses global logger provided by `log` crate to log
#[cfg(feature = "log")]
#[derive(Copy, Clone)]
pub struct GlobalLogger;


/// Generates `{message}: {error}` with sources separated by `: `.
#[cfg(feature = "log")]
impl Log for GlobalLogger {
    fn log_error(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        log::error!("{}: {}", message, error.join_sources(": "));
    }

    fn log_warning(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        log::warn!("{}: {}", message, error.join_sources(": "));
    }
    fn log_info(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        log::info!("{}: {}", message, error.join_sources(": "));
    }
    fn log_debug(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        log::debug!("{}: {}", message, error.join_sources(": "));
    }
    fn log_trace(&mut self, message: &str, error: &(dyn 'static + std::error::Error)) {
        log::trace!("{}: {}", message, error.join_sources(": "));
    }
}

#[cfg(feature = "log")]
impl_log_owned!(GlobalLogger);

/// Uses native Error logging with `errorr` as the key.
#[cfg(feature = "slog")]
impl LogOwned for &slog::Logger {
    fn log_error_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        slog::error!(self, "{}", message; "error" => #error);
    }

    fn log_warning_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        slog::warn!(self, "{}", message; "error" => #error);
    }
    fn log_info_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        slog::info!(self, "{}", message; "error" => #error);
    }
    fn log_debug_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        slog::debug!(self, "{}", message; "error" => #error);
    }
    fn log_trace_owned<E: 'static + std::error::Error>(&mut self, message: &str, error: E) {
        slog::trace!(self, "{}", message; "error" => #error);
    }
}

/// Prints nice error message when returned from `main()`
///
/// Errors are ususally formatted using `Debug` when returned from `main()`.
/// This sucks because `Debug` is not intended for users.
/// This alias solves it by using special error type which formats the error using `Error` trait.
/// It contains a `Box` so it trades one allocation for convenience (just write `?` anywhere).
///
/// Using this for anything else is not recommended!
pub type MultilineTerminator = Result<(), crate::error::TerminatingError<crate::error::MultilineTerminator, crate::error::BoxedError>>;