Struct Board 

pub struct Board {
    pub flop: Option<Flop>,
    pub turn: Option<Card>,
    pub river: Option<Card>,
}

Board representation for poker games.

Represents community cards (flop, turn, river) with a macro for convenient creation.

Fields

flop: Option<Flop>

turn: Option<Card>

river: Option<Card>

Implementations

impl Board

pub const IDX_TURN: usize = 3usize

Index of the turn card in a board array

pub const IDX_RIVER: usize = 4usize

Index of the river card in a board array

pub const N_PREFLOP: usize = 0usize

Number of board cards preflop

pub const N_FLOP: usize = 3usize

Number of board cards in a flop

pub const N_TURN: usize = 4usize

Number of board cards in a flop + turn

pub const N_RIVER: usize = 5usize

Number of board cards in a flop + turn + river

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

Creates a board from a slice of cards.

Expects cards in order: flop (3 cards), turn, river. Cards beyond the first 5 are ignored.

pub const fn is_empty(&self) -> bool

Returns true if the board has no cards (no flop).

pub fn len(&self) -> usize

Returns the number of cards on the board (0, 3, 4, or 5).

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

Returns an iterator over all cards on the board.

pub const fn contains_card(&self, card: Card) -> bool

Returns true if the board contains the specified card.

impl Board

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

Creates a suit-isomorphic board using the provided suit mapping.

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

Creates a suit-isomorphic board and returns the suit mapping used.

Trait Implementations

impl Clone for Board

fn clone(&self) -> Board

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Board

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

Formats the value using the given formatter.

impl Default for Board

fn default() -> Board

Returns the “default value” for a type.

impl Display for Board

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

Formats the value using the given formatter.

impl From<&[Card]> for Board

fn from(xs: &[Card]) -> Self

Converts to this type from the input type.

impl From<Board> for Card64

fn from(board: Board) -> 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 Hash for Board

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 PartialEq for Board

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

impl Eq for Board

impl StructuralPartialEq for Board