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

use thiserror::Error;

/// An error that occurs when parsing a FEN string
///
#[derive(Debug, Error, PartialEq)]
#[error("Invalid FEN: {fen}")]
pub struct FenError {
    /// The FEN string that caused the error
    pub fen: String,
}

impl FenError {
    /// Creates a new [FenError] with the given FEN string
    ///
    /// # Arguments
    /// * `fen` - The FEN string that caused the error
    ///
    /// # Example
    /// ```
    /// # use chess_lab::errors::FenError;
    /// let error = FenError::new("invalid_fen".to_string());
    /// ```
    ///
    pub fn new(fen: String) -> Self {
        FenError { fen }
    }
}

/// An error that occurs when an invalid piece representation is encountered
///
#[derive(Debug, Error, PartialEq)]
#[error("Invalid piece representation: {piece_repr}")]
pub struct PieceReprError {
    /// The piece character that caused the error
    pub piece_repr: char,
}

impl PieceReprError {
    /// Creates a new [PieceReprError] with the given [Piece](crate::core::Piece) representation
    ///
    /// # Arguments
    /// * `piece_repr` - The char representation of a [Piece](crate::core::Piece) that caused the error
    ///
    /// # Example
    /// ```
    /// # use chess_lab::errors::PieceReprError;
    /// let error = PieceReprError::new('X');
    /// ```
    ///
    pub fn new(piece_repr: char) -> Self {
        PieceReprError { piece_repr }
    }
}

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

    #[test]
    fn test_fen_error_creation() {
        let fen = "invalid_fen".to_string();
        let error = FenError::new(fen.clone());
        assert_eq!(error.fen, fen);
        assert_eq!(format!("{}", error), format!("Invalid FEN: {}", fen));
    }

    #[test]
    fn test_piece_repr_error_creation() {
        let piece_repr = 'X';
        let error = PieceReprError::new(piece_repr);
        assert_eq!(error.piece_repr, piece_repr);
        assert_eq!(
            format!("{}", error),
            format!("Invalid piece representation: {}", piece_repr)
        );
    }
}