Struct Castling

pub struct Castling {
    pub type: CastlingType,
    pub flags: u8,
}

Castling turn

In chess, castling is a special move where a King can move two squares either to the left (Kingside Castle) or right (Queenside Castle). The rook is then placed to the left or right of the King respectively.

Example

use chess_notation_parser::{Turn, Castling, CastlingType, Flag};

let turn = Turn::Castling(
    Castling {
        r#type: CastlingType::Short,
        flags: Flag::CHECK,
    }
);

assert_eq!(turn, Turn::try_from("0-0+").unwrap());

Fields

type: CastlingType

Castling type (side)

flags: u8

Extra bits of information stored in a bitmask about the turn, check Flag for more info

Trait Implementations

impl Clone for Castling

fn clone(&self) -> Castling

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Castling

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

Formats the value using the given formatter.

impl Display for Castling

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

Formats the value using the given formatter.

impl FlagCheck for Castling

fn get_flags(&self) -> u8

Getter function for flags

fn check_flag(&self, flag: u8) -> bool

Returns true if flag is present

impl PartialEq for Castling

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Castling

impl StructuralPartialEq for Castling