Enum CastleZone

pub enum CastleZone {
    WK,
    WQ,
    BK,
    BQ,
}

Represents one of the four different areas on a chessboard where the special castling move can take place (two for each side).

Variants

WK

WQ

BK

BQ

Implementations

impl CastleZone

pub fn side(&self) -> Side

Return the side which this zone belongs to.

pub fn kingside(side: Side) -> CastleZone

Return the kingside zone for the given side.

pub fn queenside(side: Side) -> CastleZone

Return the queenside zone for the given side.

pub fn iter() -> impl Iterator<Item = CastleZone>

Create an iterator traversing all zones in order.

pub fn source_squares(self) -> BitBoard

Returns a set of exactly two squares which denote the required locations of the king and rook in order for the corresponding castle move to take place.

pub fn rook_data(self) -> (Piece, Square, Square)

Returns a triple containing the rook which moves in the corresponding castle move along with it’s required start square followed by the square it will finish on.

pub fn king_data(self) -> (Piece, Square, Square)

Returns a triple containing the king which moves in the corresponding castle move along with it’s required start square followed by the square it will finish on.

pub fn unoccupied_requirement(self) -> BitBoard

Returns a set containing the squares which are required to be free of any other pieces in order for the corresponding castle move to be legal.

pub fn uncontrolled_requirement(self) -> BitBoard

Returns a set containing the squares which are required to be free of enemy control in order for the corresponding castle move to be legal.

pub fn lift(self) -> EnumSet<CastleZone>

Lifts this zone to a set of one element.

Trait Implementations

impl<O: Into<EnumSet<CastleZone>>> BitAnd<O> for CastleZone

type Output = EnumSet<CastleZone>

The resulting type after applying the & operator.

fn bitand(self, other: O) -> Self::Output

Performs the & operation.

impl<O: Into<EnumSet<CastleZone>>> BitOr<O> for CastleZone

type Output = EnumSet<CastleZone>

The resulting type after applying the | operator.

fn bitor(self, other: O) -> Self::Output

Performs the | operation.

impl<O: Into<EnumSet<CastleZone>>> BitXor<O> for CastleZone

type Output = EnumSet<CastleZone>

The resulting type after applying the ^ operator.

fn bitxor(self, other: O) -> Self::Output

Performs the ^ operation.

impl Clone for CastleZone

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CastleZone

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

Formats the value using the given formatter.

impl Display for CastleZone

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

Formats the value using the given formatter.

impl EnumSetTypePrivate for CastleZone

const CONST_HELPER_INSTANCE: __EnumSetConstHelper = __EnumSetConstHelper

The instance of the ConstHelper.

const ALL_BITS: Self::Repr = {transmute(0x0f): <castlezone::CastleZone as enumset::__internal::EnumSetTypePrivate>::Repr}

A mask of bits that are valid in the bitset.

const BIT_WIDTH: u32 = 4u32

The largest bit used in the bitset.

const VARIANT_COUNT: u32 = 4u32

The number of variants in the bitset.

type ConstHelper = __EnumSetConstHelper

A helper type used to implement the enum_set! macro among other things.

type Repr = u8

The underlying type used to store the bitset.

fn enum_into_u32(self) -> u32

Converts an enum of this type into its bit position.

unsafe fn enum_from_u32(val: u32) -> Self

Converts a bit position into an enum value.

impl FromStr for CastleZone

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for CastleZone

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Not for CastleZone

type Output = EnumSet<CastleZone>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl Ord for CastleZone

fn cmp(&self, other: &CastleZone) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq<EnumSet<CastleZone>> for CastleZone

fn eq(&self, other: &EnumSet<CastleZone>) -> 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 PartialEq for CastleZone

fn eq(&self, other: &Self) -> 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 PartialOrd for CastleZone

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Reflectable for CastleZone

A castle is reflected by it’s side, i.e.

• WK <==> BK
• WQ <==> BQ

fn reflect(&self) -> Self

impl<O: Into<EnumSet<CastleZone>>> Sub<O> for CastleZone

type Output = EnumSet<CastleZone>

The resulting type after applying the - operator.

fn sub(self, other: O) -> Self::Output

Performs the - operation.

impl Copy for CastleZone

impl EnumSetType for CastleZone

impl Eq for CastleZone