rchess 2.3.0

A Chess Library Written In Rust
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

use std::ops::Not;

/// The [`Color`] enum represents the color of a chess piece.
#[derive(Copy, Clone, Eq, PartialEq, Hash, Debug)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
pub enum Color {
    White,
    Black,
}

impl Color {
    /// Gets the character representation of the [`Color`].
    ///
    /// # Examples
    /// ```
    /// use rchess::Color;
    ///
    /// assert_eq!(Color::White.to_char(), 'w');
    /// assert_eq!(Color::Black.to_char(), 'b');
    /// ```
    #[inline]
    pub const fn to_char(self) -> char {
        match self {
            Color::White => 'w',
            Color::Black => 'b',
        }
    }

    /// Gets a [`usize`] used to index arrays by the [`Color`].
    ///
    /// # Examples
    /// ```no_run
    /// use rchess::Color;
    ///
    /// let mut color_pieces = [0;2];
    /// color_pieces[Color::White.index()] = 18;
    /// color_pieces[Color::Black.index()] = 18;
    /// ```
    #[inline]
    pub const fn index(&self) -> usize {
        *self as usize
    }
}

impl Not for Color {
    type Output = Self;

    /// Toggles the [`Color`] from white to black and vice-versa.
    ///
    /// # Examples
    /// ```
    /// use rchess::Color;
    ///
    /// assert_eq!(!Color::White, Color::Black);
    /// assert_eq!(!Color::Black, Color::White);
    /// ```
    #[inline]
    fn not(self) -> Self::Output {
        match self {
            Color::White => Color::Black,
            Color::Black => Color::White,
        }
    }
}