Struct Board 

pub struct Board { /* private fields */ }

The structure for a chessboard/game

Implementations

impl Board

pub fn from_fen(fen: Fen) -> Self

Constructs a Board from a Fen object.

pub fn to_fen(&self) -> Fen

Returns a Fen object representing the Board.

pub fn move_to_san(&self, move_: Move) -> Result<String, IllegalMoveError>

Represents a Move in SAN, returning an error if the move is illegal.

pub fn san_to_move(&self, san: &str) -> Result<Move, InvalidSanMoveError>

Constructs a Move from a SAN representation, returning an error if it is invalid or illegal.

pub fn gen_legal_moves(&self) -> Vec<Move>

Generates the legal moves in the position.

pub fn is_legal(&self, move_: Move) -> bool

Checks whether a move is legal in the position.

pub fn is_capture(&self, move_: Move) -> Result<bool, IllegalMoveError>

Checks whether the given move is a capture, returning an error if the move is illegal.

pub fn make_move(&mut self, move_: Move) -> Result<(), IllegalMoveError>

Plays on the board the given move, returning an error if the move is illegal.

pub fn make_move_uci(&mut self, uci: &str) -> Result<(), InvalidUciMoveError>

Attempts to parse the UCI representation of a move and play it on the board, returning an error if the move is invalid or illegal.

pub fn make_move_san(&mut self, san: &str) -> Result<(), InvalidSanMoveError>

Attempts to interpret the SAN representation of a move and play it on the board, returning an error if it is invalid or illegal.

pub fn make_moves_uci(&mut self, line: &str) -> Result<(), InvalidUciMoveError>

Attempts to play the given line of UCI moves (separated by spaces, excluding move numbers) on the board, returning an error if any move is illegal. If an error is returned, the board is left unchanged, i.e. no moves are played on the board.

pub fn make_moves_san(&mut self, line: &str) -> Result<(), InvalidSanMoveError>

Attempts to play the given line of SAN moves (separated by spaces, excluding move numbers) on the board, returning an error if any move is illegal. If an error is returned, the board is left unchanged, i.e. no moves are played on the board.

pub fn undo_move(&mut self) -> Result<(), NoMovesPlayedError>

Undoes the most recent move, returning an error if no moves have been played. Note that if the game had ended, calling this function sets the game to ongoing again. This will override any resignation or draw by agreement.

pub fn is_ongoing(&self) -> bool

Checks whether the game is still ongoing.

pub fn is_game_over(&self) -> bool

Checks whether the game is over.

pub fn game_result(&self) -> Option<GameResult>

Returns an optional game result (None if the game is ongoing).

pub fn halfmove_clock(&self) -> usize

Returns the number of halfmoves played since the last pawn push or capture.

pub fn fullmove_number(&self) -> usize

Returns the fullmove number.

pub fn is_threefold_repetition(&self) -> bool

Checks whether a threefold repetition of the position has occurred.

pub fn is_fivefold_repetition(&self) -> bool

Checks whether a fivefold repetition of the position has occurred.

pub fn is_fifty_move_rule(&self) -> bool

Checks whether a draw can be claimed by the fifty-move rule.

pub fn is_seventy_five_move_rule(&self) -> bool

Checks whether the game is drawn by the seventy-five-move rule.

pub fn is_stalemate(&self) -> bool

Checks whether the game is drawn by stalemate. Use Board::stalemated_side to know which side is in stalemate.

pub fn is_insufficient_material(&self) -> bool

Checks whether the game is drawn by insufficient material.

rschess defines insufficient material as any of the following scenarios:

• King and knight vs. king
• King and zero or more bishops vs. king and zero or more bishops where all the bishops are on the same color complex

pub fn is_sufficient_material(&self) -> bool

Checks whether there is sufficient checkmating material on the board.

pub fn is_check(&self) -> bool

Checks whether any side is in check (a checkmate is also considered a check). Use Board::checked_side to know which side is in check.

pub fn is_checkmate(&self) -> bool

Checks whether any side is in checkmate. Use Board::checkmated_side to know which side is in checkmate.

pub fn stalemated_side(&self) -> Option<Color>

Returns an optional Color representing the side in stalemate (None if neither side is in stalemate).

pub fn checked_side(&self) -> Option<Color>

Returns an optional Color representing the side in check (None if neither side is in check).

pub fn checkmated_side(&self) -> Option<Color>

Returns an optional Color representing the side in checkmate (None if neither side is in checkmate).

pub fn pretty_print(&self, perspective: Color, ascii: bool) -> String

Pretty-prints the position to a string, from the perspective of the side perspective. If ascii is true, this function uses piece characters like ‘K’ and ‘p’ instead of characters like ‘♔’ and ‘♟’.

pub fn side_to_move(&self) -> Color

Returns which side’s turn it is to move.

pub fn occupant_of_square( &self, file: char, rank: char, ) -> Result<Option<Piece>, InvalidSquareNameError>

Returns the occupant of a square, or an error if the square name is invalid.

pub fn resign(&mut self, side: Color) -> Result<(), GameOverError>

Resigns the game for a certain side, if the game is ongoing. Currently, this function should also be used to represent a loss by timeout.

pub fn agree_draw(&mut self) -> Result<(), GameOverError>

Makes a draw by agreement, if the game is ongoing. Currently, this function should also be used to represent a draw claim.

pub fn resigned_side(&self) -> Option<Color>

Returns an optional Color representing the side that has resigned (None if neither side has resigned).

pub fn draw_agreed(&self) -> bool

Checks whether a draw has been agreed upon.

pub fn initial_fen(&self) -> &Fen

Returns the initial FEN of the game.

pub fn gen_movetext(&self) -> String

Generates the SAN movetext of the game thus far (excluding the game result).

pub fn position(&self) -> &Position

Returns the current Position on the board.

Trait Implementations

impl Clone for Board

fn clone(&self) -> Board

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Board

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Board

fn default() -> Self

Constructs a Board with the starting position for a chess game.

impl Display for Board

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Pretty-prints the position on the board from the perspective of the side whose turn it is to move.

impl Eq for Board

impl Hash for Board

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Board

fn eq(&self, other: &Board) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Board