Struct Hand

pub struct Hand(pub [Holding; 4]);

A hand of playing cards

Tuple Fields

0: [Holding; 4]

Implementations

impl Hand

pub const fn to_bits(self) -> u64

As a bitset of cards

pub const fn from_bits_retain(bits: u64) -> Self

Create a hand from a bitset of cards, retaining invalid cards

pub const fn contains_unknown_bits(self) -> bool

Whether the hand contains an invalid card

pub const fn from_bits(bits: u64) -> Option<Self>

Create a hand from a bitset of cards, checking for invalid cards

pub const fn from_bits_truncate(bits: u64) -> Self

Create a hand from a bitset of cards, removing invalid cards

Trait Implementations

impl BitAnd for Hand

type Output = Hand

The resulting type after applying the & operator.

fn bitand(self, rhs: Self) -> Self

Performs the & operation.

impl BitOr for Hand

type Output = Hand

The resulting type after applying the | operator.

fn bitor(self, rhs: Self) -> Self

Performs the | operation.

impl BitXor for Hand

type Output = Hand

The resulting type after applying the ^ operator.

fn bitxor(self, rhs: Self) -> Self

Performs the ^ operation.

impl Clone for Hand

fn clone(&self) -> Hand

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Hand

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

Formats the value using the given formatter.

impl Default for Hand

fn default() -> Hand

Returns the “default value” for a type.

impl Display for Hand

PBN-compatible display of a hand

This implementation ignores formatting flags for simplicity and speed.

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

Formats the value using the given formatter.

impl FromStr for Hand

type Err = ParseHandError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for Hand

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 Index<Suit> for Hand

type Output = Holding

The returned type after indexing.

fn index(&self, suit: Suit) -> &Holding

Performs the indexing (container[index]) operation.

impl IndexMut<Suit> for Hand

fn index_mut(&mut self, suit: Suit) -> &mut Holding

Performs the mutable indexing (container[index]) operation.

impl Not for Hand

type Output = Hand

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl PartialEq for Hand

fn eq(&self, other: &Hand) -> 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 SmallSet<Card> for Hand

const EMPTY: Self

The empty set

const ALL: Self

The set containing all possible values

fn len(self) -> usize

The number of elements in the set

fn contains(self, card: Card) -> bool

Whether the set contains a value

fn insert(&mut self, card: Card) -> bool

Insert a value into the set

fn remove(&mut self, card: Card) -> bool

Remove a value from the set

fn toggle(&mut self, card: Card) -> bool

Toggle a value in the set

fn iter(self) -> impl Iterator<Item = Card>

Iterate over the values in the set

fn is_empty(self) -> bool

Whether the set is empty

impl Sub for Hand

type Output = Hand

The resulting type after applying the - operator.

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

Performs the - operation.

impl Copy for Hand

impl Eq for Hand

impl StructuralPartialEq for Hand