Struct Player 

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

Player index – 0, 1, 2, 3 => player assigned east, south, west, north in the initial round.

This is forced to mod-4 arithmetic, and can represent both the absolute player index or the difference between player indices (“relative player”).

Reason for reinventing the wheel instead of using ux, bare_metal_modulo etc.: This is trivial, and these don’t support serde.

Optional serde support

Serializes as the player index number (0/1/2/3). Deserialization will check the range.

Implementations

impl Player

pub const fn new(x: u8) -> Self

pub const fn add(self, other: Player) -> Player

pub const fn add_u8(self, other: u8) -> Player

pub const fn sub(self, other: Player) -> Player

pub const fn sub_u8(self, other: u8) -> Player

pub const fn to_u8(self) -> u8

pub const fn to_usize(self) -> usize

pub const fn succ(self) -> Self

Returns the player 1 turn after me, a.k.a. Successor, Shimocha (下家). In a physical game, said player would sit to the right of me (CCW).

pub const fn oppo(self) -> Self

Returns the player 2 turns after me, a.k.a. Opposing, Toimen (対面). In a physical game, said player would sit across the table from me.

pub const fn pred(self) -> Self

Returns the player 1 turn before me, a.k.a. Predecessor, Kamicha (上家). In a physical game, said player would sit to the left of me (CW).

Trait Implementations

impl Add<u8> for Player

type Output = Player

The resulting type after applying the + operator.

fn add(self, rhs: u8) -> Self::Output

Performs the + operation.

impl Add for Player

type Output = Player

The resulting type after applying the + operator.

fn add(self, rhs: Self) -> Self::Output

Performs the + operation.

impl Clone for Player

fn clone(&self) -> Player

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Player

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

Formats the value using the given formatter.

impl Default for Player

fn default() -> Player

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Player

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Player

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

Formats the value using the given formatter.

impl From<Player> for u8

fn from(original: Player) -> Self

Converts to this type from the input type.

impl From<u8> for Player

fn from(original: u8) -> Player

Converts to this type from the input type.

impl From<usize> for Player

fn from(x: usize) -> Self

Converts to this type from the input type.

impl Hash for Player

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 Into<usize> for Player

fn into(self) -> usize

Converts this type into the (usually inferred) input type.

impl PartialEq for Player

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

fn serialize<S>(&self, s: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Sub<u8> for Player

type Output = Player

The resulting type after applying the - operator.

fn sub(self, rhs: u8) -> Self::Output

Performs the - operation.

impl Sub for Player

type Output = Player

The resulting type after applying the - operator.

fn sub(self, rhs: Self) -> Self::Output

Performs the - operation.

impl Copy for Player

impl Eq for Player

impl StructuralPartialEq for Player