rschess 2.0.5

A Rust chess library with the aim to be as feature-rich as possible
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

//! Contains all rschess error types.

use super::Move;
use thiserror::Error;

/// Conveys that the given FEN is invalid.
#[derive(Error, Debug)]
pub enum InvalidFenError {
    #[error("Invalid FEN: expected six fields separated by a space")]
    SixFields,
    #[error("Invalid FEN board data: {0}")]
    BoardData(String),
    #[error("Invalid FEN: active color must be 'w' or 'b'")]
    ActiveColor,
    #[error("Invalid FEN castling rights: {0}")]
    CastlingRights(String),
    #[error("Invalid FEN en passant target square: this field must be '-' or a valid square name on the 3rd or 6th rank")]
    EnPassantTargetSquare,
    #[error("Invalid FEN halfmove clock: halfmove clock must be in the range 0..=150")]
    HalfmoveClock,
    #[error("Invalid FEN fullmove number: fullmove number must be in the range 1..")]
    FullmoveNumber,
}

/// Conveys that the given piece character is invalid.
#[derive(Error, Debug)]
#[error("Invalid piece character: '{0}'; a valid piece character must be /[KkQqRrBbNnPp]/gi")]
pub struct InvalidPieceCharacterError(pub char);

/// Conveys that the given UCI text is invalid.
#[derive(Error, Debug)]
pub enum InvalidUciError {
    #[error("Invalid UCI: expected UCI to be 4 to 5 characters long")]
    Length,
    #[error("Invalid UCI: '{0}{1}' is not a valid square name")]
    InvalidSquareName(char, char),
    #[error("Invalid UCI: '{0}' is not a valid piece character for promotion")]
    InvalidPieceType(char),
}

/// Conveys that the given color character is invalid.
#[derive(Error, Debug)]
#[error("Invalid color character: '{0}', a valid color character must be 'w' or 'b'")]
pub struct InvalidColorCharacterError(pub String);

/// Conveys that the given move is illegal.
#[derive(Error, Debug)]
#[error("Illegal move: {0}")]
pub struct IllegalMoveError(pub Move);

/// Conveys that no moves have been played.
#[derive(Error, Debug)]
#[error("No moves have been played, so the requested action cannot be carried out.")]
pub struct NoMovesPlayedError;

/// Conveys that the given UCI move is either invalid or illegal.
#[derive(Error, Debug)]
pub enum InvalidUciMoveError {
    #[error("Invalid UCI move: '{0}' is not valid UCI")]
    InvalidUci(String),
    #[error("Invalid UCI move: '{0}' is illegal in this position")]
    IllegalMove(String),
}

/// Conveys that the given SAN move is either invalid or illegal.
#[derive(Error, Debug)]
#[error("Invalid SAN move: '{0}' is either invalid or illegal in this position")]
pub struct InvalidSanMoveError(pub String);

/// Conveys that the given square name is invalid.
#[derive(Error, Debug)]
#[error("Invalid square name: {0}{1}")]
pub struct InvalidSquareNameError(pub char, pub char);

/// Conveys that the given square index is invalid.
#[derive(Error, Debug)]
#[error("Invalid square index: {0}, a square index must be in the range 0..=63")]
pub struct InvalidSquareIndexError(pub usize);

/// Conveys that this action cannot be taken after the game is over.
#[derive(Error, Debug)]
pub enum GameOverError {
    #[error("Game over: a player cannot resign when the game is over")]
    Resignation,
    #[error("Game over: players cannot agree to a draw when the game is over")]
    AgreementDraw,
}

/// Conveys that the given PGN text is invalid.
#[cfg(feature = "pgn")]
#[derive(Error, Debug)]
pub enum InvalidPgnError {
    #[error("Invalid PGN: the elements are incorrectly organized, {0}")]
    OrderOfElements(String),
    #[error("Invalid PGN: move numbers cannot be less than 1, and successive move numbers must differ by 1")]
    InvalidMoveNumber,
    #[error("Invalid PGN: variations (and annotations) are not yet supported; all movetext must include only fullmoves and a halfmove is only allowed on the last move")]
    NoAnnotations,
    #[error("Invalid PGN: tag pairs must follow the Seven Tag Roster (https://en.wikipedia.org/wiki/Portable_Game_Notation#Seven_Tag_Roster)")]
    SevenTagRoster,
    #[error("Invalid PGN: {0}")]
    InvalidMove(InvalidSanMoveError),
    #[error("Invalid PGN: invalid result, {0}")]
    InvalidResult(String),
}

/// Conveys that the given hex color is invalid.
#[cfg(feature = "img")]
#[derive(Error, Debug)]
#[error("Invalid hex: '{0}' is not a valid hex color")]
pub struct InvalidHexError(pub String);

/// Conveys that the given position image properties are invalid.
#[cfg(feature = "img")]
#[derive(Error, Debug)]
pub enum InvalidPositionImagePropertiesError {
    #[error("Invalid position image properties: the size {0} must be at least 8 pixels")]
    InvalidSize(usize),
    #[error("Invalid position image properties: '{0}' is not a recognized built-in piece set")]
    InvalidBuiltinPieceSet(String),
    #[error("Invalid position image properties: the piece set '{0:?}' does not contain all the necessary pieces")]
    InvalidCustomPieceSet(super::img::PieceSet),
}