brix_errors 0.2.1

Brix's crate for handling all application-related errors.
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

// Copyright (c) 2021 Ethan Lerner, Caleb Cushing, and the Brix contributors
//
// This software is released under the MIT License.
// https://opensource.org/licenses/MIT

//! # Brix Errors
//! Common crate for the [BrixError] type used to help wrap and format many
//! different types of errors that may occur within Brix.

use std::fmt::{self, Display};
use std::io;

/// The Brix error, that supports an optional [BrixErrorKind] kind, and a message.
#[derive(Debug)]
pub struct BrixError {
    pub kind: Option<BrixErrorKind>,
    pub message: String,
}

impl BrixError {
    /// Construct an error with only a message.
    pub fn with(error: &str) -> Self {
        Self {
            kind: None,
            message: String::from(error),
        }
    }
}

/// Enum that lists all types of Brix errors.
#[derive(Debug, PartialEq, Eq)]
pub enum BrixErrorKind {
    Io,
    Cli,
    Template,
    Validation,
}

impl From<io::Error> for BrixError {
    fn from(err: io::Error) -> BrixError {
        BrixError {
            kind: Some(BrixErrorKind::Io),
            message: err.to_string(),
        }
    }
}

impl From<clap::Error> for BrixError {
    fn from(err: clap::Error) -> BrixError {
        BrixError {
            kind: Some(BrixErrorKind::Cli),
            message: err.to_string(),
        }
    }
}

impl From<serde_yaml::Error> for BrixError {
    fn from(err: serde_yaml::Error) -> BrixError {
        BrixError {
            kind: None,
            message: format!("{}", err),
        }
    }
}

impl From<handlebars::RenderError> for BrixError {
    fn from(err: handlebars::RenderError) -> BrixError {
        BrixError {
            kind: Some(BrixErrorKind::Template),
            message: format!("{}", err),
        }
    }
}

impl From<validator::ValidationErrors> for BrixError {
    fn from(err: validator::ValidationErrors) -> BrixError {
        let mut message = String::new();
        for (field, _errors) in err.field_errors().into_iter() {
            message.push_str(&format!("\nField '{}' is required!", field))
        }

        BrixError {
            kind: Some(BrixErrorKind::Validation),
            message,
        }
    }
}

impl From<fancy_regex::Error> for BrixError {
    fn from(err: fancy_regex::Error) -> BrixError {
        BrixError {
            kind: None,
            message: format!("{}", err),
        }
    }
}

impl From<fs_extra::error::Error> for BrixError {
    fn from(err: fs_extra::error::Error) -> BrixError {
        BrixError {
            kind: None,
            message: format!("{}", err),
        }
    }
}

impl Display for BrixErrorKind {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
        let formatted = match self {
            Self::Io => "IO",
            Self::Cli => "CLI",
            Self::Template => "Template",
            Self::Validation => "Validation",
        };

        write!(fmt, "{}", formatted)
    }
}

impl Display for BrixError {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> Result<(), fmt::Error> {
        if let Some(kind) = &self.kind {
            write!(fmt, "{} error: {}", kind, self.message)
        } else {
            write!(fmt, "{}", self.message)
        }
    }
}