formatx 0.2.4

A macro for formatting non literal strings at runtime
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

/// Enum of different kinds of errors.
#[derive(Debug, Clone)]
pub enum ErrorKind {
    Parse,
    MissingValues,
    UnsupportedFormatSpec,
}

/// Error struct which implements [Error](std::error::Error) trait.
#[derive(Debug)]
pub struct Error {
    message: String,
    kind: ErrorKind,
}

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

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

impl Error {
    /// Create new parse error.
    pub(crate) fn new_parse(message: String) -> Self {
        Self {
            message,
            kind: ErrorKind::Parse,
        }
    }

    /// Create new missing values error.
    pub(crate) fn new_values(message: String) -> Self {
        Self {
            message,
            kind: ErrorKind::MissingValues,
        }
    }

    /// Create new unsupported format spec error.
    pub(crate) fn new_ufs(message: String) -> Self {
        Self {
            message,
            kind: ErrorKind::UnsupportedFormatSpec,
        }
    }

    /// Returns error message.
    pub fn message(&self) -> String {
        self.message.clone()
    }

    /// Returns `ErrorKind`
    pub fn kind(&self) -> ErrorKind {
        self.kind.clone()
    }
}