Enum shogi::color::Color

pub enum Color {
    Black,
    White,
}

Represents each side of player. Black player moves first.

Examples

use shogi::Color;

let c = Color::Black;
match c {
   Color::Black => assert!(true),
   Color::White => unreachable!(),
}

Variants

BlackWhite

Methods

impl Color

Important traits for ColorIter

impl Iterator for ColorIter type Item = Color;

pub fn iter() -> ColorIter

Returns an iterator of all variants.

pub fn flip(&self) -> Color

Returns the color of the opposite side.

Examples

use shogi::Color;

assert_eq!(Color::White, Color::Black.flip());
assert_eq!(Color::Black, Color::White.flip());

pub fn index(&self) -> usize

Converts the instance into the unique number for array indexing purpose.

Trait Implementations

impl Eq for Color

impl Copy for Color

impl PartialEq<Color> for Color

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

fn clone(&self) -> Color

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Color

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

Formats the value using the given formatter.

impl Display for Color

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

Formats the value using the given formatter.