Struct shakmaty::PositionErrorKinds
source · pub struct PositionErrorKinds { /* private fields */ }
Implementations§
source§impl PositionErrorKinds
impl PositionErrorKinds
sourcepub const EMPTY_BOARD: Self = _
pub const EMPTY_BOARD: Self = _
There are no pieces on the board.
sourcepub const MISSING_KING: Self = _
pub const MISSING_KING: Self = _
A king is required but missing.
sourcepub const TOO_MANY_KINGS: Self = _
pub const TOO_MANY_KINGS: Self = _
A player has too many kings.
sourcepub const PAWNS_ON_BACKRANK: Self = _
pub const PAWNS_ON_BACKRANK: Self = _
There are pawns on the backrank. Only [Horde
] allows players to
have pawns on their own backrank.
sourcepub const INVALID_CASTLING_RIGHTS: Self = _
pub const INVALID_CASTLING_RIGHTS: Self = _
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 = _
pub const INVALID_EP_SQUARE: Self = _
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 = _
pub const OPPOSITE_CHECK: Self = _
The player not to move is in check.
sourcepub const IMPOSSIBLE_CHECK: Self = _
pub const IMPOSSIBLE_CHECK: Self = _
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 = _
pub const IMPOSSIBLE_MATERIAL: Self = _
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§
source§impl Binary for PositionErrorKinds
impl Binary for PositionErrorKinds
source§impl BitAndAssign<PositionErrorKinds> for PositionErrorKinds
impl BitAndAssign<PositionErrorKinds> for PositionErrorKinds
source§fn bitand_assign(&mut self, other: Self)
fn bitand_assign(&mut self, other: Self)
Disables all flags disabled in the set.
source§impl BitOr<PositionErrorKinds> for PositionErrorKinds
impl BitOr<PositionErrorKinds> for PositionErrorKinds
source§fn 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
|
operator.source§impl BitOrAssign<PositionErrorKinds> for PositionErrorKinds
impl BitOrAssign<PositionErrorKinds> for PositionErrorKinds
source§fn bitor_assign(&mut self, other: Self)
fn bitor_assign(&mut self, other: Self)
Adds the set of flags.
source§impl BitXorAssign<PositionErrorKinds> for PositionErrorKinds
impl BitXorAssign<PositionErrorKinds> for PositionErrorKinds
source§fn bitxor_assign(&mut self, other: Self)
fn bitxor_assign(&mut self, other: Self)
Toggles the set of flags.
source§impl Clone for PositionErrorKinds
impl Clone for PositionErrorKinds
source§fn clone(&self) -> PositionErrorKinds
fn clone(&self) -> PositionErrorKinds
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for PositionErrorKinds
impl Debug for PositionErrorKinds
source§impl Extend<PositionErrorKinds> for PositionErrorKinds
impl Extend<PositionErrorKinds> for PositionErrorKinds
source§fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)
source§fn extend_one(&mut self, item: A)
fn extend_one(&mut self, item: A)
extend_one
)source§fn extend_reserve(&mut self, additional: usize)
fn extend_reserve(&mut self, additional: usize)
extend_one
)source§impl FromIterator<PositionErrorKinds> for PositionErrorKinds
impl FromIterator<PositionErrorKinds> for PositionErrorKinds
source§fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self
source§impl Hash for PositionErrorKinds
impl Hash for PositionErrorKinds
source§impl LowerHex for PositionErrorKinds
impl LowerHex for PositionErrorKinds
source§impl Not for PositionErrorKinds
impl Not for PositionErrorKinds
source§impl Octal for PositionErrorKinds
impl Octal for PositionErrorKinds
source§impl Ord for PositionErrorKinds
impl Ord for PositionErrorKinds
source§fn cmp(&self, other: &PositionErrorKinds) -> Ordering
fn cmp(&self, other: &PositionErrorKinds) -> Ordering
1.21.0 · source§fn max(self, other: Self) -> Selfwhere
Self: Sized,
fn max(self, other: Self) -> Selfwhere
Self: Sized,
source§impl PartialEq<PositionErrorKinds> for PositionErrorKinds
impl PartialEq<PositionErrorKinds> for PositionErrorKinds
source§fn eq(&self, other: &PositionErrorKinds) -> bool
fn eq(&self, other: &PositionErrorKinds) -> bool
source§impl PartialOrd<PositionErrorKinds> for PositionErrorKinds
impl PartialOrd<PositionErrorKinds> for PositionErrorKinds
source§fn partial_cmp(&self, other: &PositionErrorKinds) -> Option<Ordering>
fn partial_cmp(&self, other: &PositionErrorKinds) -> Option<Ordering>
1.0.0 · source§fn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
self
and other
) and is used by the <=
operator. Read moresource§impl Sub<PositionErrorKinds> for PositionErrorKinds
impl Sub<PositionErrorKinds> for PositionErrorKinds
source§impl SubAssign<PositionErrorKinds> for PositionErrorKinds
impl SubAssign<PositionErrorKinds> for PositionErrorKinds
source§fn sub_assign(&mut self, other: Self)
fn sub_assign(&mut self, other: Self)
Disables all flags enabled in the set.