mago-reporting 1.20.1

Structured error and diagnostic reporting utilities.
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

//! Error types for the reporting crate.
//!
//! This module defines the error types that can occur during issue reporting,
//! including database errors, JSON serialization errors, file I/O errors,
//! and invalid configuration errors.

use codespan_reporting::files::Error as FilesError;
use serde_json::Error as JsonError;
use std::io::Error as IoError;

use mago_database::error::DatabaseError;

/// Errors that can occur during issue reporting.
#[derive(Debug)]
pub enum ReportingError {
    /// An error occurred while accessing the database.
    DatabaseError(DatabaseError),
    /// An error occurred while serializing or deserializing JSON.
    JsonError(JsonError),
    /// An error occurred while accessing source files.
    FilesError(FilesError),
    /// An I/O error occurred.
    IoError(IoError),
    /// An invalid reporting target was specified.
    InvalidTarget(String),
    /// An invalid reporting format was specified.
    InvalidFormat(String),
}

impl ReportingError {
    #[must_use]
    pub fn is_broken_pipe(&self) -> bool {
        let err = match self {
            Self::IoError(err) => err,
            Self::FilesError(FilesError::Io(err)) => err,
            _ => return false,
        };

        err.raw_os_error() == Some(32) || err.kind() == std::io::ErrorKind::BrokenPipe
    }
}

impl std::fmt::Display for ReportingError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::DatabaseError(error) => write!(f, "{error}"),
            Self::JsonError(error) => write!(f, "Json error: {error}"),
            Self::FilesError(error) => write!(f, "Files error: {error}"),
            Self::IoError(error) => write!(f, "IO error: {error}"),
            Self::InvalidTarget(target) => write!(f, "Invalid target: {target}"),
            Self::InvalidFormat(format) => write!(f, "Invalid format: {format}"),
        }
    }
}

impl std::error::Error for ReportingError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::DatabaseError(error) => Some(error),
            Self::JsonError(error) => Some(error),
            Self::FilesError(error) => Some(error),
            Self::IoError(error) => Some(error),
            Self::InvalidTarget(_) => None,
            Self::InvalidFormat(_) => None,
        }
    }
}

impl From<DatabaseError> for ReportingError {
    fn from(error: DatabaseError) -> Self {
        Self::DatabaseError(error)
    }
}

impl From<JsonError> for ReportingError {
    fn from(error: JsonError) -> Self {
        Self::JsonError(error)
    }
}

impl From<FilesError> for ReportingError {
    fn from(error: FilesError) -> Self {
        Self::FilesError(error)
    }
}

impl From<IoError> for ReportingError {
    fn from(error: IoError) -> Self {
        Self::IoError(error)
    }
}