Enum chess_engine::Move

pub enum Move {
    QueenSideCastle,
    KingSideCastle,
    Piece(Position, Position),
    Resign,
}

A move that can be applied to a board. When applied to a board, the board assumes that the move is being applied for the current turn's player.

Variants

QueenSideCastle

If the current player is white, move the king to the C1 square, and the kingside rook to the D1 square. If the current player is black, however, move the king to the C8 square, and the kingside rook to the D8 square.

Castling can only be performed if

1. The king has not moved at all since the game began
2. The respective rook (kingside or queenside) has also not moved
3. The square adjacent to the king on the respective side is not threatened by an enemy piece

If all of these conditions are satisfied, castling is a legal move

KingSideCastle

If the current player is white, move the king to the G1 square, and the kingside rook to the F1 square. If the current player is black, however, move the king to the G8 square, and the kingside rook to the F8 square.

Piece(Position, Position)

Move a piece from one square to another. This can allow the player to capture another piece, by simply moving a piece to the position of an enemy piece.

Additionally, this can be used to en-passant capture, even though the en-passant square itself does not contain any capturable pieces.

En-passant captures MUST be performed with a pawn, upon an enemy pawn that has just surpassed it by move two squares. An en-passant capture must also be performed the turn immediately after the enemy pawn surpasses the allied pawn. After the one turn a player has to en-passant capture, the en-passant square is forgotten and can no longer be used.

Resign

When played by another player, it awards victory to the other.

Implementations

impl Move

pub fn parse(repr: String) -> Result<Self, String>

Try to parse a Move from a string.

Possible valid formats include:

• "resign"
• "resigns"
• "castle queenside"
• "O-O-O" (correct notation)
• "o-o-o" (incorrect notation, but will accept)
• "0-0-0" (incorrect notation, but will accept)
• "castle kingside"
• "O-O" (correct notation)
• "o-o" (incorrect notation, but will accept)
• "0-0" (incorrect notation, but will accept)
• "e2e4"
• "e2 e4"
• "e2 to e4"

Parsing a move such as "knight to e4" or "Qxe4" will NOT work.

Trait Implementations

impl Clone for Move

fn clone(&self) -> Move

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Move

impl Debug for Move

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

Formats the value using the given formatter.

impl Display for Move

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

Formats the value using the given formatter.

impl Eq for Move

impl Ord for Move

fn cmp(&self, other: &Move) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Move> for Move

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl PartialOrd<Move> for Move

fn partial_cmp(&self, other: &Move) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Move) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Move) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Move) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Move) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for Move

impl StructuralPartialEq for Move

impl TryFrom<String> for Move

Try to parse a Move from a string.

Possible valid formats include:

• "resign"
• "resigns"
• "castle queenside"
• "O-O-O" (correct notation)
• "o-o-o" (incorrect notation, but will accept)
• "0-0-0" (incorrect notation, but will accept)
• "castle kingside"
• "O-O" (correct notation)
• "o-o" (incorrect notation, but will accept)
• "0-0" (incorrect notation, but will accept)
• "e2e4"
• "e2 e4"
• "e2 to e4"

Parsing a move such as "knight to e4" or "Qxe4" will NOT work.

type Error = String

The type returned in the event of a conversion error.

fn try_from(repr: String) -> Result<Self, Self::Error>

Performs the conversion.