Struct shakmaty::fen::Fen

pub struct Fen {
    pub board: Board,
    pub pockets: Option<Material>,
    pub turn: Color,
    pub castling_rights: Bitboard,
    pub ep_square: Option<Square>,
    pub remaining_checks: Option<RemainingChecks>,
    pub halfmoves: u32,
    pub fullmoves: NonZeroU32,
}

A parsed FEN.

Fields

board: Board

pockets: Option<Material>

turn: Color

castling_rights: Bitboard

ep_square: Option<Square>

remaining_checks: Option<RemainingChecks>

halfmoves: u32

fullmoves: NonZeroU32

Implementations

impl Fen

pub fn empty() -> Fen

The FEN of the empty position 8/8/8/8/8/8/8/8 w - - 0 1.

pub fn position<P: FromSetup>(
    &self,
    mode: CastlingMode
) -> Result<P, PositionError<P>>

Set up a Position.

Errors

Returns PositionError if the setup is not a legal position.

pub fn from_ascii(fen: &[u8]) -> Result<Fen, ParseFenError>

Parses a FEN.

Errors

Returns ParseFenError if the input is not a valid FEN.

Example

use shakmaty::fen::Fen;

let fen = Fen::from_ascii(b"rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1")?;
assert_eq!(fen, Fen::default());

pub fn from_setup<S: Setup>(setup: &S) -> Fen

Trait Implementations

impl Clone for Fen

pub fn clone(&self) -> Fen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Fen

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

Formats the value using the given formatter.

impl Default for Fen

pub fn default() -> Fen

Returns the "default value" for a type.

impl Display for Fen

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

Formats the value using the given formatter.

impl Eq for Fen

impl FromStr for Fen

type Err = ParseFenError

The associated error which can be returned from parsing.

pub fn from_str(fen: &str) -> Result<Fen, ParseFenError>

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

impl PartialEq<Fen> for Fen

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

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

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

This method tests for !=.

impl Setup for Fen

pub fn board(&self) -> &Board

Piece positions on the board.

pub fn pockets(&self) -> Option<&Material>

Pockets in chess variants like Crazyhouse.

pub fn turn(&self) -> Color

Side to move.

pub fn castling_rights(&self) -> Bitboard

Castling rights in terms of corresponding rook positions.

pub fn ep_square(&self) -> Option<Square>

En passant target square on the third or sixth rank.

pub fn remaining_checks(&self) -> Option<&RemainingChecks>

Remaining checks in chess variants like Three-Check.

pub fn halfmoves(&self) -> u32

Number of half-moves since the last capture or pawn move.

pub fn fullmoves(&self) -> NonZeroU32

Current move number.

pub fn us(&self) -> Bitboard

Squares occupied by the side to move.

pub fn our(&self, role: Role) -> Bitboard

Squares occupied by a given piece type of the side to move.

pub fn them(&self) -> Bitboard

Squares occupied by the waiting player.

pub fn their(&self, role: Role) -> Bitboard

Squares occupied by a given piece type of the waiting player.

impl StructuralEq for Fen

impl StructuralPartialEq for Fen