Struct shakmaty::fen::Fen

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

A parsed FEN.

Fields

board: Board

pockets: Option<Pockets>

turn: Color

castling_rights: Bitboard

ep_square: Option<Square>

remaining_checks: Option<RemainingChecks>

halfmove_clock: u32

fullmoves: u32

Methods

impl Fen

fn empty() -> Fen

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

fn position<P: Position>(&self) -> Result<P, PositionError>

Set up a Position.

Errors

Returns PositionError if the setup is not a legal position.

fn from_bytes(fen: &[u8]) -> Result<Fen, FenError>

Parses a FEN.

Errors

Returns FenError if the input is not a valid FEN.

Example

use shakmaty::fen::Fen;

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

Trait Implementations

impl Clone for Fen

fn clone(&self) -> Fen

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Fen

impl PartialEq for Fen

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

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

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

This method tests for !=.

impl Debug for Fen

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Setup for Fen

fn board(&self) -> &Board

fn pockets(&self) -> Option<&Pockets>

fn turn(&self) -> Color

fn castling_rights(&self) -> Bitboard

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

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

fn halfmove_clock(&self) -> u32

fn fullmoves(&self) -> u32

fn us(&self) -> Bitboard

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

fn them(&self) -> Bitboard

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

impl Default for Fen

fn default() -> Fen

Returns the "default value" for a type.

impl FromStr for Fen

type Err = FenError

The associated error which can be returned from parsing.

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

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

impl Display for Fen

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

Formats the value using the given formatter.