Enum Square 

#[repr(u8)]
pub enum Square {
    A1 = 0,
    B1 = 1,
    C1 = 2,
    D1 = 3,
    E1 = 4,
    F1 = 5,
    G1 = 6,
    H1 = 7,
    A2 = 8,
    B2 = 9,
    C2 = 10,
    D2 = 11,
    E2 = 12,
    F2 = 13,
    G2 = 14,
    H2 = 15,
    A3 = 16,
    B3 = 17,
    C3 = 18,
    D3 = 19,
    E3 = 20,
    F3 = 21,
    G3 = 22,
    H3 = 23,
    A4 = 24,
    B4 = 25,
    C4 = 26,
    D4 = 27,
    E4 = 28,
    F4 = 29,
    G4 = 30,
    H4 = 31,
    A5 = 32,
    B5 = 33,
    C5 = 34,
    D5 = 35,
    E5 = 36,
    F5 = 37,
    G5 = 38,
    H5 = 39,
    A6 = 40,
    B6 = 41,
    C6 = 42,
    D6 = 43,
    E6 = 44,
    F6 = 45,
    G6 = 46,
    H6 = 47,
    A7 = 48,
    B7 = 49,
    C7 = 50,
    D7 = 51,
    E7 = 52,
    F7 = 53,
    G7 = 54,
    H7 = 55,
    A8 = 56,
    B8 = 57,
    C8 = 58,
    D8 = 59,
    E8 = 60,
    F8 = 61,
    G8 = 62,
    H8 = 63,
}

Square Every possible square on a chess board. The order of enums is important, as Square::A1 as u8 corresponds to that Square’s bit position in a bitboard. WARNING: The exact ordering of enums is important for their discriminants. Changing the discriminant of any variant is breaking.

Variants

A1 = 0

B1 = 1

C1 = 2

D1 = 3

E1 = 4

F1 = 5

G1 = 6

H1 = 7

A2 = 8

B2 = 9

C2 = 10

D2 = 11

E2 = 12

F2 = 13

G2 = 14

H2 = 15

A3 = 16

B3 = 17

C3 = 18

D3 = 19

E3 = 20

F3 = 21

G3 = 22

H3 = 23

A4 = 24

B4 = 25

C4 = 26

D4 = 27

E4 = 28

F4 = 29

G4 = 30

H4 = 31

A5 = 32

B5 = 33

C5 = 34

D5 = 35

E5 = 36

F5 = 37

G5 = 38

H5 = 39

A6 = 40

B6 = 41

C6 = 42

D6 = 43

E6 = 44

F6 = 45

G6 = 46

H6 = 47

A7 = 48

B7 = 49

C7 = 50

D7 = 51

E7 = 52

F7 = 53

G7 = 54

H7 = 55

A8 = 56

B8 = 57

C8 = 58

D8 = 59

E8 = 60

F8 = 61

G8 = 62

H8 = 63

Implementations

impl Square

pub fn from_idx<I: SquareIndexable>(indexable: I) -> Option<Square>

pub const fn iter() -> SquareIterator

pub fn file(&self) -> File

pub fn rank(&self) -> Rank

pub const fn file_u8(&self) -> u8

Returns 0-based file (0,1,2,3,4,5,6,7), not 1-based chess file.

pub const fn rank_u8(&self) -> u8

Returns 0-based rank (0,1,2,3,4,5,6,7), not 1-based chess rank.

pub fn increment_rank(&self) -> Option<Self>

Returns the Square with the Rank increased by one, “A3 -> A4”.

pub fn decrement_rank(&self) -> Option<Self>

Returns the Square with the Rank decreased by one, “A3 -> A2”.

pub fn flip_rank(&self) -> Self

Flips the rank of the current square. For example, A1 -> A8, A2 -> A7.

Trait Implementations

impl Clone for Square

fn clone(&self) -> Square

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Square

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

Formats the value using the given formatter.

impl Display for Square

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

Formats the value using the given formatter.

impl From<(File, Rank)> for Square

fn from(coordinate: (File, Rank)) -> Self

Converts to this type from the input type.

impl FromStr for Square

Square::=

type Err = Error

The associated error which can be returned from parsing.

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

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

impl IntoIterator for Square

type Item = Square

The type of the elements being iterated over.

type IntoIter = SquareIterator

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Ord for Square

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Square

fn eq(&self, other: &Square) -> 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 PartialOrd for Square

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl SquareIndexable for Square

fn idx(&self) -> usize

idx must be implemented. idx(&self) must return a number between 0-63 inclusive, representing a square on a chess board in little-endian, rank-file order. Warning: Values outside of 0-63 may panic or cause undefined behavior.

fn shift(&self) -> u64

shift returns a number that represents the bit-index equivalent of a chess Square on a u64.

impl TryFrom<u8> for Square

Square enum variants cover all u8 values from 0-63 inclusive. WARNING: Uses unsafe.

type Error = ()

The type returned in the event of a conversion error.

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

Performs the conversion.

impl Copy for Square

impl Eq for Square

impl StructuralPartialEq for Square