Struct shakmaty::PositionErrorKinds
source · [−]pub struct PositionErrorKinds { /* private fields */ }
Implementations
sourceimpl PositionErrorKinds
impl PositionErrorKinds
sourcepub const EMPTY_BOARD: Self = Self{bits: 1 << 0,}
pub const EMPTY_BOARD: Self = Self{bits: 1 << 0,}
There are no pieces on the board.
sourcepub const MISSING_KING: Self = Self{bits: 1 << 1,}
pub const MISSING_KING: Self = Self{bits: 1 << 1,}
A king is required but missing.
sourcepub const TOO_MANY_KINGS: Self = Self{bits: 1 << 2,}
pub const TOO_MANY_KINGS: Self = Self{bits: 1 << 2,}
A player has too many kings.
sourcepub const PAWNS_ON_BACKRANK: Self = Self{bits: 1 << 3,}
pub const PAWNS_ON_BACKRANK: Self = Self{bits: 1 << 3,}
There are pawns on the backrank. Only [Horde
] allows players to
have pawns on their own backrank.
sourcepub const INVALID_CASTLING_RIGHTS: Self = Self{bits: 1 << 4,}
pub const INVALID_CASTLING_RIGHTS: Self = Self{bits: 1 << 4,}
Some castling rights are invalid.
Can be recovered by discarding the invalid castling rights using
PositionError::ignore_invalid_castling_rights()
.
sourcepub const INVALID_EP_SQUARE: Self = Self{bits: 1 << 5,}
pub const INVALID_EP_SQUARE: Self = Self{bits: 1 << 5,}
The en passant square is on the wrong rank, not empty, or the allegedly pushed pawn is not present.
Can be recovered by discarding the invalid en passant square using
PositionError::ignore_invalid_ep_square()
.
sourcepub const OPPOSITE_CHECK: Self = Self{bits: 1 << 6,}
pub const OPPOSITE_CHECK: Self = Self{bits: 1 << 6,}
The player not to move is in check.
sourcepub const IMPOSSIBLE_CHECK: Self = Self{bits: 1 << 7,}
pub const IMPOSSIBLE_CHECK: Self = Self{bits: 1 << 7,}
There are impossibly many checkers, two sliding checkers are aligned, or check is not possible because the last move was a double pawn push.
Such a position cannot be reached by any sequence of legal moves.
This can be ignored using
PositionError::ignore_impossible_check()
, but note that other
programs may not work in such a situation.
sourcepub const IMPOSSIBLE_MATERIAL: Self = Self{bits: 1 << 8,}
pub const IMPOSSIBLE_MATERIAL: Self = Self{bits: 1 << 8,}
The material configuration cannot be reached with any sequence of legal moves, because there is too much material.
Distinguishes light-squared and dark-squared bishops, pockets and promoted pieces in Crazyhouse, and pieces on the board. Does not consider their positions. Does not consider missing pieces in Crazyhouse.
This can be ignored using
PositionError::ignore_impossible_material()
, but note that
other programs may not work with too much material.
sourcepub const fn from_bits(bits: u32) -> Option<Self>
pub const fn from_bits(bits: u32) -> Option<Self>
Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.
sourcepub const fn from_bits_truncate(bits: u32) -> Self
pub const fn from_bits_truncate(bits: u32) -> Self
Convert from underlying bit representation, dropping any bits that do not correspond to flags.
sourcepub const unsafe fn from_bits_unchecked(bits: u32) -> Self
pub const unsafe fn from_bits_unchecked(bits: u32) -> Self
Convert from underlying bit representation, preserving all bits (even those not corresponding to a defined flag).
Safety
The caller of the bitflags!
macro can chose to allow or
disallow extra bits for their bitflags type.
The caller of from_bits_unchecked()
has to ensure that
all bits correspond to a defined flag or that extra bits
are valid for this bitflags type.
sourcepub const fn intersects(&self, other: Self) -> bool
pub const fn intersects(&self, other: Self) -> bool
Returns true
if there are flags common to both self
and other
.
sourcepub const fn contains(&self, other: Self) -> bool
pub const fn contains(&self, other: Self) -> bool
Returns true
if all of the flags in other
are contained within self
.
sourcepub fn set(&mut self, other: Self, value: bool)
pub fn set(&mut self, other: Self, value: bool)
Inserts or removes the specified flags depending on the passed value.
sourcepub const fn intersection(self, other: Self) -> Self
pub const fn intersection(self, other: Self) -> Self
Returns the intersection between the flags in self
and
other
.
Specifically, the returned set contains only the flags which are
present in both self
and other
.
This is equivalent to using the &
operator (e.g.
ops::BitAnd
), as in flags & other
.
sourcepub const fn union(self, other: Self) -> Self
pub const fn union(self, other: Self) -> Self
Returns the union of between the flags in self
and other
.
Specifically, the returned set contains all flags which are
present in either self
or other
, including any which are
present in both (see Self::symmetric_difference
if that
is undesirable).
This is equivalent to using the |
operator (e.g.
ops::BitOr
), as in flags | other
.
sourcepub const fn difference(self, other: Self) -> Self
pub const fn difference(self, other: Self) -> Self
Returns the difference between the flags in self
and other
.
Specifically, the returned set contains all flags present in
self
, except for the ones present in other
.
It is also conceptually equivalent to the “bit-clear” operation:
flags & !other
(and this syntax is also supported).
This is equivalent to using the -
operator (e.g.
ops::Sub
), as in flags - other
.
sourcepub const fn symmetric_difference(self, other: Self) -> Self
pub const fn symmetric_difference(self, other: Self) -> Self
Returns the symmetric difference between the flags
in self
and other
.
Specifically, the returned set contains the flags present which
are present in self
or other
, but that are not present in
both. Equivalently, it contains the flags present in exactly
one of the sets self
and other
.
This is equivalent to using the ^
operator (e.g.
ops::BitXor
), as in flags ^ other
.
sourcepub const fn complement(self) -> Self
pub const fn complement(self) -> Self
Returns the complement of this set of flags.
Specifically, the returned set contains all the flags which are
not set in self
, but which are allowed for this type.
Alternatively, it can be thought of as the set difference
between Self::all()
and self
(e.g. Self::all() - self
)
This is equivalent to using the !
operator (e.g.
ops::Not
), as in !flags
.
Trait Implementations
sourceimpl Binary for PositionErrorKinds
impl Binary for PositionErrorKinds
sourceimpl BitAnd<PositionErrorKinds> for PositionErrorKinds
impl BitAnd<PositionErrorKinds> for PositionErrorKinds
type Output = PositionErrorKinds
type Output = PositionErrorKinds
The resulting type after applying the &
operator.
sourceimpl BitAndAssign<PositionErrorKinds> for PositionErrorKinds
impl BitAndAssign<PositionErrorKinds> for PositionErrorKinds
sourcefn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
sourceimpl BitOr<PositionErrorKinds> for PositionErrorKinds
impl BitOr<PositionErrorKinds> for PositionErrorKinds
sourcefn bitor(self, other: PositionErrorKinds) -> Self
fn bitor(self, other: PositionErrorKinds) -> Self
Returns the union of the two sets of flags.
type Output = PositionErrorKinds
type Output = PositionErrorKinds
The resulting type after applying the |
operator.
sourceimpl BitOrAssign<PositionErrorKinds> for PositionErrorKinds
impl BitOrAssign<PositionErrorKinds> for PositionErrorKinds
sourcefn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
sourceimpl BitXor<PositionErrorKinds> for PositionErrorKinds
impl BitXor<PositionErrorKinds> for PositionErrorKinds
sourcefn bitxor(self, other: Self) -> Self
fn bitxor(self, other: Self) -> Self
Returns the left flags, but with all the right flags toggled.
type Output = PositionErrorKinds
type Output = PositionErrorKinds
The resulting type after applying the ^
operator.
sourceimpl BitXorAssign<PositionErrorKinds> for PositionErrorKinds
impl BitXorAssign<PositionErrorKinds> for PositionErrorKinds
sourcefn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
sourceimpl Clone for PositionErrorKinds
impl Clone for PositionErrorKinds
sourcefn clone(&self) -> PositionErrorKinds
fn clone(&self) -> PositionErrorKinds
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
sourceimpl Debug for PositionErrorKinds
impl Debug for PositionErrorKinds
sourceimpl Extend<PositionErrorKinds> for PositionErrorKinds
impl Extend<PositionErrorKinds> for PositionErrorKinds
sourcefn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
Extends a collection with the contents of an iterator. Read more
sourcefn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)Extends a collection with exactly one element.
sourcefn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)Reserves capacity in a collection for the given number of additional elements. Read more
sourceimpl FromIterator<PositionErrorKinds> for PositionErrorKinds
impl FromIterator<PositionErrorKinds> for PositionErrorKinds
sourcefn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
Creates a value from an iterator. Read more
sourceimpl Hash for PositionErrorKinds
impl Hash for PositionErrorKinds
sourceimpl LowerHex for PositionErrorKinds
impl LowerHex for PositionErrorKinds
sourceimpl Not for PositionErrorKinds
impl Not for PositionErrorKinds
type Output = PositionErrorKinds
type Output = PositionErrorKinds
The resulting type after applying the !
operator.
sourceimpl Octal for PositionErrorKinds
impl Octal for PositionErrorKinds
sourceimpl Ord for PositionErrorKinds
impl Ord for PositionErrorKinds
sourceimpl PartialEq<PositionErrorKinds> for PositionErrorKinds
impl PartialEq<PositionErrorKinds> for PositionErrorKinds
sourcefn eq(&self, other: &PositionErrorKinds) -> bool
fn eq(&self, other: &PositionErrorKinds) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &PositionErrorKinds) -> bool
fn ne(&self, other: &PositionErrorKinds) -> bool
This method tests for !=
.
sourceimpl PartialOrd<PositionErrorKinds> for PositionErrorKinds
impl PartialOrd<PositionErrorKinds> for PositionErrorKinds
sourcefn partial_cmp(&self, other: &PositionErrorKinds) -> Option<Ordering>
fn partial_cmp(&self, other: &PositionErrorKinds) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
sourceimpl Sub<PositionErrorKinds> for PositionErrorKinds
impl Sub<PositionErrorKinds> for PositionErrorKinds
type Output = PositionErrorKinds
type Output = PositionErrorKinds
The resulting type after applying the -
operator.
sourceimpl SubAssign<PositionErrorKinds> for PositionErrorKinds
impl SubAssign<PositionErrorKinds> for PositionErrorKinds
sourcefn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.
sourceimpl UpperHex for PositionErrorKinds
impl UpperHex for PositionErrorKinds
impl Copy for PositionErrorKinds
impl Eq for PositionErrorKinds
impl StructuralEq for PositionErrorKinds
impl StructuralPartialEq for PositionErrorKinds
Auto Trait Implementations
impl RefUnwindSafe for PositionErrorKinds
impl Send for PositionErrorKinds
impl Sync for PositionErrorKinds
impl Unpin for PositionErrorKinds
impl UnwindSafe for PositionErrorKinds
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more