Enum shakmaty::Role

pub enum Role {
    Pawn,
    Knight,
    Bishop,
    Rook,
    Queen,
    King,
}

Piece types: Pawn, Knight, Bishop, Rook, Queen, King.

Examples

use shakmaty::Role;

// Piece types are indexed from 1 to 6.
assert_eq!(u32::from(Role::Pawn), 1);
assert_eq!(u32::from(Role::King), 6);

Variants

PawnKnightBishopRookQueenKing

Methods

impl Role

pub fn from_char(ch: char) -> Option<Role>

Gets the piece type from its English letter.

Examples

use shakmaty::Role;

assert_eq!(Role::from_char('K'), Some(Role::King));
assert_eq!(Role::from_char('n'), Some(Role::Knight));

assert_eq!(Role::from_char('X'), None);

pub fn of(self, color: Color) -> Piece

Gets a Piece of the given color.

Examples

use shakmaty::{Color, Role};

assert_eq!(Role::King.of(Color::Black), Color::Black.king());

pub fn char(self) -> char

Gets the English letter for the piece type.

Examples

use shakmaty::Role;

assert_eq!(Role::Rook.char(), 'r');

pub fn upper_char(self) -> char

Gets the uppercase English letter for the piece type.

Examples

use shakmaty::Role;

assert_eq!(Role::Rook.upper_char(), 'R');

Trait Implementations

impl From<Role> for u8

fn from(role: Role) -> u8

Performs the conversion.

impl From<Role> for i8

fn from(role: Role) -> i8

Performs the conversion.

impl From<Role> for u16

fn from(role: Role) -> u16

Performs the conversion.

impl From<Role> for i16

fn from(role: Role) -> i16

Performs the conversion.

impl From<Role> for u32

fn from(role: Role) -> u32

Performs the conversion.

impl From<Role> for i32

fn from(role: Role) -> i32

Performs the conversion.

impl From<Role> for u64

fn from(role: Role) -> u64

Performs the conversion.

impl From<Role> for i64

fn from(role: Role) -> i64

Performs the conversion.

impl From<Role> for u128

fn from(role: Role) -> u128

Performs the conversion.

impl From<Role> for i128

fn from(role: Role) -> i128

Performs the conversion.

impl From<Role> for usize

fn from(role: Role) -> usize

Performs the conversion.

impl From<Role> for isize

fn from(role: Role) -> isize

Performs the conversion.

impl Ord for Role

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

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialOrd<Role> for Role

fn partial_cmp(&self, other: &Role) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl PartialEq<Role> for Role

fn eq(&self, other: &Role) -> 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 Extend<Role> for MaterialSide

fn extend<T: IntoIterator<Item = Role>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

impl Clone for Role

fn clone(&self) -> Role

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Eq for Role

impl Copy for Role

impl Debug for Role

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

Formats the value using the given formatter.

impl TryFrom<u8> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<i8> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<u16> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<i16> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<u32> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<i32> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<u64> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<i64> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<u128> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<i128> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<usize> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<Role, Self::Error>

Performs the conversion.

impl TryFrom<isize> for Role

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<Role, Self::Error>

Performs the conversion.

impl Hash for Role

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl FromIterator<Role> for MaterialSide

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = Role>, 

Creates a value from an iterator.