Enum pleco::core::Player

#[repr(u8)]
pub enum Player {
    White,
    Black,
}

Enum to represent the Players White & Black.

Variants

WhiteBlack

Methods

impl Player

pub fn other_player(self) -> Player

Returns the other player.

Examples

use pleco::core::Player;

let b = Player::Black;
assert_eq!(b.other_player(), Player::White);

pub fn relative_square(self, sq: SQ) -> SQ

Returns the relative square from a given square.

pub fn pawn_push(self) -> i8

Gets the direction of a pawn push for a given player.

pub fn relative_rank_of_sq(self, sq: SQ) -> Rank

Returns the relative rank of a square in relation to a player.

Examples

use pleco::core::{Player,Rank};
use pleco::core::sq::SQ;

let w = Player::White;
let b = Player::Black;

assert_eq!(w.relative_rank_of_sq(SQ::A1), Rank::R1);
assert_eq!(b.relative_rank_of_sq(SQ::H8), Rank::R1);
assert_eq!(b.relative_rank_of_sq(SQ::A1), Rank::R8);

pub fn relative_rank(self, rank: Rank) -> Rank

Returns the relative rank of a rank in relation to a player.

Examples

use pleco::core::{Player,Rank};
use pleco::core::sq::SQ;

let w = Player::White;
let b = Player::Black;

assert_eq!(w.relative_rank(Rank::R1), Rank::R1);
assert_eq!(b.relative_rank(Rank::R8), Rank::R1);
assert_eq!(b.relative_rank(Rank::R1), Rank::R8);

Trait Implementations

impl Copy for Player

impl PartialEq<Player> for Player

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

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

#[must_use]

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

This method tests for !=.

impl Clone for Player

fn clone(&self) -> Player

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Display for Player

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

Formats the value using the given formatter.

impl Debug for Player

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

Formats the value using the given formatter.

impl Not for Player

type Output = Player

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.