Struct shakmaty::PositionErrorKinds

pub struct PositionErrorKinds { /* fields omitted */ }

Reasons for a Setup not beeing a legal Position.

Implementations

impl PositionErrorKinds

pub const EMPTY_BOARD: PositionErrorKinds

There are no pieces on the board.

pub const MISSING_KING: PositionErrorKinds

A king is required but missing.

pub const TOO_MANY_KINGS: PositionErrorKinds

A player has too many kings.

pub const PAWNS_ON_BACKRANK: PositionErrorKinds

There are pawns on the backrank. Only Horde allows players to have pawns on their own backrank.

pub const INVALID_CASTLING_RIGHTS: PositionErrorKinds

Some castling rights are invalid.

Can be recovered by ignoring the invalid castling rights using PositionError::ignore_invalid_castling_rights().

pub const INVALID_EP_SQUARE: PositionErrorKinds

The en passant square is on the wrong rank, not empty, or the allegedly pushed pawn is not present.

Can be recovered by ignoring the invalid en passant square using PositionError::ignore_invalid_ep_square().

pub const OPPOSITE_CHECK: PositionErrorKinds

The player not to move is in check.

pub const IMPOSSIBLE_CHECK: PositionErrorKinds

There are impossibly many checkers, or two sliding checkers are aligned.

Such a position cannot be reached by any sequence of legal moves.

pub const IMPOSSIBLE_MATERIAL: PositionErrorKinds

The material configuration cannot be reached with any sequence of legal moves.

This can be ignored using PositionError::ignore_impossible_material(), but note that other programs may not work with too much material.

pub const VARIANT: PositionErrorKinds

A variant specific rule is violated.

pub const fn empty() -> PositionErrorKinds

Returns an empty set of flags

pub const fn all() -> PositionErrorKinds

Returns the set containing all flags.

pub const fn bits(&self) -> u32

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u32) -> Option<PositionErrorKinds>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub const fn from_bits_truncate(bits: u32) -> PositionErrorKinds

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub const unsafe fn from_bits_unchecked(bits: u32) -> PositionErrorKinds

Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).

pub const fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub const fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub const fn intersects(&self, other: PositionErrorKinds) -> bool

Returns true if there are flags common to both self and other.

pub const fn contains(&self, other: PositionErrorKinds) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: PositionErrorKinds)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: PositionErrorKinds)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: PositionErrorKinds)

Toggles the specified flags in-place.

pub fn set(&mut self, other: PositionErrorKinds, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl Binary for PositionErrorKinds

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

Formats the value using the given formatter.

impl BitAnd<PositionErrorKinds> for PositionErrorKinds

type Output = PositionErrorKinds

The resulting type after applying the & operator.

pub fn bitand(self, other: PositionErrorKinds) -> PositionErrorKinds

Returns the intersection between the two sets of flags.

impl BitAndAssign<PositionErrorKinds> for PositionErrorKinds

pub fn bitand_assign(&mut self, other: PositionErrorKinds)

Disables all flags disabled in the set.

impl BitOr<PositionErrorKinds> for PositionErrorKinds

type Output = PositionErrorKinds

The resulting type after applying the | operator.

pub fn bitor(self, other: PositionErrorKinds) -> PositionErrorKinds

Returns the union of the two sets of flags.

impl BitOrAssign<PositionErrorKinds> for PositionErrorKinds

pub fn bitor_assign(&mut self, other: PositionErrorKinds)

Adds the set of flags.

impl BitXor<PositionErrorKinds> for PositionErrorKinds

type Output = PositionErrorKinds

The resulting type after applying the ^ operator.

pub fn bitxor(self, other: PositionErrorKinds) -> PositionErrorKinds

Returns the left flags, but with all the right flags toggled.

impl BitXorAssign<PositionErrorKinds> for PositionErrorKinds

pub fn bitxor_assign(&mut self, other: PositionErrorKinds)

Toggles the set of flags.

impl Clone for PositionErrorKinds

pub fn clone(&self) -> PositionErrorKinds

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for PositionErrorKinds

impl Debug for PositionErrorKinds

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

Formats the value using the given formatter.

impl Eq for PositionErrorKinds

impl Extend<PositionErrorKinds> for PositionErrorKinds

pub fn extend<T: IntoIterator<Item = PositionErrorKinds>>(
    &mut self,
    iterator: T
)

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

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

Reserves capacity in a collection for the given number of additional elements.

impl FromIterator<PositionErrorKinds> for PositionErrorKinds

pub fn from_iter<T: IntoIterator<Item = PositionErrorKinds>>(
    iterator: T
) -> PositionErrorKinds

Creates a value from an iterator.

impl Hash for PositionErrorKinds

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

Feeds this value into the given Hasher.

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

Feeds a slice of this type into the given Hasher.

impl LowerHex for PositionErrorKinds

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

Formats the value using the given formatter.

impl Not for PositionErrorKinds

type Output = PositionErrorKinds

The resulting type after applying the ! operator.

pub fn not(self) -> PositionErrorKinds

Returns the complement of this set of flags.

impl Octal for PositionErrorKinds

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

Formats the value using the given formatter.

impl Ord for PositionErrorKinds

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PositionErrorKinds> for PositionErrorKinds

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

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

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

This method tests for !=.

impl PartialOrd<PositionErrorKinds> for PositionErrorKinds

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

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

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

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

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

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

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

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

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

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

impl StructuralEq for PositionErrorKinds

impl StructuralPartialEq for PositionErrorKinds

impl Sub<PositionErrorKinds> for PositionErrorKinds

type Output = PositionErrorKinds

The resulting type after applying the - operator.

pub fn sub(self, other: PositionErrorKinds) -> PositionErrorKinds

Returns the set difference of the two sets of flags.

impl SubAssign<PositionErrorKinds> for PositionErrorKinds

pub fn sub_assign(&mut self, other: PositionErrorKinds)

Disables all flags enabled in the set.

impl UpperHex for PositionErrorKinds

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

Formats the value using the given formatter.