ruci 2.1.0

A UCI (Universal Chess Interface) crate.
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
146
147
148
149
150
151
152
153
154
155
156
157

extern crate alloc;

use alloc::string::String;
use alloc::borrow::{Cow, ToOwned};
use core::fmt::{Display, Formatter};
use crate::engine::pointers::IdParameterPointer;
use crate::errors::MessageParseError;
use crate::dev_macros::{from_str_parts, impl_message, message_from_impl};
use crate::{parsing, MessageParseErrorKind};
use super::{pointers, traits};

#[derive(Debug, Clone, PartialEq, Eq, Hash)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
/// Engine's identification information.
/// 
/// Sent after [`Uci`](crate::gui::Uci).
///
/// <https://backscattering.de/chess/uci/#engine-id>
pub enum Id<'a> {
    /// <https://backscattering.de/chess/uci/#engine-id-name>
    Name(Cow<'a, str>),
    /// <https://backscattering.de/chess/uci/#engine-id-author>
    Author(Cow<'a, str>),
    NameAndAuthor { name: Cow<'a, str>, author: Cow<'a, str> },
}

impl Id<'_> {
    #[must_use]
    /// Returns a new [`Id`] that is updated with values of the `new` parameter.
    ///
    /// # Examples
    /// ```rust
    /// # use pretty_assertions::assert_eq;
    /// # use ruci::engine::Id;
    /// let mut id = Id::Name("Carp".into());
    ///
    /// id = id.updated(Id::Name("Salmon".into()));
    /// assert_eq!(id, Id::Name("Salmon".into()));
    ///
    /// id = id.updated(Id::Author("Fischerman".into()));
    /// assert_eq!(
    ///     id,
    ///     Id::NameAndAuthor {
    ///         name: "Salmon".into(),
    ///         author: "Fischerman".into()
    ///     }
    /// );
    ///
    /// id = id.updated(Id::Author("Garry Chess".into()));
    /// assert_eq!(
    ///     id,
    ///     Id::NameAndAuthor {
    ///         name: "Salmon".into(),
    ///         author: "Garry Chess".into()
    ///     }
    /// );
    ///
    /// id = id.updated(Id::Name("Big Tuna".into()));
    /// assert_eq!(
    ///     id,
    ///     Id::NameAndAuthor {
    ///         name: "Big Tuna".into(),
    ///         author: "Garry Chess".into()
    ///     }
    /// );
    /// ```
    pub fn updated(self, new: Self) -> Self {
        match (self, new) {
            (Id::Author(_), Id::Author(author)) => Id::Author(author),
            (Id::Name(_), Id::Name(name)) => Id::Name(name),
            (
                Id::NameAndAuthor { .. } | Id::Author(_) | Id::Name(_),
                Id::NameAndAuthor { name, author },
            )
            | (Id::NameAndAuthor { author: _, name } | Id::Name(name), Id::Author(author))
            | (Id::NameAndAuthor { author, name: _ } | Id::Author(author), Id::Name(name)) => {
                Id::NameAndAuthor { name, author }
            }
        }
    }
}

impl_message!(Id<'_>);
message_from_impl!(engine Id<'a>);
from_str_parts!(impl Id<'_> for parts -> Result {
    let mut name = None::<String>;
    let mut author = None::<String>;
    let parameter_fn = |parameter, _, value: &str, parts| {
        match parameter {
            IdParameterPointer::Name => name = Some(value.to_owned()),
            IdParameterPointer::Author => author = Some(value.to_owned()),
        }
        
        Some(parts)
    };
    
    let mut value = String::with_capacity(200);
    parsing::apply_parameters(parts, &mut value, parameter_fn);

    #[allow(clippy::option_if_let_else)]
    if let Some(name) = name {
        if let Some(author) = author {
            Ok(Self::NameAndAuthor {
                name: Cow::Owned(name),
                author: Cow::Owned(author),
            })
        } else {
            Ok(Self::Name(Cow::Owned(name)))
        }
    } else if let Some(author) = author {
        Ok(Self::Author(Cow::Owned(author)))
    } else {
        Err(MessageParseError {
            expected: "name or author",
            kind: MessageParseErrorKind::MissingParameters
        })
    }
});

impl Display for Id<'_> {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        f.write_str("id ")?;

        match self {
            Self::Name(name) => write!(f, "name {name}")?,
            Self::Author(author) => write!(f, "author {author}")?,
            Self::NameAndAuthor { name, author } => {
                write!(f, "name {name} author {author}")?;
            }
        }

        Ok(())
    }
}

#[cfg(test)]
mod tests {
    use alloc::borrow::Cow;
    use super::Id;
    use alloc::string::ToString;
    use crate::dev_macros::{assert_from_str_message, assert_message_to_from_str, assert_message_to_str};

    #[test]
    fn to_from_str() {
        let m = Id::NameAndAuthor {
            name: Cow::from("Stockfish 16.1"),
            author: Cow::from("The stockfish developers"),
        };

        assert_message_to_from_str!(engine m, "id name Stockfish 16.1 author The stockfish developers");

        let m = Id::Name(Cow::from("Stockfish 16.1"));

        assert_from_str_message!(engine "id name Stockfish 16.1 \n ignored", Ok(m.clone()));
        assert_message_to_str!(engine m, "id name Stockfish 16.1");
    }
}