Struct Position

pub struct Position { /* private fields */ }

Implementations

impl Position

pub const fn king_pos(color: Color) -> Self

Return the starting position for a given color’s king.

pub const fn queen_pos(color: Color) -> Self

Return the starting position for a given color’s queen.

pub const fn new(row: i32, col: i32) -> Self

Create a Position from its respective row or column number. The row and column numbers can be any of 0, 1, 2, 3, 4, 5, 6, or 7.

Examples:

• A1 = Position::new(0, 0)
• A8 = Position::new(7, 0)
• H1 = Position::new(0, 7)
• H8 = Position::new(7, 7)

pub fn pgn(s: &str) -> Result<Self, String>

Parse a position from PGN. This simply just supports positions like e4 and D8.

pub fn is_on_board(&self) -> bool

Is this position a valid spot on the board?

pub fn is_off_board(&self) -> bool

Is this position NOT a valid spot on the board?

pub fn get_row(&self) -> i32

Get the row number of the position. This can be any of 0, 1, 2, 3, 4, 5, 6, or 7.

pub fn get_col(&self) -> i32

pub fn is_diagonal_to(&self, other: Self) -> bool

Is this position diagonal to another position?

pub fn is_orthogonal_to(&self, other: Self) -> bool

Is this position orthogonal to another position?

pub fn is_adjacent_to(&self, other: Self) -> bool

Is this position adjacent to another position?

Adjacent positions have either:

1. A diagonal distance of one from each other
2. An orthogonal distance of one from each other

pub fn is_below(&self, other: Self) -> bool

Is this position beneath another position on the board? Pieces “beneath” other pieces on the board have lower ranks.

So, for example, A7 is below A8.

pub fn is_above(&self, other: Self) -> bool

Is this position above another position on the board? Pieces “above” other pieces on the board have higher ranks.

So, for example, A8 is above A8.

pub fn is_left_of(&self, other: Self) -> bool

Is this position left of another position on the board? Pieces “left of” other pieces on the board have a lower lexigraphical column character.

So, for example, A8 is left of B8.

pub fn is_right_of(&self, other: Self) -> bool

Is this position right of another position on the board? Pieces “right of” other pieces on the board have a higher lexigraphical column character.

So, for example, B8 is right of A8.

pub fn next_below(&self) -> Self

Get the position directly below this position.

IMPORTANT NOTE: This will NOT check for positions off of the board! You could easily get an invalid position if you do not check with the is_on_board method!

pub fn next_above(&self) -> Self

Get the position directly above this position.

IMPORTANT NOTE: This will NOT check for positions off of the board! You could easily get an invalid position if you do not check with the is_on_board method!

pub fn pawn_up(&self, ally_color: Color) -> Self

Get the next square upwards from a respective player’s pawn.

IMPORTANT NOTE: This will NOT check for positions off of the board! You could easily get an invalid position if you do not check with the is_on_board method!

pub fn pawn_back(&self, ally_color: Color) -> Self

Get the next square backwards from a respective player’s pawn.

IMPORTANT NOTE: This will NOT check for positions off of the board! You could easily get an invalid position if you do not check with the is_on_board method!

pub fn next_left(&self) -> Self

Get the position directly left of this position.

IMPORTANT NOTE: This will NOT check for positions off of the board! You could easily get an invalid position if you do not check with the is_on_board method!

pub fn next_right(&self) -> Self

Get the position directly right of this position.

IMPORTANT NOTE: This will NOT check for positions off of the board! You could easily get an invalid position if you do not check with the is_on_board method!

pub fn is_starting_pawn(&self, color: Color) -> bool

Is this pawn on the starting rank for the respective player?

pub fn is_kingside_rook(&self) -> bool

Is this the starting position of the kingside rook?

pub fn is_queenside_rook(&self) -> bool

Is this the starting position of the queenside rook?

pub fn diagonals_to(&self, to: Self) -> Vec<Self>

Get the list of positions from this position to another position, moving diagonally.

This does not include the from position, and includes the to position.

pub fn orthogonals_to(&self, to: Self) -> Vec<Self>

Get the list of positions from this position to another position, moving orthogonally.

This does not include the from position, and includes the to position.

pub fn is_knight_move(&self, other: Self) -> bool

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Position

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

Formats the value using the given formatter.

impl Display for Position

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

Formats the value using the given formatter.

impl Ord for Position

fn cmp(&self, other: &Position) -> 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 Position

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

fn partial_cmp(&self, other: &Position) -> 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 Copy for Position

impl Eq for Position

impl StructuralPartialEq for Position