Struct fen4::Board

pub struct Board {
    pub turn: TurnColor,
    pub dead: [bool; 4],
    pub castling_king: [bool; 4],
    pub castling_queen: [bool; 4],
    pub points: [u16; 4],
    pub draw_ply: usize,
    pub extra_options: Extra,
    pub board: [[Piece; 14]; 14],
}

The board representation of a 4 player chess game. Board can be converted to and from a String in the fen4 format

The fen4 file format is very similar to the fen format for normal chess, but it uses a larger board and uses prefixes for the color of pieces instead of capitalization.

It also includes the metadata about castling rights at the beginning rather than the end and has some differences in what metadata is stored.

The default position (with no whitespace) is:

    R-0,0,0,0-1,1,1,1-1,1,1,1-0,0,0,0-0-
    3,yR,yN,yB,yK,yQ,yB,yN,yR,3/
    3,yP,yP,yP,yP,yP,yP,yP,yP,3/
    14/
    bR,bP,10,gP,gR/
    bN,bP,10,gP,gN/
    bB,bP,10,gP,gB/
    bK,bP,10,gP,gQ/
    bQ,bP,10,gP,gK/
    bB,bP,10,gP,gB/
    bN,bP,10,gP,gN/
    bR,bP,10,gP,gR/
    14/
    3,rP,rP,rP,rP,rP,rP,rP,rP,3/
    3,rR,rN,rB,rQ,rK,rB,rN,rR,3

This format is shared for the Free-for-all and Teams mode so the dead and point metadata is useless in Teams, but is there because the format is shared with the FFA mode.

The metadata format is parsed into the struct as shown here:

    v turn    v king          v points  v extra
    R-1,0,0,0-1,1,1,0-0,1,0,0-1,2,3,4-0-{'lifes':(2,2,2,2)}-
      ^ dead          ^ queen         ^ ply since last pawn move or capture

It starts with a Color, followed by 4 integer arrays of length 4, followed by 0, followed by an optional extra data section. Each of these is separated by a ‘-’. All of the arrays are information about the players with the leftmost data about Red and proceding clockwise.

Fields

turn: TurnColor

dead: [bool; 4]

castling_king: [bool; 4]

castling_queen: [bool; 4]

points: [u16; 4]

draw_ply: usize

extra_options: Extra

board: [[Piece; 14]; 14]

Implementations

impl Board

pub fn chess960(n: u16) -> Board

Trait Implementations

impl Clone for Board

fn clone(&self) -> Board

Returns a copy 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

Returns the “default value” for a type.

impl Display for Board

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

Formats the value using the given formatter.

impl FromStr for Board

type Err = BoardParseError

The associated error which can be returned from parsing.

fn from_str(fen: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

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, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<Board> for Board

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

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

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

This method tests for !=.

impl Eq for Board

impl StructuralEq for Board

impl StructuralPartialEq for Board