Struct shakmaty::RemainingChecks

pub struct RemainingChecks(/* private fields */);

The number of checks the respective side needs to give in order to win (in a game of Three-Check).

Examples

use shakmaty::{ByColor, RemainingChecks};

let mut remaining_checks = ByColor::<RemainingChecks>::default();
assert_eq!(remaining_checks.white, RemainingChecks::new(3));
assert_eq!(remaining_checks.black, RemainingChecks::new(3));

for _ in 0..5 {
    remaining_checks.white = remaining_checks.white.saturating_sub(1);
}

assert!(remaining_checks.white.is_zero());

Implementations

impl RemainingChecks

pub const fn new(n: u32) -> RemainingChecks

Constructs a new RemainingChecks value.

Panics

Panics if n > 3.

pub const fn is_zero(self) -> bool

pub const fn saturating_sub(self, n: u32) -> RemainingChecks

Trait Implementations

impl Clone for RemainingChecks

fn clone(&self) -> RemainingChecks

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RemainingChecks

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

Formats the value using the given formatter.

impl Default for RemainingChecks

fn default() -> RemainingChecks

Returns the “default value” for a type.

impl From<RemainingChecks> for i128

fn from(RemainingChecks: RemainingChecks) -> i128

Converts to this type from the input type.

impl From<RemainingChecks> for i16

fn from(RemainingChecks: RemainingChecks) -> i16

Converts to this type from the input type.

impl From<RemainingChecks> for i32

fn from(RemainingChecks: RemainingChecks) -> i32

Converts to this type from the input type.

impl From<RemainingChecks> for i64

fn from(RemainingChecks: RemainingChecks) -> i64

Converts to this type from the input type.

impl From<RemainingChecks> for i8

fn from(RemainingChecks: RemainingChecks) -> i8

Converts to this type from the input type.

impl From<RemainingChecks> for isize

fn from(RemainingChecks: RemainingChecks) -> isize

Converts to this type from the input type.

impl From<RemainingChecks> for u128

fn from(RemainingChecks: RemainingChecks) -> u128

Converts to this type from the input type.

impl From<RemainingChecks> for u16

fn from(RemainingChecks: RemainingChecks) -> u16

Converts to this type from the input type.

impl From<RemainingChecks> for u32

fn from(RemainingChecks: RemainingChecks) -> u32

Converts to this type from the input type.

impl From<RemainingChecks> for u64

fn from(RemainingChecks: RemainingChecks) -> u64

Converts to this type from the input type.

impl From<RemainingChecks> for u8

fn from(RemainingChecks: RemainingChecks) -> u8

Converts to this type from the input type.

impl From<RemainingChecks> for usize

fn from(RemainingChecks: RemainingChecks) -> usize

Converts to this type from the input type.

impl Hash for RemainingChecks

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 Ord for RemainingChecks

fn cmp(&self, other: &RemainingChecks) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RemainingChecks

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

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

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

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

impl PartialOrd for RemainingChecks

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

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

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

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

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

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

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

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

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

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

impl TryFrom<i128> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i128) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<i16> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i16) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<i32> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<i64> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i64) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<i8> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: i8) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<isize> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: isize) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<u128> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u128) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<u16> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u16) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<u32> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u32) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<u64> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u64) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<u8> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: u8) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl TryFrom<usize> for RemainingChecks

type Error = TryFromIntError

The type returned in the event of a conversion error.

fn try_from(value: usize) -> Result<RemainingChecks, Self::Error>

Performs the conversion.

impl Copy for RemainingChecks

impl Eq for RemainingChecks

impl StructuralPartialEq for RemainingChecks