Struct HandN

pub struct HandN<const N: usize>(/* private fields */);

A hand of N cards

Represents a fixed-size collection of N cards that are automatically sorted upon creation. Cards are maintained in sorted order for consistent comparison and hashing. This type is used for poker hands, flops, and other fixed-size card collections.

Examples

use open_pql::{Card, HandN, Rank::*, Suit::*};

let cards = [Card::new(RA, S), Card::new(RK, H), Card::new(RQ, D)];
let hand: HandN<3> = HandN::from_slice(&cards);

assert_eq!(hand.len(), 3);
assert!(!hand.is_empty());
assert_eq!(hand[0], Card::new(RQ, D)); // Cards are sorted

Implementations

impl<const N: usize> HandN<N>

pub fn from_slice(cs: &[Card]) -> Self

Creates a hand from a slice of cards

pub const fn as_slice(&self) -> &[Card]

Returns the underlying card array

pub fn to_vec(&self) -> Vec<Card>

pub fn iter(&self) -> impl Iterator<Item = Card> + '_

Returns an iterator over the cards in the hand

pub const fn len(&self) -> usize

Returns the number of cards in the hand

pub const fn is_empty(&self) -> bool

Returns true if the hand is empty

pub fn iter_all_short() -> HandIter<true, N>

pub fn iter_all() -> HandIter<false, N>

impl<const N: usize> HandN<N>

pub fn new_iso_with_mapping(cards: &[Card], mapping: &mut SuitMapping) -> Self

pub fn new_iso(cards: &[Card]) -> (Self, SuitMapping)

Trait Implementations

impl<const N: usize> Clone for HandN<N>

fn clone(&self) -> HandN<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<const N: usize> Debug for HandN<N>

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

Formats the value using the given formatter.

impl<const N: usize> Display for HandN<N>

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

Formats the value using the given formatter.

impl<const N: usize> From<[Card; N]> for HandN<N>

fn from(value: [Card; N]) -> Self

Converts to this type from the input type.

impl From<(Card, Card, Card)> for HandN<3>

fn from(cs: (Card, Card, Card)) -> Self

Converts to this type from the input type.

impl From<HandN<3>> for Board

fn from(flop: Flop) -> Self

Converts to this type from the input type.

impl<const N: usize> From<HandN<N>> for [Card; N]

fn from(value: HandN<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> From<HandN<N>> for Card64

fn from(hand: HandN<N>) -> Self

Converts to this type from the input type.

impl<const N: usize> Hash for HandN<N>

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<const N: usize> Index<usize> for HandN<N>

type Output = Card

The returned type after indexing.

fn index(&self, index: usize) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<'a, const N: usize> IntoIterator for &'a HandN<N>

type Item = Card

The type of the elements being iterated over.

type IntoIter = Copied<Iter<'a, Card>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<const N: usize> Ord for HandN<N>

fn cmp(&self, other: &HandN<N>) -> 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<const N: usize> PartialEq for HandN<N>

fn eq(&self, other: &HandN<N>) -> 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<const N: usize> PartialOrd for HandN<N>

fn partial_cmp(&self, other: &HandN<N>) -> 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<const N: usize> Copy for HandN<N>

impl<const N: usize> Eq for HandN<N>

impl<const N: usize> StructuralPartialEq for HandN<N>