Enum GameResolution

#[repr(u8)]
pub enum GameResolution {
    BlackWins = 1,
    WhiteWins = 2,
    Draw = 3,
    Rematch = 4,
    Aborted = 5,
}

How a game is resolved.

GameResolution and Option<GameResolution> are both 1-byte data types. Because they are cheap to copy, they implement Copy.

Variants

BlackWins = 1

White’s king was mated or white resigned.

Discriminant = 1.

WhiteWins = 2

Black’s king was mated or black resigned.

Discriminant = 2.

Draw = 3

This can happen if e.g. 持将棋 (jishōgi) happens.

Discriminant = 3.

Rematch = 4

This can happen if e.g. 千日手 (sennichite, repetition) happens.

Discriminant = 4.

Aborted = 5

The game was aborted.

Discriminant = 5.

Implementations

impl GameResolution

#[export_name = "GameResolution_from_u8_unchecked"]

pub unsafe extern "C" fn from_u8_unchecked(repr: u8) -> Self

Converts a u8 to GameResolution without checking.

Safety

repr must be a valid representation of GameResolution. This condition is equivalent to 1 <= repr && repr <= 5.

Trait Implementations

impl Clone for GameResolution

fn clone(&self) -> GameResolution

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GameResolution

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

Formats the value using the given formatter.

impl Hash for GameResolution

Available on crate feature hash only.

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 GameResolution

Available on crate feature ord only.

fn cmp(&self, other: &Self) -> 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 for GameResolution

fn eq(&self, other: &GameResolution) -> 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 GameResolution

Available on crate feature ord only.

fn partial_cmp(&self, other: &Self) -> 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 Copy for GameResolution

impl Eq for GameResolution

impl StructuralPartialEq for GameResolution