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
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

#![deny(clippy::unwrap_used)]
#![deny(clippy::expect_used)]
#![warn(clippy::pedantic)]
#![warn(clippy::nursery)]
#![allow(clippy::literal_string_with_formatting_args)]
#![deny(clippy::unwrap_used, clippy::expect_used)]
#![allow(clippy::must_use_candidate)]
#![warn(missing_debug_implementations)]
#![warn(missing_copy_implementations)]
#![allow(clippy::module_name_repetitions)]
#![warn(
    clippy::arithmetic_side_effects,
    clippy::unreachable,
    clippy::unchecked_duration_subtraction,
    clippy::todo,
    clippy::string_slice,
    clippy::panic_in_result_fn,
    clippy::indexing_slicing,
    clippy::panic,
    clippy::exit,
    clippy::as_conversions,
    clippy::large_futures,
    clippy::large_stack_arrays,
    clippy::large_stack_frames,
    clippy::modulo_one,
    clippy::mem_replace_with_uninit,
    clippy::iterator_step_by_zero,
    clippy::invalid_regex,
    clippy::print_stdout,
    clippy::print_stderr
)]
#![doc = include_str!("../README.md")]

mod visitor;

dry_mods::mods! {
    pub mod eco, date, round;
    mod pub use
    eco_category,
    move_number,
    outcome,
    pgn,
    raw_header_owned,
    movetext;
}

pub use date::Date;
pub use eco::Eco;
pub use round::Round;

/// These are samples I use in tests and benchmarks.
/// They're public because benchmarks get the same crate you get.
#[doc(hidden)]
pub mod samples;
pub use movetext::Movetext;

/// Create a [`Variation`](crate::movetext::Variation) out of SAN literals.
///
/// # Syntax
/// See the `samples.rs` file in the repository.
///
/// # Panics
/// See [`SanPlus::from_ascii`](shakmaty::san::SanPlus::from_ascii).
#[macro_export]
macro_rules! variation {
    (_turn: $san:literal) => {
        $crate::movetext::SanWithVariations { san: ::shakmaty::san::SanPlus::from_ascii($san).unwrap(), variations: vec![] }
    };
    (_turn: ($san:literal, [$($vars:tt),+])) => {
        $crate::movetext::SanWithVariations { san: ::shakmaty::san::SanPlus::from_ascii($san).unwrap(), variations: vec![$($crate::variation! $vars),+] }
    };
    {$($turn:tt),+} => {
        $crate::movetext::Variation(vec![$($crate::variation!(_turn: $turn)),+])
    };
}

/// Create a [`Sans`](crate::movetext::Sans) out of a list SAN literals.
///
/// # Panics
/// See [`SanPlus::from_ascii`](shakmaty::san::SanPlus::from_ascii).
#[macro_export]
macro_rules! sans {
    ($($san:literal),+) => {
        $crate::movetext::Sans(vec![$(::shakmaty::san::SanPlus::from_ascii($san).unwrap()),+])
    };
}

#[cfg(feature = "serde")]
macro_rules! serde_display_from_str {
    ($type:ident) => {
        impl serde::Serialize for $type {
            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: serde::Serializer,
            {
                serializer.serialize_str(self.to_string().as_str())
            }
        }

        impl<'de> serde::Deserialize<'de> for $type {
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: serde::Deserializer<'de>,
            {
                use serde::de::Error;
                <&str>::deserialize(deserializer)?
                    .parse()
                    .map_err(D::Error::custom)
            }
        }
    };

    ($type:ident<$g:ident: Display + FromStr>) => {
        impl<$g> serde::Serialize for $type<$g>
        where
            $g: std::fmt::Display + std::str::FromStr,
        {
            fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
            where
                S: serde::Serializer,
            {
                serializer.serialize_str(self.to_string().as_str())
            }
        }

        impl<'de, $g> serde::Deserialize<'de> for $type<$g>
        where
            $g: std::fmt::Display + std::str::FromStr,
        {
            fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
            where
                D: serde::Deserializer<'de>,
            {
                <&str>::deserialize(deserializer)?
                    .parse()
                    .map_err(serde::de::Error::custom)
            }
        }
    };
}

#[cfg(feature = "serde")]
pub(crate) use serde_display_from_str;