hyeong 0.1.3

Hyeo-ung Programming Language Compiler
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
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145

use std::fmt;
use std::fmt::{Debug, Display};
use std::io::ErrorKind;
use std::string::FromUtf8Error;

/// Error structure of this program
#[derive(Clone, Debug)]
pub struct Error {
    msg: String,
    note: String,
}

impl Error {
    /// Makes new `Error`
    ///
    /// # Examples
    ///
    /// ```
    /// use hyeong::util::error::Error;
    ///
    /// let e = Error::new("hello", "world");
    /// assert_eq!("hello", e.get_msg());
    /// assert_eq!("world", e.get_note());
    /// ```
    pub fn new<A, B>(msg: A, note: B) -> Error
    where
        A: Into<String>,
        B: Into<String>,
    {
        Error {
            msg: msg.into(),
            note: note.into(),
        }
    }

    /// Makes `Error` from other error
    ///
    /// # Examples
    ///
    /// ```
    /// use hyeong::util::error::Error;
    ///
    /// let io_error = std::io::Error::new(std::io::ErrorKind::Other, "hello");
    /// let s = format!("{:?}", io_error);
    /// let error = Error::from(io_error, "world");
    ///
    /// assert_eq!(s, error.get_msg());
    /// assert_eq!("world", error.get_note());
    /// ```
    pub fn from<T, S>(err: T, note: S) -> Error
    where
        T: Debug,
        S: Into<String>,
    {
        Error::new(format!("{:?}", err), note)
    }

    /// Return msg
    ///
    /// # Examples
    ///
    /// ```
    /// use hyeong::util::error::Error;
    ///
    /// let e = Error::new("hello", "world");
    /// assert_eq!("hello", e.get_msg());
    /// ```
    pub fn get_msg(&self) -> String {
        self.msg.clone()
    }

    /// Return note
    ///
    /// # Examples
    ///
    /// ```
    /// use hyeong::util::error::Error;
    ///
    /// let e = Error::new("hello", "world");
    /// assert_eq!("world", e.get_note());
    /// ```
    pub fn get_note(&self) -> String {
        self.note.clone()
    }
}

impl Display for Error {
    /// Display impl for `Error`
    ///
    /// # Examples
    ///
    /// ```
    /// use hyeong::util::error::Error;
    ///
    /// let e = Error::new("hello", "");
    ///
    /// assert_eq!("hello", format!("{}", e));
    /// ```
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{}", self.msg)
    }
}

impl std::error::Error for Error {}

impl From<std::io::Error> for Error {
    /// From impl for `Error`
    fn from(e: std::io::Error) -> Self {
        Self::from(e, "")
    }
}

impl From<std::string::FromUtf8Error> for Error {
    /// From impl for `Error`
    fn from(e: FromUtf8Error) -> Self {
        Self::from(e, "")
    }
}

impl From<Error> for std::io::Error {
    /// From impl for `std::io::Error`
    fn from(e: Error) -> Self {
        Self::new(ErrorKind::Other, e)
    }
}

/// Make new `Error` adding note
///
/// # Examples
///
/// ```
/// use hyeong::util::error;
///
/// let io_error = Result::<(), _>::Err(std::io::Error::new(std::io::ErrorKind::Other, "hello"));
/// let e = error::add_note(io_error, "world").err().unwrap();
///
/// assert_eq!("world", e.get_note());
/// ```
pub fn add_note<T, E, S>(result: Result<T, E>, note: S) -> Result<T, Error>
where
    E: Debug,
    S: Into<String>,
{
    result.map_err(|e| Error::from(e, note))
}