Struct Holding 

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

A set of cards of the same suit

Implementations

impl Holding

pub const EMPTY: Self

The empty set

pub const ALL: Self

The set containing all possible ranks (2..=14)

pub const fn len(self) -> usize

The number of cards in the holding

pub const fn is_empty(self) -> bool

Whether the holding is empty

pub const fn contains(self, rank: Rank) -> bool

Whether the holding contains a rank

pub const fn insert(&mut self, rank: Rank) -> bool

Insert a rank into the holding, returning whether it was newly inserted

pub const fn remove(&mut self, rank: Rank) -> bool

Remove a rank from the holding, returning whether it was present

pub const fn toggle(&mut self, rank: Rank) -> bool

Toggle a rank in the holding, returning whether it is now present

pub const fn set(&mut self, rank: Rank, condition: bool)

Conditionally insert/remove a rank from the holding

pub const fn iter(self) -> HoldingIter

Iterate over the ranks in the holding

pub const fn to_bits(self) -> u16

As a bitset of ranks

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

Create a holding from a bitset of ranks, retaining invalid ranks

pub const fn contains_unknown_bits(self) -> bool

Whether the holding contains an invalid rank

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

Create a holding from a bitset of ranks, checking for invalid ranks

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

Create a holding from a bitset of ranks, removing invalid ranks

pub const fn from_rank(rank: Rank) -> Self

Create a holding from a rank

Trait Implementations

impl BitAnd for Holding

type Output = Holding

The resulting type after applying the & operator.

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

Performs the & operation.

impl BitAndAssign for Holding

fn bitand_assign(&mut self, rhs: Self)

Performs the &= operation.

impl BitOr for Holding

type Output = Holding

The resulting type after applying the | operator.

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

Performs the | operation.

impl BitOrAssign for Holding

fn bitor_assign(&mut self, rhs: Self)

Performs the |= operation.

impl BitXor for Holding

type Output = Holding

The resulting type after applying the ^ operator.

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

Performs the ^ operation.

impl BitXorAssign for Holding

fn bitxor_assign(&mut self, rhs: Self)

Performs the ^= operation.

impl Clone for Holding

fn clone(&self) -> Holding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Holding

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

Formats the value using the given formatter.

impl Default for Holding

fn default() -> Holding

Returns the “default value” for a type.

impl Display for Holding

Show cards in descending order

1. The ten is shown as T for PBN compatibility.
2. This implementation ignores formatting flags for simplicity and speed. If you want to pad or align the output, use fmt::Formatter::pad.

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

Formats the value using the given formatter.

impl FromStr for Holding

type Err = ParseHoldingError

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 Holding

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

type Item = Rank

The type of the elements being iterated over.

type IntoIter = HoldingIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> HoldingIter

Creates an iterator from a value.

impl Not for Holding

type Output = Holding

The resulting type after applying the ! operator.

fn not(self) -> Self

Performs the unary ! operation.

impl PartialEq for Holding

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

type Output = Holding

The resulting type after applying the - operator.

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

Performs the - operation.

impl SubAssign for Holding

fn sub_assign(&mut self, rhs: Self)

Performs the -= operation.

impl Copy for Holding

impl Eq for Holding

impl StructuralPartialEq for Holding