Struct chess::ChessMove

pub struct ChessMove { /* fields omitted */ }

Represent a ChessMove in memory

Methods

impl ChessMove

pub fn new(source: Square, dest: Square, promotion: Option<Piece>) -> ChessMove

Create a new chess move, given a source Square, a destination Square, and an optional promotion Piece

pub fn get_source(&self) -> Square

Get the source square (square the piece is currently on).

pub fn get_dest(&self) -> Square

Get the destination square (square the piece is going to).

pub fn get_promotion(&self) -> Option<Piece>

Get the promotion piece (maybe).

pub fn from_san(board: &Board, move_text: &str) -> Result<ChessMove, Error>

Convert a SAN (Standard Algebraic Notation) move into a ChessMove

use chess::{Board, ChessMove, Square};

let board = Board::default();
assert_eq!(
    ChessMove::from_san(&board, "e4").expect("e4 is valid in the initial position"),
    ChessMove::new(Square::E2, Square::E4, None)
);

Trait Implementations

impl Clone for ChessMove

fn clone(&self) -> ChessMove

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ChessMove

impl Debug for ChessMove

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

Formats the value using the given formatter.

impl Default for ChessMove

fn default() -> ChessMove

Returns the "default value" for a type.

impl Display for ChessMove

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

Formats the value using the given formatter.

impl Eq for ChessMove

impl FromStr for ChessMove

Convert a UCI String to a move. If invalid, return None

use chess::{ChessMove, Square, Piece};
use std::str::FromStr;

let mv = ChessMove::new(Square::E7, Square::E8, Some(Piece::Queen));

assert_eq!(ChessMove::from_str("e7e8q").expect("Valid Move"), mv);

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ChessMove

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, 

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

impl Ord for ChessMove

fn cmp(&self, other: &ChessMove) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<ChessMove> for ChessMove

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

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

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

This method tests for !=.

impl PartialOrd<ChessMove> for ChessMove

fn partial_cmp(&self, other: &ChessMove) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &ChessMove) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &ChessMove) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &ChessMove) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &ChessMove) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for ChessMove

impl StructuralPartialEq for ChessMove