schachmatt 0.3.0

A chess library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25

use crate::{Field, PieceType};

/// A `Turn` is defined as a combination of two fields and an optional promotion piece.
#[derive(Copy, Clone, PartialEq, Eq, Debug)]
pub struct Turn {
    pub(crate) current: Field,
    pub(crate) target: Field,
    pub(crate) promotion: Option<PieceType>,
}

impl Turn {
    /// Creates a new `Turn` object.
    /// - `current` - The field from which a piece moves
    /// - `target` - The field to which a piece moves
    /// - `promotion_piece` - Used to describe the promotion piece if a pawn promotes
    /// - `returns` - A new `Turn` object
    #[must_use]
    pub fn new(current: Field, target: Field, promotion_piece: Option<PieceType>) -> Self {
        Turn {
            current,
            target,
            promotion: promotion_piece,
        }
    }
}