rpgn 0.8.1

A crate for parsing PGNs (Portable [Chess] Game Notation).
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

use std::convert::TryFrom;
use std::fmt::{Display, Formatter};

#[derive(Copy, Clone, Debug, PartialEq, Eq, Hash)]
pub enum EcoCategory {
    A,
    B,
    C,
    D,
    E
}

#[cfg(feature = "serde")]
impl serde::Serialize for EcoCategory {
    fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
    where
        S: serde::Serializer,
    {
        serializer.serialize_char((*self).into())
    }
}

#[cfg(feature = "serde")]
impl<'de> serde::Deserialize<'de> for EcoCategory {
    fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
    where
        D: serde::Deserializer<'de>,
    {
        use serde::de::Error;
        let c = char::deserialize(deserializer)?;
        
        Self::try_from(c).map_err(D::Error::custom)
    }
}

#[derive(Clone, Debug, PartialEq, Copy, Eq, Hash)]
pub struct ParseError;

impl Display for ParseError {
    fn fmt(&self, f: &mut Formatter) -> Result<(), std::fmt::Error> {
        f.write_str("string did not match any of the following ECO categories: A, B, C, D, E")
    }
}

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

impl TryFrom<char> for EcoCategory {
    type Error = ParseError;

    /// # Errors
    /// The string doesn't match any of these:
    /// - `A`
    /// - `B`
    /// - `C`
    /// - `D`
    /// - `E`
    fn try_from(value: char) -> Result<Self, Self::Error> {
        match value.to_ascii_uppercase() {
            'A' => Ok(Self::A),
            'B' => Ok(Self::B),
            'C' => Ok(Self::C),
            'D' => Ok(Self::D),
            'E' => Ok(Self::E),
            _ => Err(ParseError),
        }
    }
}

// Clippy: From<char> is impossible to implement because it might fail, that's why I used TryFrom<char> instead.
#[allow(clippy::from_over_into)]
impl Into<char> for EcoCategory {
    fn into(self) -> char {
        match self {
            Self::A => 'A',
            Self::B => 'B',
            Self::C => 'C',
            Self::D => 'D',
            Self::E => 'E',
        }
    }
}

#[cfg(test)]
#[allow(clippy::unwrap_used, clippy::expect_used)]
mod tests {
    use super::*;
    use pretty_assertions::{assert_eq};
    use proptest::proptest;
    use test_case::test_case;
    use std::str::FromStr;

    #[test_case(EcoCategory::A, 'A')]
    #[test_case(EcoCategory::B, 'B')]
    #[test_case(EcoCategory::C, 'C')]
    #[test_case(EcoCategory::D, 'D')]
    #[test_case(EcoCategory::E, 'E')]
    fn to_char_from_char(eco_category: EcoCategory, eco_category_char: char) {
        assert_eq!(EcoCategory::try_from(eco_category_char.to_ascii_lowercase()).unwrap(), eco_category);
        assert_eq!(EcoCategory::try_from(eco_category_char.to_ascii_uppercase()).unwrap(), eco_category);
        assert_eq!(<EcoCategory as Into<char>>::into(eco_category), eco_category_char.to_ascii_uppercase());
    }

    proptest! {
        #[test]
        fn from_invalid_char(c in "[^a-eA-E]") {
            assert!(EcoCategory::try_from(char::from_str(&c).unwrap()).is_err());
        }
    }
}