chess-lab 0.2.1

Chess library with multiple variants and FEN/PGN support.
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 thiserror::Error;

use crate::core::Move;

/// Errors that can occur when trying to move a [Piece](crate::core::Piece)
///
#[non_exhaustive]
#[derive(Debug, Error, PartialEq)]
pub enum MoveError {
    /// The move is invalid
    #[error("Invalid move: {0}")]
    Invalid(String),
    /// The move is illegal
    #[error("Illegal move: {0}")]
    Illegal(String),
    /// The move is ambiguous
    #[error("Ambiguous move: {0}")]
    Ambiguous(String),
}

/// Errors that can occur when trying to move a [Piece](crate::core::Piece)
///
#[derive(Debug, Error)]
#[error("Error moving piece: {error}")]
pub struct MoveInfoError {
    /// The error message
    pub error: String,
    /// The move that caused the error
    pub mov: Move,
}

impl MoveInfoError {
    /// Creates a new [MoveInfoError] with the given error message and [Move]
    ///
    /// # Arguments
    /// * `error` - The error message
    /// * `mov` - The [Move] that caused the error
    ///
    /// # Example
    /// ```
    /// # use chess_lab::errors::MoveInfoError;
    /// use chess_lab::core::{Color, PieceType, Position, Move, MoveType, Piece};
    ///
    /// let piece = Piece::new(Color::White, PieceType::Pawn);
    /// let from = Position::new(4, 1).unwrap();
    /// let to = Position::new(4, 3).unwrap();
    /// let move_type = MoveType::Normal {
    ///     capture: false,
    ///     promotion: None,
    /// };
    /// let captured_piece = None;
    /// let rook_from = None;
    /// let ambiguity = (false, false);
    ///
    /// let mov = Move::new(
    ///     piece,
    ///     from,
    ///     to,
    ///     move_type,
    ///     captured_piece,
    ///     rook_from,
    ///     ambiguity,
    ///     false,
    ///     false
    /// ).unwrap();
    /// let error = MoveInfoError::new("Invalid move".to_string(), mov);
    /// ```
    ///
    pub fn new(error: String, mov: Move) -> Self {
        MoveInfoError { error, mov }
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_move_info_error_creation() {
        let piece =
            crate::core::Piece::new(crate::core::Color::White, crate::core::PieceType::Pawn);
        let from = crate::core::Position::new(4, 1).unwrap();
        let to = crate::core::Position::new(4, 3).unwrap();
        let move_type = crate::core::MoveType::Normal {
            capture: false,
            promotion: None,
        };
        let captured_piece = None;
        let rook_from = None;
        let ambiguity = (false, false);

        let mov = Move::new(
            piece,
            from,
            to,
            move_type,
            captured_piece,
            rook_from,
            ambiguity,
            false,
            false,
        )
        .unwrap();
        let error = MoveInfoError::new("Invalid move".to_string(), mov.clone());

        assert_eq!(error.error, "Invalid move");
        assert_eq!(error.mov, mov);
    }
}