Struct PlayerId 

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

Identifies one seat in a match.

A seat is not necessarily a human: scripted opponents, a blackjack dealer, and the reserved chance “player” (PlayerId::CHANCE) are all seats. Real players are numbered from 0; games map their own seat concepts onto these indices.

Implementations

impl PlayerId

pub const CHANCE: Self

The reserved chance pseudo-player.

Committed random outcomes (a card revealed, a hand dealt) are modeled as actions taken by this seat, so they become real, undoable state rather than an RNG side effect. See the chance-node design in ARCHITECTURE.md. Real players must not use this index.

pub const fn new(index: u32) -> Self

Creates a seat with the given index.

Indices should be small and dense (0, 1, 2, …); u32::MAX is reserved for PlayerId::CHANCE.

pub const fn index(self) -> u32

Returns the zero-based seat index.

pub const fn is_chance(self) -> bool

Returns true if this is the reserved chance pseudo-player.

Trait Implementations

impl Clone for PlayerId

fn clone(&self) -> PlayerId

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlayerId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlayerId

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PlayerId

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

Formats the value using the given formatter.

impl FromIterator<PlayerId> for ActivePlayers

fn from_iter<I: IntoIterator<Item = PlayerId>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for PlayerId

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 PlayerId

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

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for PlayerId

impl Eq for PlayerId

impl StructuralPartialEq for PlayerId