Enum chess::CastleRights

pub enum CastleRights {
    NoRights,
    KingSide,
    QueenSide,
    Both,
}

What castle rights does a particular player have?

rule: https://en.wikipedia.org/wiki/Castling

Variants

NoRights

No right to Castle.

KingSide

Right to Castle only on King side (little Castle).

QueenSide

Right to Castle only on Queen side (big Castle).

Both

Right to Castle in both side (little and big Castle).

Implementations

impl CastleRights

pub fn from_index(index: usize) -> CastleRights

Convert usize to CastleRights.

Panics

Panic if index is not in range 0..=3.

pub fn to_index(&self) -> usize

Convert CastleRights to usize.

pub fn has_kingside(&self) -> bool

Check the castling on the king side.

pub fn has_queenside(&self) -> bool

Check the castling on the queen side.

pub fn to_string(&self, color: Color) -> String

Convert the castle rights to an FEN compatible String.

use chess::{CastleRights, Color};

assert_eq!(CastleRights::NoRights.to_string(Color::Black), "");
assert_eq!(CastleRights::KingSide.to_string(Color::White), "K");
assert_eq!(CastleRights::QueenSide.to_string(Color::Black), "q");
assert_eq!(CastleRights::Both.to_string(Color::White), "KQ");

Trait Implementations

impl Clone for CastleRights

fn clone(&self) -> CastleRights

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CastleRights

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

Formats the value using the given formatter.

impl PartialEq<CastleRights> for CastleRights

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<CastleRights> for CastleRights

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

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

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

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

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

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

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

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

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 Copy for CastleRights

impl Eq for CastleRights

impl StructuralEq for CastleRights

impl StructuralPartialEq for CastleRights