Struct hexe_core::mv::Move

pub struct Move(_);

A chess piece move from one square to another.

Each instance has the following memory layout:

• Source [6 bits]

• Destination [6 bits]

• Meta [2 bits] (optional)

• Kind [2 bits] (Normal, Promotion, Castle, EnPassant)

Methods

impl Move

pub fn normal(src: Square, dst: Square) -> Move

Creates a new Move from one square to another.

pub fn promotion(file: File, color: Color, piece: Promotion) -> Move

Creates a new promotion move for color at file.

pub fn castle(right: Right) -> Move

Creates a new castle move for right.

pub fn en_passant(src: Square, dst: Square) -> Option<Move>

Creates an en passant move from one square to another.

pub fn squares_eq<T: Into<Move>>(self, other: T) -> bool

Returns whether the squares of self equal the squares of other.

pub fn src(self) -> Square

Returns the source square for self.

pub fn dst(self) -> Square

Returns the destination square for self.

pub fn kind(self) -> Kind

Returns the kind for self.

pub fn to_castle(self) -> Option<Castle>

Returns self a castle move if it can be converted into one.

pub fn to_en_passant(self) -> Option<EnPassant>

Returns self as an en passant move if it can be converted into one.

pub fn matches(self) -> Matches

Returns a match-able type that represents the inner variant of self.

Examples

Basic usage:

use hexe_core::mv::{Move, Matches};
use hexe_core::square::Square;

let mv = Move::normal(Square::A1, Square::A7);

match mv.matches() {
    Matches::Normal(mv)    => println!("{:?}", mv.src()),
    Matches::Castle(mv)    => println!("{:?}", mv.right()),
    Matches::Promotion(mv) => println!("{:?}", mv.piece()),
    Matches::EnPassant(mv) => println!("{:?}", mv.capture()),
}

Trait Implementations

impl From<Normal> for Move

fn from(mv: Normal) -> Move

Performs the conversion.

impl FromUnchecked<Move> for Normal

unsafe fn from_unchecked(mv: Move) -> Normal

Performs the unchecked conversion.

impl AsRef<Move> for Normal

fn as_ref(&self) -> &Move

Performs the conversion.

impl From<Castle> for Move

fn from(mv: Castle) -> Move

Performs the conversion.

impl FromUnchecked<Move> for Castle

unsafe fn from_unchecked(mv: Move) -> Castle

Performs the unchecked conversion.

impl AsRef<Move> for Castle

fn as_ref(&self) -> &Move

Performs the conversion.

impl From<Promotion> for Move

fn from(mv: Promotion) -> Move

Performs the conversion.

impl FromUnchecked<Move> for Promotion

unsafe fn from_unchecked(mv: Move) -> Promotion

Performs the unchecked conversion.

impl AsRef<Move> for Promotion

fn as_ref(&self) -> &Move

Performs the conversion.

impl From<EnPassant> for Move

fn from(mv: EnPassant) -> Move

Performs the conversion.

impl FromUnchecked<Move> for EnPassant

unsafe fn from_unchecked(mv: Move) -> EnPassant

Performs the unchecked conversion.

impl AsRef<Move> for EnPassant

fn as_ref(&self) -> &Move

Performs the conversion.

impl From<Right> for Move

fn from(right: Right) -> Move

Performs the conversion.

impl PartialEq for Move

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

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

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

This method tests for !=.

impl Eq for Move

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

impl Hash for Move

fn hash<__H: Hasher>(&self, __arg_0: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl FromUnchecked<u16> for Move

unsafe fn from_unchecked(inner: u16) -> Self

Performs the unchecked conversion.

impl From<Move> for u16

fn from(mv: Move) -> u16

Performs the conversion.

impl Debug for Move

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

Formats the value using the given formatter.

impl From<Move> for Matches

fn from(mv: Move) -> Matches

Performs the conversion.