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,
}

Represents a single square on the 8×8 board.

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 const fn to_mask(&self) -> u64

Converts a square to its mask.

pub const unsafe fn from_mask(mask: u64) -> Self

Converts a mask to a square.

Safety

The mask must have exactly one bit set in positions 0-63. Passing zero, multiple bits, or a bit >= 64 causes undefined behavior.

pub const fn to_u8(&self) -> u8

Converts a square to its index.

pub const unsafe fn from_u8(index: u8) -> Self

Converts an index to a square.

Safety

The index must be in the range 0..64. Passing an index >= 64 causes undefined behavior.

Use try_from_u8 for a safe alternative.

pub const fn to_usize(&self) -> usize

Converts a square to its array index.

pub const unsafe fn from_usize(index: usize) -> Self

Converts an array index to a square.

Safety

The index must be in the range 0..64. Passing an index >= 64 causes undefined behavior.

Use try_from_usize for a safe alternative.

pub const fn row(&self) -> u8

Returns the row of the square (0-7).

pub const fn column(&self) -> u8

Returns the column of the square (0-7).

pub const fn manhattan(&self, other: Self) -> u8

Returns the manhattan distance between two squares.

pub const unsafe fn from_row_column(row: u8, column: u8) -> Self

Creates a square from row and column indices.

Row 0 is rank 1, row 7 is rank 8. Column 0 is file a, column 7 is file h.

Safety

Both row and column must be in the range 0..8. Passing row >= 8 or column >= 8 causes undefined behavior.

pub const fn try_from_u8(index: u8) -> Option<Self>

Tries to convert an index to a square.

Returns Some(Square) if the index is in range [0, 63], otherwise None.

pub const fn try_from_usize(index: usize) -> Option<Self>

Tries to convert an index to a square.

Returns Some(Square) if the index is in range [0, 63], otherwise None.

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<Square> for u8

fn from(square: Square) -> Self

Converts to this type from the input type.

impl From<Square> for usize

fn from(square: Square) -> Self

Converts to this type from the input type.

impl FromStr for Square

type Err = ParseSquareError

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 Square

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

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 TryFrom<u8> for Square

type Error = SquareIndexError

The type returned in the event of a conversion error.

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

Performs the conversion.

impl TryFrom<usize> for Square

type Error = SquareIndexError

The type returned in the event of a conversion error.

fn try_from(index: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Square

impl Eq for Square

impl StructuralPartialEq for Square