Struct chess_turn_engine::AvailableTurn

pub struct AvailableTurn {
    pub src: String,
    pub dst: String,
    pub piece: String,
    pub captured: Option<String>,
    /* private fields */
}

Data which describes the turn that can be played.

In case of a castling turn, king’s source and destination squares will be provided.

Exact turn written in the algebraic chess notation format contains spoilers, so it should be fetched via get_turn function.

Fields

src: String

Source square

dst: String

Destination square

piece: String

Piece making the move

captured: Option<String>

Captured piece

Implementations

impl AvailableTurn

pub fn new(
    src: String,
    dst: String,
    piece: String,
    captured: Option<String>,
    turn: String
) -> AvailableTurn

Create AvailableTurn

pub fn get_turn(&self) -> &str

Fetch turn written in chess notation format

Turn info contains spoilers about the turn (checkmate or check), that’s why the turn string is not publicly provided in the struct

Trait Implementations

impl Display for AvailableTurn

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

Formats the value using the given formatter.