Struct Board

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

Represents a poker board (flop, turn, river)

A poker board consists of community cards dealt during a game:

• Flop: The first three community cards (optional)
• Turn: The fourth community card (optional, requires flop)
• River: The fifth community card (optional, requires turn)

Examples

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

let cards = [Card::new(RA, S), Card::new(RK, H), Card::new(RQ, D)];
let board = Board::from_slice(&cards);

assert_eq!(board.len(), 3);
assert!(!board.is_empty());

Fields

flop: Option<Flop>

turn: Option<Card>

river: Option<Card>

Implementations

impl Board

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

Creates a board from a slice of cards

pub const fn is_empty(&self) -> bool

Checks if the board is empty (has no cards)

pub fn len(&self) -> usize

Returns the number of cards on the board

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

Returns an iterator over all cards on the board

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

Returns all cards on the board as a vector

pub fn clear(&mut self)

Clears the board

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

impl Board

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

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

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, 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 From<&[Card]> for Board

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

Converts to this type from the input type.

impl From<(Card, Card, Card, Card, Card)> for Board

fn from(cs: (Card, Card, Card, Card, 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