Struct chess::Square

pub struct Square(_);

Represent a square on the chess board

Methods

impl Square

pub unsafe fn new(sq: u8) -> Square

Create a new square, given an index. Note: It is invalid, but allowed, to pass in a number >= 64. Doing so will crash stuff.

pub fn make_square(rank: Rank, file: File) -> Square

Make a square given a rank and a file

pub fn get_rank(&self) -> Rank

Return the rank given this square.

pub fn get_file(&self) -> File

Return the file given this square.

pub fn up(&self) -> Option<Square>

If there is a square above me, return that. Otherwise, None.

pub fn down(&self) -> Option<Square>

If there is a square below me, return that. Otherwise, None.

pub fn left(&self) -> Option<Square>

If there is a square to the left of me, return that. Otherwise, None.

pub fn right(&self) -> Option<Square>

If there is a square to the right of me, return that. Otherwise, None.

pub fn forward(&self, color: Color) -> Option<Square>

If there is a square "forward", given my Color, go in that direction. Otherwise, None.

pub fn backward(&self, color: Color) -> Option<Square>

If there is a square "backward" given my Color, go in that direction. Otherwise, None.

pub fn uup(&self) -> Square

If there is a square above me, return that. If not, wrap around to the other side.

pub fn udown(&self) -> Square

If there is a square below me, return that. If not, wrap around to the other side.

pub fn uleft(&self) -> Square

If there is a square to the left of me, return that. If not, wrap around to the other side.

pub fn uright(&self) -> Square

If there is a square to the right of me, return that. If not, wrap around to the other side.

pub fn uforward(&self, color: Color) -> Square

If there is a square "forward", given my color, return that. If not, wrap around to the other side.

pub fn ubackward(&self, color: Color) -> Square

If there is a square "backward", given my color, return that. If not, wrap around to the other side.

pub fn to_int(&self) -> u8

Convert this square to an integer.

pub fn to_index(&self) -> usize

Convert this Square to a usize for table lookup purposes

pub fn from_string(s: String) -> Option<Square>

Convert a UCI String to a square. If invalid, return None

Trait Implementations

impl PartialEq for Square

fn eq(&self, other: &Square) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Square) -> bool

This method tests for !=.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl Eq for Square

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: &Square) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Copy for Square

impl Clone for Square

fn clone(&self) -> Square

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Square

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

Formats the value using the given formatter.