zchess 0.1.0

(WIP) A library for calculating chess moves in a 3-dimensional space.
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
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

//! Holds the types representing location specifications on a chess board (2D/3D).

/// Represents a chess file (i.e., row, x-position).
#[derive(Clone, Copy, Debug, Default, PartialEq, PartialOrd)]
pub enum File {
    #[default]
    A,
    B,
    C,
    D,
    E,
    F,
    G, 
    H,
}

impl File {
    /// Returns the variant as it's corresponding [`usize`] value.
    pub fn convert(self) -> usize {
        self as usize
    }
}


/// Represents a chess rank (i.e., column, y-position).
#[derive(Clone, Copy, Debug, Default, PartialEq, PartialOrd)]
pub enum Rank {
    #[default]
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
}

impl Rank {
    /// Returns the variant as it's corresponding [`usize`] value.
    pub fn convert(self) -> usize {
        self as usize
    }
}


/// Represents a chess tier (i.e., depth, z-position).
#[derive(Clone, Copy, Debug, Default, PartialEq, PartialOrd)]
pub enum Tier {
    #[default]
    A,
    B,
    C,
    D,
    E,
    F,
    G,
    H,
}

impl Tier {
    /// Returns the variant as it's corresponding [`usize`] value.
    pub fn convert(self) -> usize {
        self as usize
    }
}