Struct PieceMove 

pub struct PieceMove {
    pub from: SquareCoordinates,
    pub to: SquareCoordinates,
    pub promotion: Option<Kind>,
}

Fields

from: SquareCoordinates

to: SquareCoordinates

promotion: Option<Kind>

Implementations

impl PieceMove

Represents a move of a piece on the board.

Examples

use chessly::{Kind, PieceMove, SquareCoordinates};

let from = SquareCoordinates::try_from("e2").unwrap();
let to = SquareCoordinates::try_from("e4").unwrap();
let piece_move = PieceMove::new(from, to);

assert_eq!(piece_move.to_string(), "e2e4");

pub const fn new(from: SquareCoordinates, to: SquareCoordinates) -> Self

pub const fn promotion( from: SquareCoordinates, to: SquareCoordinates, promotion: Kind, ) -> Self

impl PieceMove

pub fn to_long_algebraic_notation(&self) -> String

Returns the long algebraic notation of the move.

Read more about long algebraic notation here.

Examples

use chessly::{Kind, PieceMove, SquareCoordinates};

let from = SquareCoordinates::try_from("e2").unwrap();
let to = SquareCoordinates::try_from("e4").unwrap();
let piece_move = PieceMove::new(from, to);

assert_eq!(piece_move.to_long_algebraic_notation(), "e2e4");

let from = SquareCoordinates::try_from("e7").unwrap();
let to = SquareCoordinates::try_from("e8").unwrap();
let piece_move = PieceMove::promotion(from, to, Kind::Queen);

assert_eq!(piece_move.to_long_algebraic_notation(), "e7e8q");

Trait Implementations

impl Clone for PieceMove

fn clone(&self) -> PieceMove

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PieceMove

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

Formats the value using the given formatter.

impl Display for PieceMove

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

Formats the value using the given formatter.

impl PartialEq for PieceMove

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<&str> for PieceMove

type Error = &'static str

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PieceMove

impl Eq for PieceMove

impl StructuralPartialEq for PieceMove