Struct shakmaty::Setup

pub struct Setup {
    pub board: Board,
    pub promoted: Bitboard,
    pub pockets: Option<ByColor<ByRole<u8>>>,
    pub turn: Color,
    pub castling_rights: Bitboard,
    pub ep_square: Option<Square>,
    pub remaining_checks: Option<ByColor<RemainingChecks>>,
    pub halfmoves: u32,
    pub fullmoves: NonZeroU32,
}

A not necessarily legal position.

Fields

board: Board

Piece positions on the board.

promoted: Bitboard

Positions of tracked promoted pieces. Used only for Crazyhouse.

pockets: Option<ByColor<ByRole<u8>>>

Pockets in chess variants like Crazyhouse.

turn: Color

Side to move.

castling_rights: Bitboard

Castling rights in terms of corresponding rook positions.

Examples

use shakmaty::{Bitboard, Setup};

let setup = Setup::default();
let rooks = setup.castling_rights;
// 1 . . . . . . 1
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// . . . . . . . .
// 1 . . . . . . 1

assert_eq!(rooks, Bitboard::CORNERS);

ep_square: Option<Square>

En passant target square. Valid target squares are on the third or sixth rank.

remaining_checks: Option<ByColor<RemainingChecks>>

Remaining checks in chess variants like Three-Check.

halfmoves: u32

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

Examples

use shakmaty::Setup;

let setup = Setup::default();
assert_eq!(setup.halfmoves, 0);

fullmoves: NonZeroU32

Current move number.

Starts at 1 and is increased after every black move.

Examples

use shakmaty::Setup;

let setup = Setup::default();
assert_eq!(setup.fullmoves.get(), 1);

Implementations

impl Setup

pub const fn empty() -> Setup

Plain, empty board. No pieces. White to play.

pub const fn initial() -> Setup

Default board setup.

pub fn swap_turn(&mut self)

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

Trait Implementations

impl Clone for Setup

fn clone(&self) -> Setup

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Setup

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

Formats the value using the given formatter.

impl Default for Setup

fn default() -> Setup

Returns the “default value” for a type.

impl From<Epd> for Setup

fn from(epd: Epd) -> Setup

Converts to this type from the input type.

impl From<Fen> for Setup

fn from(fen: Fen) -> Setup

Converts to this type from the input type.

impl From<Setup> for Epd

fn from(setup: Setup) -> Epd

Converts to this type from the input type.

impl From<Setup> for Fen

fn from(setup: Setup) -> Fen

Converts to this type from the input type.

impl Hash for Setup

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,
    Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Setup> for Setup

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Setup

impl StructuralEq for Setup

impl StructuralPartialEq for Setup