Enum Square

pub enum Square {
    H1,
    G1,
    F1,
    E1,
    D1,
    C1,
    B1,
    A1,
    H2,
    G2,
    F2,
    E2,
    D2,
    C2,
    B2,
    A2,
    H3,
    G3,
    F3,
    E3,
    D3,
    C3,
    B3,
    A3,
    H4,
    G4,
    F4,
    E4,
    D4,
    C4,
    B4,
    A4,
    H5,
    G5,
    F5,
    E5,
    D5,
    C5,
    B5,
    A5,
    H6,
    G6,
    F6,
    E6,
    D6,
    C6,
    B6,
    A6,
    H7,
    G7,
    F7,
    E7,
    D7,
    C7,
    B7,
    A7,
    H8,
    G8,
    F8,
    E8,
    D8,
    C8,
    B8,
    A8,
}

Type representing a square on a chessboard.

Variants

H1

G1

F1

E1

D1

C1

B1

A1

H2

G2

F2

E2

D2

C2

B2

A2

H3

G3

F3

E3

D3

C3

B3

A3

H4

G4

F4

E4

D4

C4

B4

A4

H5

G5

F5

E5

D5

C5

B5

A5

H6

G6

F6

E6

D6

C6

B6

A6

H7

G7

F7

E7

D7

C7

B7

A7

H8

G8

F8

E8

D8

C8

B8

A8

Implementations

impl Square

pub fn iter() -> impl Iterator<Item = Square>

Return an iterator traversing all squares in order.

pub fn from_index(i: usize) -> Square

Retrieve a square by it’s corresponding index.

pub const fn rank_index(self) -> usize

Return the index of the rank on which this square resides.

pub const fn file_index(self) -> usize

Return the index of the file on which this square resides.

pub fn rank(self) -> BitBoard

Return a bitboard representing the rank on which this square resides.

pub fn file(self) -> BitBoard

Return a bitboard representing the file on which this square resides.

pub const fn lift(self) -> BitBoard

‘Lifts’ this square to a singleton set of squares.

pub fn next(self, dir: Dir) -> Option<Square>

Finds the next square on a chessboard from this square in a given direction if it exists.

pub fn search(self, dir: Dir) -> BitBoard

Find all squares in a given direction from this square and returns them as a set.

pub fn search_vec(self, dir: Dir) -> Vec<Square>

Find all squares in a given direction from this square and returns them as a vector where the squares are ordered in increasing distance from this square.

pub fn search_all(self, dirs: &Vec<Dir>) -> BitBoard

Find all squares in all directions in a given vector and returns them as a set.

pub fn search_one(self, dirs: &Vec<Dir>) -> BitBoard

Find the squares adjacent to this square in all of the given directions and returns them as a set.

Trait Implementations

impl BitAnd<BitBoard> for Square

type Output = BitBoard

The resulting type after applying the & operator.

fn bitand(self, other: BitBoard) -> Self::Output

Performs the & operation.

impl BitAnd<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the & operator.

fn bitand(self, other: Square) -> Self

Performs the & operation.

impl BitOr<BitBoard> for Square

type Output = BitBoard

The resulting type after applying the | operator.

fn bitor(self, other: BitBoard) -> Self::Output

Performs the | operation.

impl BitOr<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the | operator.

fn bitor(self, other: Square) -> Self

Performs the | operation.

impl BitOr for Square

type Output = BitBoard

The resulting type after applying the | operator.

fn bitor(self, other: Square) -> Self::Output

Performs the | operation.

impl BitOrAssign<Square> for BitBoard

fn bitor_assign(&mut self, rhs: Square)

Performs the |= operation.

impl BitXor<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Square) -> Self

Performs the ^ operation.

impl BitXorAssign<Square> for BitBoard

fn bitxor_assign(&mut self, rhs: Square)

Performs the ^= operation.

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 FromIterator<Square> for BitBoard

A set of squares can be built from an iterator traversing squares.

fn from_iter<I: IntoIterator<Item = Square>>(iter: I) -> Self

Creates a value from an iterator.

impl FromStr for Square

type Err = Error

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

type Output = BitBoard

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

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

fn reflect(&self) -> Self

impl Shl<usize> for Square

type Output = Square

The resulting type after applying the << operator.

fn shl(self, rhs: usize) -> Self::Output

Performs the << operation.

impl Shr<usize> for Square

type Output = Square

The resulting type after applying the >> operator.

fn shr(self, rhs: usize) -> Self::Output

Performs the >> operation.

impl Sub<BitBoard> for Square

type Output = BitBoard

The resulting type after applying the - operator.

fn sub(self, other: BitBoard) -> Self::Output

Performs the - operation.

impl Sub<Square> for BitBoard

type Output = BitBoard

The resulting type after applying the - operator.

fn sub(self, other: Square) -> Self

Performs the - operation.

impl Copy for Square

impl Eq for Square

impl StructuralPartialEq for Square