boytacean-common 0.13.2

Commons library for Boytacen.
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

//! Error related data structures to be shared and used.
//!
//! This module contains the [`Error`] enum, which is used to represent
//! errors that can occur within Boytacean domain.

use std::{
    backtrace::Backtrace,
    error,
    fmt::{self, Display, Formatter},
    io,
    string::FromUtf8Error,
};

/// Top level enum for error handling within Boytacean.
///
/// Most of the time, you will want to use the `CustomError` variant
/// to provide a more detailed error message.
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum Error {
    InvalidData,
    InvalidKey,
    RomSize,
    IncompatibleBootRom,
    NotImplemented,
    MissingOption(String),
    IoError(String),
    DataError(String),
    InvalidParameter(String),
    CustomError(String),
}

impl Error {
    pub fn description(&self) -> String {
        match self {
            Error::InvalidData => String::from("Invalid data format"),
            Error::InvalidKey => String::from("Invalid key"),
            Error::RomSize => String::from("Invalid ROM size"),
            Error::IncompatibleBootRom => String::from("Incompatible boot ROM"),
            Error::NotImplemented => String::from("Not implemented"),
            Error::MissingOption(option) => format!("Missing option: {option}"),
            Error::IoError(message) => format!("IO error: {message}"),
            Error::DataError(message) => format!("Data error: {message}"),
            Error::InvalidParameter(message) => format!("Invalid parameter: {message}"),
            Error::CustomError(message) => String::from(message),
        }
    }
}

impl error::Error for Error {
    fn description(&self) -> &str {
        match self {
            Error::InvalidData => "Invalid data format",
            Error::InvalidKey => "Invalid key",
            Error::RomSize => "Invalid ROM size",
            Error::IncompatibleBootRom => "Incompatible boot ROM",
            Error::NotImplemented => "Not implemented",
            Error::MissingOption(_) => "Missing option",
            Error::IoError(_) => "IO error",
            Error::DataError(_) => "Data error",
            Error::InvalidParameter(_) => "Invalid parameter",
            Error::CustomError(_) => "Custom error",
        }
    }

    fn cause(&self) -> Option<&dyn error::Error> {
        None
    }

    fn source(&self) -> Option<&(dyn error::Error + 'static)> {
        None
    }
}

impl Display for Error {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.description())
    }
}

impl From<io::Error> for Error {
    fn from(error: io::Error) -> Self {
        Error::IoError(error.to_string())
    }
}

impl From<FromUtf8Error> for Error {
    fn from(_error: FromUtf8Error) -> Self {
        Error::CustomError(String::from("From UTF8 error"))
    }
}

impl From<Error> for String {
    fn from(error: Error) -> Self {
        error.description()
    }
}

#[derive(Debug)]
pub struct TraceError {
    error: Error,
    backtrace: Backtrace,
}

impl TraceError {
    pub fn new(error: Error) -> Self {
        Self {
            error,
            backtrace: Backtrace::capture(),
        }
    }

    pub fn backtrace(&self) -> Option<&Backtrace> {
        Some(&self.backtrace)
    }
}

impl Display for TraceError {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.error.description())
    }
}