Struct poirebot::game::position::Position

pub struct Position {
    pub file_x: u8,
    pub rank_y: u8,
}

Position on the board.

Fields

file_x: u8

The file index, 0 to 7 (maps A to H)

rank_y: u8

The rank index, 0 to 7 (maps 1 to 8)

Implementations

impl Position

pub fn new(file_x: u8, rank_y: u8) -> Result<Position>

Initialize a position from indexes.

pub fn from_notation(notation: &str) -> Result<Position>

Initialize a position from notation (for example: a8).

pub fn flip(&self) -> Self

Rotates the position for the other side.

pub fn forwards(&self, color: Color, inc: u8) -> Self

Returns a new position, forwards by increment in the direction of the given color.

pub fn backwards(&self, color: Color, inc: u8) -> Self

Returns a new position, backwards by increment in the direction of the given color.

pub fn distance_rank(&self, other: &Position) -> u8

Returns the distance between 2 positions on the Y axis (rank).

pub fn to_int(&self) -> u8

Convert to BitBoard notation.

Trait Implementations

impl Clone for Position

fn clone(&self) -> Position

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Position

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

Formats the value using the given formatter.

impl Eq for Position

impl From<&'_ str> for Position

Converts from a notation &str (e.g. "a1"). Note that this function panics if an invalid notation is given. Use Position::from_notation for safer conversion.

fn from(p: &str) -> Self

Performs the conversion.

impl From<(u8, u8)> for Position

Converts from (file, rank) tuple. Note that this function panics if an invalid values are given. Use Position::new for safer conversion.

fn from(p: (u8, u8)) -> Self

Performs the conversion.

impl From<String> for Position

Converts from a notation String (e.g. "a1"). Note that this function panics if an invalid notation is given. Use Position::from_notation for safer conversion.

fn from(p: String) -> Self

Performs the conversion.

impl FromIterator<Position> for BitBoard

fn from_iter<T: IntoIterator<Item = Position>>(iter: T) -> Self

Creates a value from an iterator.

impl PartialEq<Position> for Position

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

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

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

This method tests for !=.

impl StructuralEq for Position

impl StructuralPartialEq for Position