Enum pgn_reader::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 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 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 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 Debug for Role

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

Formats the value using the given formatter.

impl Copy for Role

impl Eq for Role

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, <Role as TryFrom<u128>>::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, <Role as TryFrom<u32>>::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, <Role as TryFrom<u16>>::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, <Role as TryFrom<usize>>::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, <Role as TryFrom<i32>>::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, <Role as TryFrom<i64>>::Error>

Performs the conversion.

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, <Role as TryFrom<u8>>::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, <Role as TryFrom<isize>>::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, <Role as TryFrom<i128>>::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, <Role as TryFrom<u64>>::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, <Role as TryFrom<i16>>::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, <Role as TryFrom<i8>>::Error>

Performs the conversion.

impl Hash for Role

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

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 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)

Returns max if self is greater than max, and min if self is less than min. Otherwise this will return self. Panics if min > max.