Enum shakmaty::Move

#[repr(align(4))]
pub enum Move {
    Normal {
        role: Role,
        from: Square,
        capture: Option<Role>,
        to: Square,
        promotion: Option<Role>,
    },
    EnPassant {
        from: Square,
        to: Square,
    },
    Castle {
        king: Square,
        rook: Square,
    },
    Put {
        role: Role,
        to: Square,
    },
}

Information about a move.

Display

Move implements Display using long algebraic notation. If a position is available for context, it is more common to use SAN (for human interfaces) or UCI (for text-based protocols).

Variants

Normal

A normal move, e.g., Bd3xh7.

Fields

role: Role

from: Square

capture: Option<Role>

to: Square

promotion: Option<Role>

EnPassant

An en passant capture, e.g., e5xd6.

Fields

from: Square

to: Square

Castle

A castling move, O-O or O-O-O.

Fields

king: Square

rook: Square

Put

A piece drop in Crazyhouse, e.g., Q@g8.

Fields

role: Role

to: Square

Implementations

impl Move

pub const fn role(&self) -> Role

Gets the role of the moved piece.

pub const fn from(&self) -> Option<Square>

Gets the origin square or None for drops.

pub const fn to(&self) -> Square

Gets the target square. For castling moves this is the corresponding rook square.

pub const fn capture(&self) -> Option<Role>

Gets the role of the captured piece or None.

pub const fn is_capture(&self) -> bool

Checks if the move is a capture.

pub const fn is_en_passant(&self) -> bool

Checks if the move is en passant.

pub const fn is_zeroing(&self) -> bool

Checks if the move zeros the half-move clock.

pub fn castling_side(&self) -> Option<CastlingSide>

Gets the castling side.

pub const fn is_castle(&self) -> bool

Checks if the move is a castling move.

pub const fn promotion(&self) -> Option<Role>

Gets the promotion role.

pub const fn is_promotion(&self) -> bool

Checks if the move is a promotion.

impl Move

pub fn to_uci(&self, mode: CastlingMode) -> Uci

See Uci::from_move().

Trait Implementations

impl Clone for Move

fn clone(&self) -> Move

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Move

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

Formats the value using the given formatter.

impl Display for Move

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

Formats the value using the given formatter.

impl Hash for Move

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 for Move

fn eq(&self, other: &Move) -> 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 Move

impl StructuralPartialEq for Move