keyset-key 0.3.2

Key type and functionality for keyset
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

/// An error parsing a KLE layout
#[derive(Debug)]
pub enum Error {
    /// An error in parsing the KLE JSON file
    JsonParseError(serde_json::Error),
    /// A key size not supported by `keyset`
    UnsupportedKeySize {
        /// The key's `w` value
        w: f64,
        /// The key's `h` value
        h: f64,
        /// The key's `x2` value
        x2: f64,
        /// The key's `y2` value
        y2: f64,
        /// The key's `w2` value
        w2: f64,
        /// The key's `h2` value
        h2: f64,
    },
}

impl std::fmt::Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::UnsupportedKeySize {
                w,
                h,
                x2,
                y2,
                w2,
                h2,
            } => write!(
                f,
                "unsupported non-standard key size \
                (w: {w:.2}, h: {h:.2}, x2: {x2:.2}, y2: {y2:.2}, w2: {w2:.2}, h2: {h2:.2}). \
                Note only ISO enter and stepped caps are supported as special cases"
            ),
            Self::JsonParseError(error) => error.fmt(f),
        }
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Self::UnsupportedKeySize { .. } => None,
            Self::JsonParseError(error) => Some(error),
        }
    }
}

impl From<serde_json::Error> for Error {
    fn from(error: serde_json::Error) -> Self {
        Self::JsonParseError(error)
    }
}

/// A [`std::result::Result`] with [`Error`] as it's error type
pub type Result<T> = std::result::Result<T, Error>;

#[cfg(test)]
pub mod tests {
    use std::error::Error as _;

    use assert_matches::assert_matches;

    use super::*;

    #[test]
    fn error_fmt() {
        let unsupported_key_size = Error::UnsupportedKeySize {
            w: 1.,
            h: 1.,
            x2: -0.25,
            y2: 0.,
            w2: 1.5,
            h2: 1.,
        };
        assert_eq!(
            format!("{unsupported_key_size}"),
            "unsupported non-standard key size (w: 1.00, h: 1.00, x2: -0.25, y2: 0.00, w2: 1.50, \
            h2: 1.00). Note only ISO enter and stepped caps are supported as special cases"
        );

        let json_parse_error: Error = serde_json::from_str::<i32>("error").unwrap_err().into();
        assert_eq!(
            format!("{json_parse_error}"),
            "expected value at line 1 column 1"
        );
    }

    #[test]
    fn error_source() {
        let unsupported_key_size = Error::UnsupportedKeySize {
            w: 1.,
            h: 1.,
            x2: -0.25,
            y2: 0.,
            w2: 1.5,
            h2: 1.,
        };
        assert!(unsupported_key_size.source().is_none());

        let json_parse_error: Error = serde_json::from_str::<i32>("error").unwrap_err().into();
        assert!(json_parse_error.source().is_some());
    }

    #[test]
    fn error_from() {
        let json_parse_error = serde_json::from_str::<i32>("error").unwrap_err();

        assert_matches!(json_parse_error.into(), Error::JsonParseError(..));
    }
}