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

#![doc = include_str!("../.github/errors.md")]
// logging-rs errors
// Version: 1.0.0

// Copyright (c) 2023-present ElBe Development.

// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the 'Software'),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

////////////////////////////////
// IMPORTS AND USE STATEMENTS //
////////////////////////////////

use std::fmt;


///////////
// ERROR //
///////////

/// Error object.
///
/// Use [`Error::new()`] to create error objects instead of using this struct.
///
/// # Parameters
///
/// - `name`: The errors name.
/// - `description`: The error description.
/// - `exit_code`: The errors exit code.
///
/// # Returns
///
/// A new `Error` object with the specified name and description.
///
/// # Examples
///
/// ```rust
/// # use logging_rs;
/// logging_rs::errors::Error {
///     name: "name".to_owned(),
///     description: "description".to_owned(),
///     exit_code: 1
/// };
/// ```
#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord)]
pub struct Error {
    /// The errors name.
    pub name: String,
    /// The error description.
    pub description: String,
    /// The errors exit code.
    pub exit_code: i32,
}

/// Display implementation for the error object.
impl fmt::Display for Error {
    /// Format implementation for the error object.
    ///
    /// # Parameters
    ///
    /// - `self`: The error object.
    /// - `f`: The [`fmt::Formatter`] to use.
    ///
    /// # Returns
    ///
    /// A [`fmt::Result`] containing the formatted error message.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use logging_rs;
    /// # let error = logging_rs::errors::Error::new("name", "description", 1);
    /// println!("{}", error);
    /// ```
    ///
    /// # See also
    ///
    /// - [`fmt::Display`]
    /// - [`Error`]
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "\x1b[31;1m{}\x1b[0m: {}", self.name, self.description)
    }
}

impl Error {
    /// Creates a new error object.
    ///
    /// # Parameters
    ///
    /// - `name`: The errors name.
    /// - `description`: The error description.
    /// - `exit_code`: The errors exit code.
    ///
    /// # Returns
    ///
    /// A new `Error` object with the specified name and description.
    ///
    /// # Examples
    ///
    /// ```rust
    /// # use logging_rs;
    /// logging_rs::errors::Error::new("name", "description", 1);
    /// ```
    ///
    /// # See also
    ///
    /// - [`Error`]
    pub fn new(name: &str, description: &str, exit_code: i32) -> Error {
        return Error {
            name: name.to_owned(),
            description: description.to_owned(),
            exit_code: exit_code,
        };
    }

    /// Raises the error and exits with the specified exit code.
    ///
    /// # Parameters
    ///
    /// - `self`: The error object.
    /// - `details`: The error details.
    ///
    /// # Aborts
    ///
    /// Exits with the specified exit code.
    ///
    /// # Examples
    ///
    /// ```should_panic
    /// # use logging_rs;
    /// # let error: logging_rs::errors::Error = logging_rs::errors::Error::new("name", "description", 1);
    /// error.raise("Something went very wrong");
    /// ```
    ///
    /// # See also
    ///
    /// - [`Error`]
    pub fn raise(&self, details: &str) {
        eprintln!("{}", self);
        eprintln!("{}", details);

        std::process::exit(self.exit_code);
    }
}