dicechess-engine-scala
0.2.1-SNAPSHOT
API
Generated with
Dice Chess Engine
Dice Chess Engine
dicechess-engine-scala/dicechess.engine/dicechess.engine.domain/FenParser

FenParser

dicechess.engine.domain.FenParser
object FenParser

Parser and serialiser for Forsyth-Edwards Notation (FEN).

FEN encodes a complete chess position in a single ASCII string consisting of six space-separated fields:

<piece placement> <active color> <castling rights> <en-passant square> <half-move clock> <full-move number>

Example (starting position):

rnbqkbnr/pppppppp/8/8/8/8/PPPPPPPP/RNBQKBNR w KQkq - 0 1

Both parse and serialize are inverses of each other for any valid FEN string.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
FenParser.type

Members list

Value members

Concrete methods

def parse(fen: String): Either[String, GameState]

Parses a FEN string into a GameState.

Parses a FEN string into a GameState.

Validates the number of fields, the board layout (exactly 8 ranks, 8 files each), and each piece character. The half-move clock and full-move number default to 0 and 1 respectively when absent (short FEN).

Value parameters

fen

a FEN string with at least 4 space-separated fields

Attributes

Returns

Right(state) on success, or Left(errorMessage) describing the first parse failure

def serialize(state: GameState): String

Serialises a GameState back to a FEN string.

Serialises a GameState back to a FEN string.

Produces all six FEN fields. Piece placement is written rank-8-first (as required by the standard). This method is the inverse of parse: parse(serialize(s)) always yields Right(s) for a valid state.

Value parameters

state

the game state to encode

Attributes

Returns

a valid FEN string representing state

Concrete fields

val InitialPosition: String

FEN string for the standard chess starting position.

FEN string for the standard chess starting position.

Attributes

Generated with
Dice Chess Engine
Dice Chess Engine