Struct Hand 

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

A set of playing cards

Despite the name, this type is a general card set: it also represents melds, deadwood, and the union of several hands throughout this crate.

Implementations

impl Hand

pub const EMPTY: Self

The empty hand

pub const ALL: Self

The hand containing all 52 cards

pub const fn to_bits(self) -> u64

As a bitset of cards

The card of suit s and rank r is bit 16 × s + r, i.e. each suit owns a 16-bit lane in ascending suit order and a lane is the Holding::to_bits of that suit. This layout is a stable API contract of this crate.

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

pub const fn new( clubs: Holding, diamonds: Holding, hearts: Holding, spades: Holding, ) -> Self

Create a hand from four holdings in suit order (clubs, diamonds, hearts, spades)

pub const fn from_card(card: Card) -> Self

Create a hand containing a single card

pub const fn len(self) -> usize

The number of cards in the hand

pub const fn is_empty(self) -> bool

Whether the hand is empty

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

Whether the hand contains a card

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

Insert a card into the hand, returning whether it was newly inserted

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

Remove a card from the hand, returning whether it was present

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

Toggle a card in the hand, returning whether it is now present

pub fn set(&mut self, card: Card, condition: bool)

Conditionally insert/remove a card from the hand

pub const fn iter(self) -> HandIter

Iterate over the cards in the hand

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 BitAndAssign for Hand

fn bitand_assign(&mut self, rhs: 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 BitOrAssign for Hand

fn bitor_assign(&mut self, rhs: 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 BitXorAssign for Hand

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Hand

fn clone(&self) -> Hand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Hand

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<'de> Deserialize<'de> for Hand

where Self: FromStr, <Self as FromStr>::Err: Display,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Hand

Dotted display of a hand: four suit groups in ascending order, clubs first, e.g. A23.456.789.T

An empty hand is shown as -. Note that this deliberately differs from the descending, spades-first PBN format of bridge software.

This implementation ignores formatting flags for simplicity and speed.

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

Formats the value using the given formatter.

impl Eq for Hand

impl From<Card> for Hand

fn from(card: Card) -> Self

Converts to this type from the input type.

impl From<Deck> for Hand

fn from(deck: Deck) -> Self

Converts to this type from the input type.

impl From<Hand> for Deck

fn from(hand: Hand) -> Self

Converts to this type from the input type.

impl From<Meld> for Hand

fn from(meld: Meld) -> Self

Converts to this type from the input type.

impl FromIterator<Card> for Hand

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

Creates a value from an iterator.

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 IntoIterator for Hand

type Item = Card

The type of the elements being iterated over.

type IntoIter = HandIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> HandIter

Creates an iterator from a value.

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Hand

where Self: Display,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Hand

impl Sub for Hand

type Output = Hand

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Hand

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl TryFrom<Hand> for Meld

type Error = InvalidMeld

The type returned in the event of a conversion error.

fn try_from(cards: Hand) -> Result<Self, InvalidMeld>

Performs the conversion.